WebSocket Client

npm install okx-api

import { WebsocketClient } from 'okx-api';

const wsClient = new WebsocketClient({
  // market defaults to 'prod' (www.okx.com)
  // Add accounts array for private channels
});

// Listen for incoming channel data
wsClient.on('update', (data) => {
  console.log('received:', JSON.stringify(data));
});

// Subscribe to a public channel
wsClient.subscribe({
  channel: 'tickers',
  instId: 'BTC-USDT',
});

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

const wsClient = new WebsocketClient(
  {
    market: 'prod',
    demoTrading: false,
    pingInterval: 10000,
    pongTimeout: 5000,
    reconnectTimeout: 2500,
    accounts: [
      {
        apiKey: process.env.API_KEY!,
        apiSecret: process.env.API_SECRET!,
        apiPass: process.env.API_PASSPHRASE!,
      },
    ],
  },
  DefaultLogger, // optional custom logger
);

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

// Multiple subscriptions in one call
wsClient.subscribe([
  { channel: 'tickers', instId: 'BTC-USDT' },
  { channel: 'trades', instId: 'ETH-USDT' },
]);

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

wsClient.on('update', (data) => { /* channel data */ });
wsClient.on('response', (data) => { /* subscribe/auth confirmations */ });
wsClient.on('open', (data) => { /* connection opened */ });
wsClient.on('reconnect', (data) => { /* reconnecting */ });
wsClient.on('reconnected', (data) => { /* reconnection succeeded */ });
wsClient.on('exception', (data) => { /* errors */ });

// Open all connections upfront
wsClient.connectAll();

// Or open specific connections
wsClient.connectPublic();
wsClient.connectPrivate();

import { WebsocketClientLegacy } from 'okx-api';