README.md

Node.js & Typescript BitMart API SDK

Complete JavaScript & Node.js SDK for BitMart REST APIs & WebSockets:

• Complete integration with all BitMart APIs. Full support for Futures V2 domain.
• TypeScript support (with type declarations for most API requests & responses)
• Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
• Browser-friendly HMAC signature mechanism.
• Automatically supports both ESM and CJS projects.

Installation

npm install --save bitmart-api

Issues & Discussion

• Issues? Check the issues tab.
• Discuss & collaborate with other node devs? Join our Node.js Algo Traders engineering community on telegram.

Usage

Most methods pass values as-is into HTTP requests. These can be populated using parameters specified by BitMart's API documentation, or check the type definition in each class within this repository.

• BitMart API | Spot
• BitMart API | USD-M Futures
• REST Endpoint Function List

REST APIs

• Create API credentials within your account on BitMart's website, if you haven't done so already.
• Import/require the module
• Create an instance of the REST client
• Call the function corresponding to the API call and handle the returned promise.

const { RestClient, FuturesClientV2 } = require('bitmart-api');

const client = new RestClient({
  apiKey: 'yourAPIKeyHere',
  apiSecret: 'yourAPISecretHere',
  apiMemo: 'yourAPIMemoHere',
});

client
  .getAccountBalancesV1()
  .then((result) => {
    console.log('getAccountBalancesV1 result: ', result);
  })
  .catch((err) => {
    console.error('getAccountBalancesV1 error: ', err);
  });

// For futures, use the FuturesClientV2 - it's mapped to the new V2 futures sub domain
const futuresV2Client = new FuturesClientV2({
  apiKey: 'yourAPIKeyHere',
  apiSecret: 'yourAPISecretHere',
  apiMemo: 'yourAPIMemoHere',
});

const balances = await futuresV2Client.getFuturesAccountAssets();

console.log('Balances: ', JSON.stringify(balances, null, 2));

WebSocket

• All available WebSockets can be used via a shared WebsocketClient
• Simple instructions are below, for more examples check examples

// create websocket client
// If public client, doesn't need API keys
const client = new WebsocketClient();

// If private client, needs API keys
const client = new WebsocketClient({
  apiKey: 'yourAPIKeyHere',
  apiSecret: 'yourAPISecretHere',
  apiMemo: 'yourAPIMemoHere',
});

client.on('open', (data) => {
  console.log('connected ', data?.wsKey);
});

// Data received
client.on('update', (data) => {
  console.info('data received: ', JSON.stringify(data));
});

// Something happened, attempting to reconenct
client.on('reconnect', (data) => {
  console.log('reconnect: ', data);
});

// Reconnect successful
client.on('reconnected', (data) => {
  console.log('reconnected: ', data);
});

// Connection closed. If unexpected, expect reconnect -> reconnected.
client.on('close', (data) => {
  console.error('close: ', data);
});

// Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate"
client.on('response', (data) => {
  console.info('response: ', data);
});

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

client.on('authenticated', (data) => {
  console.error('authenticated: ', data);
});

// subscribing to topics

// Spot User Orders
client.subscribe('spot/user/order:BTC_USDT', 'spot');

// Ticker Channel
// client.subscribe('futures/ticker', 'futures');

// Depth Channel
// client.subscribe('futures/depth20:BTCUSDT', 'futures');

// Trade Channel
// client.subscribe('futures/trade:BTCUSDT', 'futures');

// KlineBin Channel
// client.subscribe('futures/klineBin1m:BTCUSDT', 'futures');

// Or have multiple topics in one array:
client.subscribe(
  [
    'futures/klineBin1m:BTCUSDT',
    'futures/klineBin1m:ETHUSDT',
    'futures/klineBin1m:XRPUSDT',
    'futures/klineBin1m:BMXUSDT',
    'futures/klineBin1m:SOLUSDT',
  ],
  'futures',
);

Recv Window

This can be set two levels:

• Per method: if provided in a method, will be used instead of the global default
• Global default: this will apply by default to any api call that supports recvWindow, if no recvWindow is provided in the method call.

Custom Sign

Authentication involves HMAC signing on the request, using API credentials. Internally, this SDK uses the Web Crypto API. The REST client also supports injecting a custom sign function, should you wish to use an alternative (such as node's native & faster createHmac).

Refer to the fasterHmacSign.ts example for a demonstration.

---

Related projects

Check out my related projects:

• Try my connectors:

  • binance
  • bybit-api
  • okx-api
  • bitget-api
  • bitmart-api
  • gateio-api

• Try my misc utilities:

  • orderbooks
  • accountstate

• Check out my examples:

  • awesome-crypto-examples

Structure

This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using npm run build, which is also the version published to npm.

The version on npm is the output from the build command and can be used in projects without TypeScript (although TypeScript is definitely recommended).

Note: The build will output both ESM and CJS, although node should automatically import the correct entrypoint for your environment.

• src - the whole SDK written in TypeScript
• dist - ESM & CJS builds of the SDK in JavaScript (this is published to npm)
• examples - some implementation examples & demonstrations.

---

Contributions & Thanks

Donations

tiagosiebler

If you found this project interesting or useful, do consider sponsoring me on github. Thank you!

Contributions & Pull Requests

Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.

Star History