Bitget TypeScript SDK example: ws-public.ts

Bitget V2 Classic WebSocket websocket public example for the Siebly Bitget SDK, with TypeScript source for exchange REST API and WebSocket integration, setup, and production SDK docs.

What This Example Covers

  • Bitget WebSocket stream example in TypeScript.
  • Uses the Siebly Bitget SDK package bitget-api instead of hand-written WebSocket plumbing.
  • Source path: Bitget/V2 - Classic/Websocket/ws-public.ts.
  • Example category: V2 Classic WebSocket.
  • Imports SDK symbols including DefaultLogger, WebsocketClientV2, WS_KEY_MAP.
  • Calls SDK methods such as on(), subscribeTopic(), getWsStore().

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.

Example Path

Bitget/V2 - Classic/Websocket/ws-public.ts

Source Link

Repository source: https://github.com/sieblyio/crypto-api-examples/blob/master/examples/Bitget/V2 - Classic/Websocket/ws-public.ts

Related SDK Docs

Example Source

import { DefaultLogger, WebsocketClientV2, WS_KEY_MAP } from 'bitget-api';

(async () => {
  const logger = {
    ...DefaultLogger,
    trace: (...params: any[]) => console.log('trace', ...params),
  };

  const wsClient = new WebsocketClientV2(
    {
      // restOptions: {
      // optionally provide rest options, e.g. to pass through a proxy
      // },
    },
    logger,
  );

  wsClient.on('update', (data) => {
    console.log('WS raw message received ', data);
    // console.log('WS raw message received ', JSON.stringify(data, null, 2));
  });

  wsClient.on('open', (data) => {
    console.log('WS connection opened:', data.wsKey);
  });
  wsClient.on('response', (data) => {
    console.log('WS response: ', JSON.stringify(data, null, 2));
  });
  wsClient.on('reconnect', ({ wsKey }) => {
    console.log('WS automatically reconnecting.... ', wsKey);
  });
  wsClient.on('reconnected', (data) => {
    console.log('WS reconnected ', data?.wsKey);
  });
  wsClient.on('exception', (data) => {
    console.log('WS error', data);
  });

  /**
   * Public events
   */

  const symbol = 'BTCUSDT';

  // Spot public

  // tickers
  wsClient.subscribeTopic('SPOT', 'ticker', symbol);

  // candles
  // wsClient.subscribeTopic('SPOT', 'candle1m', symbol);

  // orderbook updates
  // wsClient.subscribeTopic('SPOT', 'books', symbol);

  // trades
  // wsClient.subscribeTopic('SPOT', 'trade', symbol);

  // Futures public

  // tickers
  // wsClient.subscribeTopic('USDT-FUTURES', 'ticker', symbol);

  // candles
  // wsClient.subscribeTopic('USDT-FUTURES', 'candle1m', symbol);

  // orderbook updates
  // wsClient.subscribeTopic('USDT-FUTURES', 'books', symbol);

  // trades
  // wsClient.subscribeTopic('USDT-FUTURES', 'trade', symbol);

  // Topics are tracked per websocket type
  // Get a list of subscribed topics (e.g. all  public topics) (after a 5 second delay)
  setTimeout(() => {
    const publicTopics = wsClient.getWsStore().getTopics(WS_KEY_MAP.v2Public);

    console.log('public  topics: ', publicTopics);
  }, 5 * 1000);
})();