Bybit TypeScript SDK example: ws-public-v5.ts

What This Example Covers

• Bybit WebSocket stream example in TypeScript.
• Uses the Siebly Bybit SDK package bybit-api instead of hand-written WebSocket plumbing.
• Source path: Bybit/Websocket/Public/ws-public-v5.ts.
• Example category: WebSocket Public.
• Imports SDK symbols including DefaultLogger, WebsocketClient, WS_KEY_MAP.
• Calls SDK methods such as on(), subscribeV5(), subscribe(), unsubscribeV5().

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

Bybit/Websocket/Public/ws-public-v5.ts

Source Link

Repository source: https://github.com/sieblyio/crypto-api-examples/blob/master/examples/Bybit/Websocket/Public/ws-public-v5.ts

Related SDK Docs

• All examples index
• Bybit SDK overview
• Closest matching SDK guide: Bybit TypeScript SDK
• Bybit JavaScript SDK
• Bybit Node.js SDK

Example Source

import { DefaultLogger, WebsocketClient, WS_KEY_MAP } from 'bybit-api';

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

/**
 * Prepare an instance of the WebSocket client. This client handles all aspects of connectivity for you:
 * - Connections are opened when you subscribe to topics
 * - If key & secret are provided, authentication is handled automatically
 * - If you subscribe to topics from different v5 products (e.g. spot and linear perps),
 *    subscription events are automatically routed to the different ws endpoints on bybit's side
 * - Heartbeats/ping/pong/reconnects are all handled automatically.
 *    If a connection drops, the client will clean it up, respawn a fresh connection and resubscribe for you.
 */

const wsClient = new WebsocketClient({}, logger);

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

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

wsClient.on('exception', (data) => {
  console.error('ws exception: ', data);
});

/**
 * For public V5 topics, use the subscribeV5 method and include the API category this topic is for.
 * Category is required, since each category has a different websocket endpoint.
 */

// Linear v5
// -> Just one topic per call
// wsClient.subscribeV5('orderbook.50.BTCUSDT', 'linear');

// -> Or multiple topics in one call
// wsClient.subscribeV5(
//   ['orderbook.50.BTCUSDT', 'orderbook.50.ETHUSDT'],
//   'linear'
// );

// Inverse v5
// wsClient.subscribeV5('orderbook.50.BTCUSD', 'inverse');

// Spot v5
// wsClient.subscribeV5('orderbook.50.BTCUSDT', 'spot');

// Option v5
// wsClient.subscribeV5('publicTrade.BTC', 'option');

const topics = ['kline.5.XRPUSDT', 'kline.5.BTCUSDT', 'kline.5.ETHUSDT'];

// Use the subscribeV5() call for most subscribe calls with v5 websockets
wsClient.subscribeV5(topics, 'spot');

// Alternatively, you can also use objects in the wsClient.subscribe() call
// wsClient.subscribe({
//   topic: 'orderook.50.BTCUSDT',
//   category: 'spot',
// });

/**
 * For private V5 topics, just call the same subscribeV5() method on the ws client or use the original subscribe() method.
 *
 * Note: for private endpoints the "category" field is ignored since there is only one private endpoint
 * (compared to one public one per category)
 */

// wsClient.subscribeV5('position', 'linear');
// wsClient.subscribeV5('execution', 'linear');
// wsClient.subscribeV5(['order', 'wallet', 'greek'], 'linear');

// To unsubscribe from topics (after a 5 second delay, in this example):
setTimeout(() => {
  console.log('unsubscribing');
  wsClient.unsubscribeV5('kline.5.ETHUSDT', 'spot');
}, 5 * 1000);

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

  console.log('Active private v5 topics: ', activePrivateTopics);

  const activePublicLinearTopics = wsClient
    .getWsStore()
    .getTopics(WS_KEY_MAP.v5LinearPublic);
  console.log('Active public linear v5 topics: ', activePublicLinearTopics);

  const activePublicSpotTopis = wsClient
    .getWsStore()
    .getTopics(WS_KEY_MAP.v5SpotPublic);
  console.log('Active public spot v5 topics: ', activePublicSpotTopis);

  const activePublicOptionsTopics = wsClient
    .getWsStore()
    .getTopics(WS_KEY_MAP.v5OptionPublic);
  console.log('Active public option v5 topics: ', activePublicOptionsTopics);
}, 15 * 1000);