Skip to content

WebSocket subscriptions ​

WebsocketClient manages connections, signing and resubscriptions. Choose the correct WS_KEY_MAP feed; channel names and payloads differ across Coinbase products.

Stream Advanced Trade prices ​

Save this as stream.ts and run node stream.ts with Node.js 24:

ts
import { WebsocketClient, WS_KEY_MAP } from 'coinbase-api';

const ws = new WebsocketClient();

ws.on('update', (event) => {
  console.log(event);
});
ws.on('response', (event) => {
  console.log('Subscription response:', event);
});
ws.on('exception', (error) => {
  console.error('WebSocket exception:', error);
});
ws.on('reconnect', (event) => {
  console.log('Reconnecting:', event);
});
ws.on('reconnected', (event) => {
  console.log('Reconnected:', event);
});

ws.subscribe(
  [
    { topic: 'ticker', payload: { product_ids: ['BTC-USD'] } },
    { topic: 'heartbeats' },
  ],
  WS_KEY_MAP.advTradeMarketData,
);

function stop() {
  ws.closeAll();
}
process.once('SIGINT', stop);
process.once('SIGTERM', stop);

The example runs until you press Ctrl+C. heartbeats helps keep subscriptions active during quiet periods. The SDK's connection-health handling is separate from your application's price freshness checks.

The topic object uses payload, not params. For Advanced Trade, payload.product_ids supplies product IDs to the channel. Subscribe to level2 instead of ticker when maintaining an order book; its data arrives on the l2_data channel. Implement the exchange's snapshot, update and sequence semantics rather than treating each update as a complete book.

Events ​

EventMeaning
openInitial socket open.
updateParsed channel data, with the connection's wsKey.
responseReply to a subscription or another command.
exceptionSDK, exchange or listener exception.
reconnectConnection recovery has started.
reconnectedSocket reopened after a disconnect.
authenticatedSession authentication confirmed where that protocol has a separate authentication step.

subscribe() is not an awaitable server acknowledgement. Inspect response and exception, and confirm the channels you require before relying on them. Advanced Trade signs subscription requests rather than establishing the Global-style authenticated session.

Unsubscribe and shutdown ​

Pass the same topic/payload and feed key to unsubscribe(). It removes that subscription from the recovery cache. Call closeAll() for intentional shutdown; do not add a competing reconnect loop.

Reconnect restores transport and cached subscriptions, not missed data. See production recovery and private streams.

WebsocketClient reference · Coinbase WebSocket documentation

Built by Siebly. Open source SDKs for exchange APIs.