Coinbase Institutional CBExchange JavaScript SDK example: privateWs.ts
Coinbase Institutional CBExchange private websocket JavaScript example for the Siebly Coinbase SDK, covering exchange REST API and WebSocket integration, setup, and production SDK docs.
We use environment variables in our examples for API keys. It is your responsibility to manage and secure your keys appropriately.
examples/Coinbase/Institutional/CBExchange/WebSockets/privateWs.ts
What this example covers
- Coinbase WebSocket stream JavaScript example.
- Uses the Siebly Coinbase SDK package
coinbase-apiinstead of hand-written WebSocket plumbing. - Source path:
Coinbase/Institutional/CBExchange/WebSockets/privateWs.ts. - Example category: Institutional CBExchange.
- Imports SDK symbols including
WebsocketClient. - Calls SDK methods such as
on(),subscribe().
How to use this example
- Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
- For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
- Open the repository source when you need the latest committed version: GitHub source file.
import { WebsocketClient } from 'coinbase-api'; async function start() { const client = new WebsocketClient( { apiKey: 'yourAPIKeyHere', apiSecret: 'yourAPISecretHere', //This is the passphrase you provided when creating this API key. NOT your account password. apiPassphrase: 'yourAPIPassPhraseHere', // Optional, connect to sandbox instead: https://public-sandbox.exchange.coinbase.com/apikeys // useSandbox: true, }, // logger, ); client.on('open', (data) => { console.log('open: ', data?.wsKey); }); // Data received client.on('update', (data) => { console.info(new Date(), 'data received: ', JSON.stringify(data)); }); // Something happened, attempting to reconnect client.on('reconnect', (data) => { console.log('reconnect: ', data); }); // Reconnect successful client.on('reconnected', (data) => { console.log('reconnected: ', data); }); // Connection closed. If unexpected, expect reconnect -> reconnected. client.on('close', (data) => { console.error('close: ', data); }); // Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate" client.on('response', (data) => { console.info('response: ', JSON.stringify(data, null, 2)); }); client.on('exception', (data) => { console.error('exception: ', data); }); try { /** * Use the client subscribe(topic, market) pattern to subscribe to any websocket topic. * - You can subscribe to topics one at a time or many in one request. * - Topics can be sent as simple strings, if no parameters are required. * - If parameters are required, pass them in the "payload" property - they will be merged into the subscription request automatically * - Any subscribe requests on the "exchangeDirectMarketData" market are automatically authenticated with the available credentials */ client.subscribe( { topic: 'full', payload: { product_ids: ['BTC-USD'], }, }, 'exchangeDirectMarketData', ); client.subscribe( { topic: 'balance', payload: { account_ids: [ 'd50ec984-77a8-460a-b958-66f114b0de9b', 'd50ec984-77a8-460a-b958-66f114b0de9a', ], }, }, 'exchangeDirectMarketData', ); /** * Other examples for some of the authenticated Coinbase Exchange "direct market data" channels: */ client.subscribe( [ // https://docs.cdp.coinbase.com/exchange/docs/websocket-channels#full-channel { topic: 'full', payload: { product_ids: ['BTC-USD'], }, }, // https://docs.cdp.coinbase.com/exchange/docs/websocket-channels#user-channel { topic: 'user', payload: { product_ids: ['BTC-USD'], }, }, // https://docs.cdp.coinbase.com/exchange/docs/websocket-channels#level2-channel { topic: 'level2', payload: { product_ids: ['BTC-USD'], }, }, // https://docs.cdp.coinbase.com/exchange/docs/websocket-channels#balance-channel { topic: 'balance', payload: { account_ids: [ 'd50ec984-77a8-460a-b958-66f114b0de9b', 'd50ec984-77a8-460a-b958-66f114b0de9a', ], }, }, ], 'exchangeDirectMarketData', ); } catch (e) { console.error('Subscribe exception: ', e); }} start();