Public Channels

import { DefaultLogger, WebsocketClient } from 'okx-api';

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

const wsClient = new WebsocketClient(
  {
    // market defaults to 'prod' (www.okx.com)
    // For EEA: market: 'EEA'
    // For US:  market: 'US'
  },
  logger,
);

// All incoming channel data arrives on 'update'
wsClient.on('update', (data) => {
  console.log(new Date(), 'ws update', JSON.stringify(data));
});

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 has reconnected', data?.wsKey);
});

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

wsClient.subscribe({
  channel: 'instruments',
  instType: 'SPOT',
});

wsClient.subscribe({
  channel: 'instruments',
  instType: 'FUTURES',
});

wsClient.subscribe({
  channel: 'tickers',
  instId: 'BTC-USDT',
});

wsClient.subscribe({
  channel: 'trades',
  instId: 'BTC-USDT',
});

wsClient.subscribe({
  channel: 'mark-price',
  instId: 'BTC-USDT',
});

// Mark price candlesticks
wsClient.subscribe({
  channel: 'mark-price-candle1m',
  instId: 'BTC-USDT',
});

wsClient.subscribe({
  channel: 'index-tickers',
  instId: 'BTC-USDT',
});

wsClient.subscribe({
  channel: 'index-candle1m',
  instId: 'BTC-USD',
});

wsClient.subscribe({
  channel: 'funding-rate',
  instId: 'BTC-USD-SWAP',
});

wsClient.subscribe({
  channel: 'open-interest',
  instId: 'BTC-USD-SWAP',
});

wsClient.subscribe({
  channel: 'price-limit',
  instId: 'BTC-USDT-SWAP',
});

wsClient.subscribe({
  channel: 'opt-summary',
  instFamily: 'BTC-USD',
});

wsClient.subscribe({
  channel: 'estimated-price',
  instType: 'FUTURES',
  instFamily: 'BTC-USD',
});

wsClient.subscribe({
  channel: 'liquidation-orders',
  instType: 'FUTURES',
});

wsClient.subscribe({
  channel: 'liquidation-orders',
  instType: 'SWAP',
});

wsClient.subscribe({
  channel: 'status',
});

wsClient.on('update', (data) => {
  // data.arg.channel identifies which channel sent the update
  // data.data contains the array of updated records
  // data.wsKey identifies the underlying connection
  switch (data.arg.channel) {
    case 'tickers':
      console.log('Ticker update:', data.data);
      break;
    case 'trades':
      console.log('Trade update:', data.data);
      break;
    case 'books':
      console.log('Order book update:', data.data);
      break;
    default:
      console.log(`Update from ${data.arg.channel}:`, data.data);
  }
});

wsClient.subscribe([
  {
    channel: 'instruments',
    instType: 'SPOT',
  },
  {
    channel: 'tickers',
    instId: 'LTC-BTC',
  },
]);