Bybit JavaScript SDK

1import { RestClientV5 } from 'bybit-api';2 3const key = process.env.API_KEY_COM;4const secret = process.env.API_SECRET_COM;5 6const client = new RestClientV5({7  key: key,8  secret: secret,9});10 11(async () => {12  try {13    /** Simple examples for private REST API calls with bybit's V5 REST APIs */14    const response = await client.getPositionInfo({15      category: 'linear',16      symbol: 'BTCUSDT',17    });18 19    console.log('response:', response);20 21    // Trade USDT linear perps22    const buyOrderResult = await client.submitOrder({23      category: 'linear',24      symbol: 'BTCUSDT',25      orderType: 'Market',26      qty: '1',27      side: 'Buy',28    });29    console.log('buyOrderResult:', buyOrderResult);30 31    const sellOrderResult = await client.submitOrder({32      category: 'linear',33      symbol: 'BTCUSDT',34      orderType: 'Market',35      qty: '1',36      side: 'Sell',37    });38    console.log('sellOrderResult:', sellOrderResult);39  } catch (e) {40    console.error('request failed: ', e);41  }42})();

1/* eslint-disable @typescript-eslint/no-empty-function */2import { DefaultLogger, WebsocketClient, WS_KEY_MAP } from 'bybit-api';3 4// Create & inject a custom logger to enable the trace logging level (empty function)5const logger = {6  ...DefaultLogger,7  // trace: (...params) => console.log('trace', ...params),8};9 10const key = process.env.API_KEY_COM;11const secret = process.env.API_SECRET_COM;12 13/**14 * Prepare an instance of the WebSocket client. This client handles all aspects of connectivity for you:15 * - Connections are opened when you subscribe to topics16 * - If key & secret are provided, authentication is handled automatically17 * - If you subscribe to topics from different v5 products (e.g. spot and linear perps),18 *    subscription events are automatically routed to the different ws endpoints on bybit's side19 * - Heartbeats/ping/pong/reconnects are all handled automatically.20 *    If a connection drops, the client will clean it up, respawn a fresh connection and resubscribe for you.21 */22const wsClient = new WebsocketClient(23  {24    key: key,25    secret: secret,26    // testnet: false,27    // demoTrading: false, // set testnet to false, if you plan on using demo trading28  },29  logger,30);31 32wsClient.on('update', (data) => {33  console.log('raw message received ', JSON.stringify(data));34  // console.log('raw message received ', JSON.stringify(data, null, 2));35});36 37wsClient.on('open', (data) => {38  console.log('connection opened open:', data.wsKey);39});40wsClient.on('response', (data) => {41  console.log('log response: ', JSON.stringify(data, null, 2));42});43wsClient.on('reconnect', ({ wsKey }) => {44  console.log('ws automatically reconnecting.... ', wsKey);45});46wsClient.on('reconnected', (data) => {47  console.log('ws has reconnected ', data?.wsKey);48});49wsClient.on('exception', (data) => {50  console.error('ws exception: ', data);51});52 53/**54 * For private V5 topics, us the subscribeV5() method on the ws client or use the original subscribe() method.55 *56 * Note: for private endpoints the "category" field is ignored since there is only one private endpoint57 * (compared to one public one per category).58 * The "category" is only needed for public topics since bybit has one endpoint for public events per category.59 */60 61wsClient.subscribeV5('position', 'linear');62wsClient.subscribeV5(['order', 'wallet'], 'linear');63 64wsClient.subscribeV5('execution', 'linear');65// wsClient.subscribeV5('execution.fast', 'linear');66// wsClient.subscribeV5('execution.fast.linear', 'linear');67 68/**69 * The following has the same effect as above, since there's only one private endpoint for V5 account topics:70 */71// wsClient.subscribe('position');72// wsClient.subscribe('execution');73// wsClient.subscribe(['order', 'wallet', 'greek']);74 75// To unsubscribe from topics (after a 5 second delay, in this example):76// setTimeout(() => {77//   console.log('unsubscribing');78//   wsClient.unsubscribeV5('execution', 'linear');79// }, 5 * 1000);80 81// Topics are tracked per websocket type82// Get a list of subscribed topics (e.g. for public v3 spot topics) (after a 5 second delay)83setTimeout(() => {84  const activePrivateTopics = wsClient85    .getWsStore()86    .getTopics(WS_KEY_MAP.v5Private);87  console.log('Active private v5 topics: ', activePrivateTopics);88 89  const activePublicLinearTopics = wsClient90    .getWsStore()91    .getTopics(WS_KEY_MAP.v5LinearPublic);92  console.log('Active public linear v5 topics: ', activePublicLinearTopics);93 94  const activePublicSpotTopis = wsClient95    .getWsStore()96    .getTopics(WS_KEY_MAP.v5SpotPublic);97  console.log('Active public spot v5 topics: ', activePublicSpotTopis);98 99  const activePublicOptionsTopics = wsClient100    .getWsStore()101    .getTopics(WS_KEY_MAP.v5OptionPublic);102  console.log('Active public option v5 topics: ', activePublicOptionsTopics);103}, 5 * 1000);

1import { DefaultLogger, WebsocketAPIClient } from 'bybit-api';2 3// const { DefaultLogger, WebsocketAPIClient } = require('bybit-api');4 5const key = process.env.API_KEY_COM;6const secret = process.env.API_SECRET_COM;7 8// function attachEventHandlers<TWSClient extends WebsocketClient>(9//   wsClient: TWSClient,10// ): void {11//   wsClient.on('update', (data) => {12//     console.log('raw message received ', JSON.stringify(data));13//   });14//   wsClient.on('open', (data) => {15//     console.log('ws connected', data.wsKey);16//   });17//   wsClient.on('reconnect', ({ wsKey }) => {18//     console.log('ws automatically reconnecting.... ', wsKey);19//   });20//   wsClient.on('reconnected', (data) => {21//     console.log('ws has reconnected ', data?.wsKey);22//   });23//   wsClient.on('authenticated', (data) => {24//     console.log('ws has authenticated ', data?.wsKey);25//   });26// }27 28async function main() {29  // Optional30  const logger = {31    ...DefaultLogger,32    // For a more detailed view of the WebsocketClient, enable the `trace` level by uncommenting the below line:33    // trace: (...params) => console.log('trace', ...params),34  };35 36  const wsClient = new WebsocketAPIClient(37    {38      key: key,39      secret: secret,40      // testnet: true, // Whether to use the testnet environment: https://testnet.bybit.com/app/user/api-management41 42      // Whether to use the livenet demo trading environment43      // Note: As of Jan 2025, demo trading only supports consuming events, it does44      // NOT support the WS API.45      // demoTrading: false,46 47      // If you want your own event handlers instead of the default ones with logs,48      // disable this setting and see the `attachEventHandlers` example below:49      // attachEventListeners: false50    },51    logger, // Optional: inject a custom logger52  );53 54  // Optional, see above "attachEventListeners". Attach basic event handlers, so nothing is left unhandled55  // attachEventHandlers(wsClient.getWSClient());56 57  // Optional, if you see RECV Window errors, you can use this to manage time issues.58  // ! However, make sure you sync your system clock first!59  // https://github.com/tiagosiebler/awesome-crypto-examples/wiki/Timestamp-for-this-request-is-outside-of-the-recvWindow60  // wsClient.setTimeOffsetMs(-5000);61 62  // Optional: prepare the WebSocket API connection in advance.63  // This happens automatically but you can do this early before making any API calls, to prevent delays from a cold start.64  // await wsClient.getWSClient().connectWSAPI();65 66  try {67    const response = await wsClient.submitNewOrder({68      category: 'linear',69      symbol: 'BTCUSDT',70      orderType: 'Limit',71      qty: '0.001',72      side: 'Buy',73      price: '50000',74    });75    console.log('submitNewOrder response: ', response);76  } catch (e) {77    console.log('submitNewOrder error: ', e);78  }79 80  try {81    const response = await wsClient.amendOrder({82      category: 'linear',83      symbol: 'BTCUSDT',84      orderId: 'b4b9e205-793c-4777-8112-0bf3c2d26b6e',85      qty: '0.001',86      price: '60000',87    });88    console.log('amendOrder response: ', response);89  } catch (e) {90    console.log('amendOrder error: ', e);91  }92 93  try {94    const response = await wsClient.cancelOrder({95      category: 'linear',96      symbol: 'BTCUSDT',97      orderId: 'b4b9e205-793c-4777-8112-0bf3c2d26b6e',98    });99    console.log('cancelOrder response: ', response);100  } catch (e) {101    console.log('cancelOrder error: ', e);102  }103 104  try {105    const response = await wsClient.batchSubmitOrders('linear', [106      {107        symbol: 'BTCUSDT',108        orderType: 'Limit',109        qty: '0.001',110        side: 'Buy',111        price: '50000',112      },113      {114        symbol: 'BTCUSDT',115        orderType: 'Limit',116        qty: '0.001',117        side: 'Buy',118        price: '60000',119      },120      {121        symbol: 'BTCUSDT',122        orderType: 'Limit',123        qty: '0.001',124        side: 'Buy',125        price: '70000',126      },127    ]);128    console.log('batchSubmitOrders response: ', response);129  } catch (e) {130    console.log('batchSubmitOrders error: ', e);131  }132 133  try {134    const response = await wsClient.batchAmendOrder('linear', [135      {136        symbol: 'BTCUSDT',137        orderId: '2473ee58',138        price: '80000',139      },140      {141        symbol: 'BTCUSDT',142        orderId: 'b4b9e205-793c-4777-8112-0bf3c2d26b6e',143        price: '80000',144      },145    ]);146    console.log('batchAmendOrder response: ', response);147  } catch (e) {148    console.log('batchAmendOrder error: ', e);149  }150 151  try {152    const response = await wsClient.batchCancelOrder('linear', [153      {154        symbol: 'BTCUSDT',155        orderId: '2473ee58',156      },157      {158        symbol: 'BTCUSDT',159        orderId: 'b4b9e205-793c-4777-8112-0bf3c2d26b6e',160      },161    ]);162    console.log('batchCancelOrder response: ', response);163  } catch (e) {164    console.log('batchCancelOrder error: ', e);165  }166}167 168main();