OKX JavaScript SDK

1import { DefaultLogger, WebsocketClient } from 'okx-api';2 3// Optional: Inject a custom logger.4// This example overrides the default logger to also log "trace" (super verbose) messages, which are disabled by default5const logger = {6  ...DefaultLogger,7  // trace: (...params) => console.log('trace', ...params),8};9 10// For private events, all 3 of the following are required (per account):11const API_KEY = process.env.API_KEY_COM;12const API_SECRET = process.env.API_SECRET_COM;13const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;14 15// If running from CLI in unix, you can pass env vars as such:16// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts17 18// note the single quotes, preventing special characters such as $ from being incorrectly passed19 20if (!API_KEY) {21  throw new Error('API_KEY is missing');22}23 24if (!API_SECRET) {25  throw new Error('API_SECRET is missing');26}27 28if (!API_PASSPHRASE) {29  throw new Error('API_PASSPHRASE is missing');30}31 32const wsClient = new WebsocketClient(33  {34    // For Global users (www.okx.com), you don't need to set the market.35    // It will use global by default.36    // Not needed: market: 'GLOBAL',37 38    // For EEA users (my.okx.com), set market to "EEA":39    // market: 'EEA',40 41    // For US users (app.okx.com), set market to "US":42    // market: 'US',43 44    accounts: [45      // For private topics, include one or more accounts in an array. Otherwise only public topics will work46      {47        apiKey: API_KEY,48        apiSecret: API_SECRET,49        apiPass: API_PASSPHRASE,50      },51      // {52      //   apiKey: 'yourApiKeyHere',53      //   apiSecret: 'yourApiSecretHere',54      //   apiPass: 'yourApiPassHere',55      // },56      // {57      //   apiKey: 'anotherAccountKey',58      //   apiSecret: 'anotherAccountSecret',59      //   apiPass: 'anotherAccountPass',60      // },61    ],62  },63  logger,64);65 66// Raw data will arrive on the 'update' event67wsClient.on('update', (data) => {68  // console.log('ws update (raw data received)', JSON.stringify(data, null, 2));69  console.log('ws update (raw data received)', JSON.stringify(data));70});71 72wsClient.on('open', (data) => {73  console.log('connection opened open:', data.wsKey);74});75 76// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event77wsClient.on('response', (data) => {78  // console.log('ws response: ', JSON.stringify(data, null, 2));79  console.log('ws response: ', JSON.stringify(data));80});81 82wsClient.on('reconnect', ({ wsKey }) => {83  console.log('ws automatically reconnecting.... ', wsKey);84});85wsClient.on('reconnected', (data) => {86  console.log('ws has reconnected ', data?.wsKey);87});88wsClient.on('exception', (data) => {89  console.error('ws exception: ', data);90});91 92// Optional, connect before subscribing:93// wsClient.connectPrivate();94 95// This is optional though. The wsclient will automatically open and subscribe if the connection doesn't exist yet.96 97/**98   * # Subscribing to channels99   *100   * Subscribe to channels using the inner "args" part of the subscription request described in the OKX API docs.101   *102   * For example, if the docs state your request should look as such:103   {104     op: "subscribe",105     args: [106       {107         channel: "account"108       }109     ]110   }111   *112   * You should call the wsClient.subscribe function using only the "args".113   *114   * Either of these examples is correct (one channel vs one or more channels in an array):115   wsClient.subscribe({116     channel: 'account'117   });118 119   wsClient.subscribe([120     {121       channel: "account"122     }123   ])124   */125 126// Subscribe one event at a time:127wsClient.subscribe({128  channel: 'account',129});130 131// OR, combine multiple subscription events into one request using an array instead of an object:132wsClient.subscribe([133  {134    channel: 'account',135  },136  {137    channel: 'positions',138    instType: 'ANY',139  },140]);141 142/**143 * Examples for each private channel listed in the API docs:144 * https://www.okx.com/docs-v5/en/#websocket-api-private-channel145 */146 147// Account events for all symbols148wsClient.subscribe({149  channel: 'account',150});151 152// Account events for specific symbol only153wsClient.subscribe({154  channel: 'account',155  ccy: 'BTC',156});157 158// Withdrawal events for specific symbol only159wsClient.subscribe({160  channel: 'withdrawal-info',161  ccy: 'BTC',162});163 164// Position events on any instrument type165wsClient.subscribe({166  channel: 'positions',167  instType: 'ANY',168});169 170// Position events on specific instruments171wsClient.subscribe({172  channel: 'positions',173  instType: 'SWAP',174  instFamily: 'ETH-USD',175  instId: 'ETH-USD-SWAP',176});177 178// Balance & position channel179wsClient.subscribe({180  channel: 'balance_and_position',181});182 183// Order channel184wsClient.subscribe({185  channel: 'orders',186  instType: 'ANY',187});188 189// Order channel with extra args190wsClient.subscribe({191  channel: 'orders',192  instType: 'FUTURES',193  instFamily: 'BTC-USD',194});195 196// Algo orders channel197wsClient.subscribe({198  channel: 'orders-algo',199  instType: 'ANY',200});201 202// Advance algo orders channel203wsClient.subscribe({204  channel: 'algo-advance',205  instType: 'ANY',206});207 208// Position risk warning channel209wsClient.subscribe({210  channel: 'liquidation-warning',211  instType: 'ANY',212});213 214// Account greeks channel215wsClient.subscribe({216  channel: 'account-greeks',217});218 219// Spot grid algo orders channel220wsClient.subscribe({221  channel: 'grid-orders-spot',222  instType: 'SPOT',223});224 225// Contract grid orders channel226wsClient.subscribe({227  channel: 'grid-orders-contract',228  instType: 'ANY',229});230 231// Moon grid orders channel232wsClient.subscribe({233  channel: 'grid-orders-moon',234  instType: 'ANY',235});236 237// Moon grid orders channel238wsClient.subscribe({239  channel: 'grid-orders-moon',240  instType: 'ANY',241});242 243// Grid positions channel244wsClient.subscribe({245  channel: 'grid-positions',246  algoId: '449327675342323712',247});248 249// Grid sub orders channel250wsClient.subscribe({251  channel: 'grid-sub-orders',252  algoId: '449327675342323712',253});