Skip to content

Variable: WS_KEY_MAP ​

ts
const WS_KEY_MAP: object;

Connection keys used by the WebSocket client. The exchangeMarketData connection sends unauthenticated subscriptions; use a signed subscription for channels that require authentication.

Type Declaration ​

advTradeGlobalMarketData ​

ts
readonly advTradeGlobalMarketData: "advTradeGlobalMarketData" = 'advTradeGlobalMarketData';

Unauthenticated Coinbase Global Derivatives market data on the public streams host. Channel parameters are part of the topic name. See Global Derivatives > Public:

https://docs.cdp.coinbase.com/coinbase-app/advanced-trade-apis/websocket/websocket-endpoints

advTradeGlobalUserData ​

ts
readonly advTradeGlobalUserData: "advTradeGlobalUserData" = 'advTradeGlobalUserData';

Coinbase Global Derivatives private subscriptions on the main DRB gateway. Uses public/auth followed by private/subscribe. See Global Derivatives > Private:

https://docs.cdp.coinbase.com/coinbase-app/advanced-trade-apis/websocket/websocket-endpoints

advTradeGlobalWSAPI ​

ts
readonly advTradeGlobalWSAPI: "advTradeGlobalWSAPI" = 'advTradeGlobalWSAPI';

Dedicated Global JSON-RPC API connection to the same main DRB gateway as private subscriptions. Uses a separate connection. See Global Derivatives > Private:

https://docs.cdp.coinbase.com/coinbase-app/advanced-trade-apis/websocket/websocket-endpoints

advTradeMarketData ​

ts
readonly advTradeMarketData: "advTradeMarketData" = 'advTradeMarketData';

Market Data is the traditional feed that provides updates for both orders and trades. Most channels are now available without authentication.

https://docs.cdp.coinbase.com/advanced-trade/docs/ws-overview

advTradeUserData ​

ts
readonly advTradeUserData: "advTradeUserData" = 'advTradeUserData';

Coinbase Advanced Trade User Order Data provides updates for the orders of the user.

https://docs.cdp.coinbase.com/advanced-trade/docs/ws-overview

exchangeDirectMarketData ​

ts
readonly exchangeDirectMarketData: "exchangeDirectMarketData" = 'exchangeDirectMarketData';

Coinbase Exchange direct market-data connection, which requires authentication. See Exchange WebSocket overview.

exchangeMarketData ​

ts
readonly exchangeMarketData: "exchangeMarketData" = 'exchangeMarketData';

Coinbase Exchange market-data connection. The SDK sends unsigned subscriptions on this connection. See Exchange WebSocket overview.

internationalMarketData ​

ts
readonly internationalMarketData: "internationalMarketData" = 'internationalMarketData';

Connection key for the SDK’s legacy International Exchange feed at wss://ws-md.international.coinbase.com. The historical market feed required signed subscriptions; public market data did not mean anonymous access. Current feed availability is not established after the INTX migration. See the legacy INTX guide.

primeMarketData ​

ts
readonly primeMarketData: "primeMarketData" = 'primeMarketData';

Coinbase Prime feed for real-time order and trade market data. Subscriptions must be signed; the SDK constructs the signature from the configured credentials. See Prime WebSocket overview.

Built by Siebly. Open source SDKs for exchange APIs.