HTX JavaScript SDK

1/* eslint-disable @typescript-eslint/no-unused-vars */2import { SpotClient } from '../../../src/index.js';3 4// This example shows how to call HTX Spot API endpoints for ORDER MANAGEMENT.5 6/**7 * import { SpotClient } from '@siebly/htx-api';8 */9const client = new SpotClient({10  apiKey: process.env.API_SPOT_KEY || 'insertApiKeyHere',11  apiSecret: process.env.API_SPOT_SECRET || 'insertApiSecretHere',12});13 14async function getOpenOrders() {15  try {16    const openOrders = await client.getOpenOrders({ symbol: 'btcusdt' });17    console.log('Open Orders: ', JSON.stringify(openOrders, null, 2));18  } catch (e) {19    console.error('Get open orders error: ', e);20  }21}22 23async function getOpenOrdersByClientId() {24  try {25    const order = await client.getOrderByClientId({26      clientOrderId: 'your-client-order-id-here',27    });28    console.log('Order by Client ID: ', JSON.stringify(order, null, 2));29  } catch (e) {30    console.error('Get order by client id error: ', e);31  }32}33 34async function getOrderHistory() {35  try {36    const orderHistory = await client.getOrderHistory({37      symbol: 'btcusdt',38      states: 'filled,canceled,partial-canceled',39      size: 50,40    });41    console.log('Order History: ', JSON.stringify(orderHistory, null, 2));42  } catch (e) {43    console.error('Get order history error: ', e);44  }45}46 47async function getOrderHistory48h() {48  try {49    const orderHistory = await client.getOrderHistory48h({50      symbol: 'btcusdt',51      size: 50,52    });53    console.log('Order History (48h): ', JSON.stringify(orderHistory, null, 2));54  } catch (e) {55    console.error('Get order history 48h error: ', e);56  }57}58 59async function getMatchResults() {60  try {61    const matchResults = await client.getMatchResults({62      symbol: 'btcusdt',63      size: 50,64    });65    console.log('Match Results: ', JSON.stringify(matchResults, null, 2));66  } catch (e) {67    console.error('Get match results error: ', e);68  }69}70 71async function cancelOrderById() {72  try {73    const cancelResult = await client.cancelOrderById({74      orderId: '1620028655831163',75      symbol: 'btcusdt',76    });77    console.log('Cancel Order Result: ', JSON.stringify(cancelResult, null, 2));78  } catch (e) {79    console.error('Cancel order by id error: ', e);80  }81}82 83async function cancelOrderByClientId() {84  try {85    const cancelResult = await client.cancelOrderByClientId({86      'client-order-id': 'your-client-order-id-here',87    });88    console.log(89      'Cancel by Client ID Result: ',90      JSON.stringify(cancelResult, null, 2),91    );92  } catch (e) {93    console.error('Cancel order by client id error: ', e);94  }95}96 97async function cancelAllOrders() {98  try {99    const cancelAllResult = await client.cancelAllOrders({ symbol: 'btcusdt' });100    console.log(101      'Cancel All Orders Result: ',102      JSON.stringify(cancelAllResult, null, 2),103    );104  } catch (e) {105    console.error('Cancel all orders error: ', e);106  }107}108 109async function setCancelAllAfter() {110  try {111    const cancelAfterResult = await client.setCancelAllAfter({ timeout: 120 });112    console.log(113      'Cancel All After Result: ',114      JSON.stringify(cancelAfterResult, null, 2),115    );116  } catch (e) {117    console.error('Set cancel all after error: ', e);118  }119}120 121// Uncomment the function you want to test:122 123// getOpenOrders();124// getOpenOrdersByClientId();125// getOrderHistory();126// getOrderHistory48h();127// etMatchResults();128// cancelOrderById();129// cancelOrderByClientId();130// cancelAllOrders();131// setCancelAllAfter();

1/* eslint-disable @typescript-eslint/no-unused-vars */2import {3  DefaultLogger,4  LogParams,5  WebsocketClient,6  WS_KEY_MAP,7} from '../../../src/index.js';8 9// Install from npm in your own project:10// import { WebsocketClient, WS_KEY_MAP, WSTopicRequest } from '@siebly/htx-api';11 12function isRecord(value: unknown): value is Record<string, unknown> {13  return typeof value === 'object' && value !== null;14}15 16function isMutedTrace(params: LogParams): boolean {17  const [message, details] = params;18 19  if (message === 'Received PING event') {20    return true;21  }22 23  if (message === 'onWsMessage().emit(message)') {24    return true;25  }26 27  if (28    typeof message === 'string' &&29    message.startsWith('getFinalEmittable()->pre()')30  ) {31    return true;32  }33 34  if (35    message === 'Sending upstream ws message: ' &&36    isRecord(details) &&37    typeof details.wsMessage === 'string'38  ) {39    // return false;40    return !details.wsMessage.includes('"pong"');41  }42 43  return false;44}45 46const customLogger: DefaultLogger = {47  trace: (...params: LogParams): void => {48    // if (isMutedTrace(params)) {49    //   return;50    // }51    // console.log('trace', params);52  },53  info: (...params: LogParams): void => {54    console.log('info', ...params);55  },56  error: (...params: LogParams): void => {57    console.error('error', ...params);58  },59};60 61async function start() {62  const account = {63    key: process.env.API_KEY || '',64    secret: process.env.API_SECRET || '',65  };66 67  const client = new WebsocketClient(68    {69      apiKey: account.key,70      apiSecret: account.secret,71    },72    customLogger,73  );74 75  client76    .on('open', (data) => console.log('open:', data.wsKey))77    .on('authenticated', (data) => console.log('authenticated:', data.wsKey))78    .on('message', (data) => console.info('message:', JSON.stringify(data)))79    .on('response', (data) => console.info('response:', JSON.stringify(data)))80    .on('reconnecting', (data) => console.log('reconnecting:', data.wsKey))81    .on('reconnected', (data) => console.log('reconnected:', data.wsKey))82    .on('close', (data) => console.log('close:', data.wsKey))83    .on('exception', (data) => console.error('exception:', data));84 85  /**86   * Spot private websocket: wss://api-aws.huobi.pro/ws/v2 by default.87   *88   * The SDK signs and sends the auth request automatically before subscribing.89   */90 91  client.subscribe(92    [93      // not specifying "mode", Only update when account balance changed;94      'accounts.update',95      // Specify "mode" as 0, Only update when account balance changed;96      'accounts.update#0',97      // Specify "mode" as 1, Update when either account balance changed or available balance changed.98      'accounts.update#1',99      // Specify "mode" as 2, Whenever account balance or available balance changed, it will be updated together.100      'accounts.update#2',101      // Subscribe to order updates for all symbols (wildcard allowed)102      'orders#*',103      // Subscribe to order updates for btcusdt only104      'orders#btcusdt',105      // Subscribe to trade clearing for all symbols (wildcard allowed) (mode is optional)106      'trade.clearing#*',107      // Subscribe to trade clearing for btcusdt only (mode is optional)108      'trade.clearing#btcusdt',109      // Subscribe to trade clearing for all symbols, mode 0 (trade event only (default))110      'trade.clearing#*#0',111      // Subscribe to trade clearing for all symbols, mode 1 (trade & cancellation events)112      'trade.clearing#*#1',113    ],114    WS_KEY_MAP.spotPrivateV2,115  );116}117 118start();

1/* eslint-disable @typescript-eslint/no-unused-vars */2import {3  DefaultLogger,4  LogParams,5  WebsocketAPIClient,6} from '../../../src/index.js';7 8// Install from npm in your own project:9// import { WebsocketAPIClient } from '@siebly/htx-api';10 11const customLogger: DefaultLogger = {12  trace: (..._params: LogParams): void => {13    // console.log('trace', ...params);14  },15  info: (...params: LogParams): void => {16    console.log('info', ...params);17  },18  error: (...params: LogParams): void => {19    console.error('error', ...params);20  },21};22 23async function start() {24  const account = {25    key: process.env.API_SPOT_KEY || 'keyHere',26    secret: process.env.API_SPOT_SECRET || 'secretHere',27  };28 29  /**30   * The WebsocketAPIClient is a typed REST-like wrapper for WS API31   * request/response trading methods. It uses an embedded WebsocketClient for32   * connection management and authentication.33   */34  const client = new WebsocketAPIClient(35    {36      apiKey: account.key,37      apiSecret: account.secret,38    },39    customLogger,40  );41 42  /**43   * Optional: authenticate the spot trade websocket before the first request.44   * The first WS API request will also connect/authenticate automatically.45   */46  // await client.getWSClient().connectWSAPI(WS_KEY_MAP.spotTrade);47 48  /**49   * These are live trading commands. Keep this false until the params below50   * have been reviewed for your account, symbol, and order intent.51   */52  const runLiveTradingExamples = false;53 54  if (!runLiveTradingExamples) {55    console.log('Set runLiveTradingExamples=true after reviewing the params.');56    return;57  }58 59  try {60    const order = await client.submitSpotOrder({61      'account-id': 123456,62      symbol: 'btcusdt',63      type: 'buy-limit',64      amount: '0.001',65      price: '20000',66      source: 'spot-api',67      //68      // Example of a custom order ID:69      // to make your own, always include the prefix:70      // 'client-order-id': `${client.getOrderIdPrefix()}${Date.now()}`,71      //72      // or to generate a new unique order ID:73      // 'client-order-id': client.generateNewOrderID(),74      //75      // Note: if you do use the client-order-id, it must be prefixed with `client.getOrderIdPrefix()` and unique. `client.generateNewOrderID()` is the recommended way to generate a unique order ID.76      // Do not store state in custom order IDs. They are best used as look-up keys for a local state cache.77      // For more guidance refer to the best practices on Siebly.io:78      // https://siebly.io/reference/glossary#custom-order-id79    });80    console.log('submitSpotOrder:', order);81  } catch (e) {82    console.error('submitSpotOrder error:', e);83  }84 85  try {86    const batchOrder = await client.submitSpotBatchOrders([87      {88        'account-id': 123456,89        symbol: 'btcusdt',90        type: 'buy-limit',91        amount: '0.001',92        price: '19000',93        source: 'spot-api',94      },95      {96        'account-id': 123456,97        symbol: 'ethusdt',98        type: 'buy-limit',99        amount: '0.01',100        price: '1000',101        source: 'spot-api',102      },103    ]);104    console.log('submitSpotBatchOrders:', batchOrder);105  } catch (e) {106    console.error('submitSpotBatchOrders error:', e);107  }108 109  try {110    const marginOrder = await client.submitSpotMarginOrder({111      'account-id': 123456,112      symbol: 'btcusdt',113      type: 'sell-limit',114      amount: '0.001',115      price: '40000',116      source: 'super-margin-api',117      'trade-purpose': 2,118    });119    console.log('submitSpotMarginOrder:', marginOrder);120  } catch (e) {121    console.error('submitSpotMarginOrder error:', e);122  }123 124  try {125    const cancelOrders = await client.cancelSpotOrders({126      'order-ids': ['123456789'],127    });128    console.log('cancelSpotOrders:', cancelOrders);129  } catch (e) {130    console.error('cancelSpotOrders error:', e);131  }132 133  try {134    const cancelAll = await client.cancelAllSpotOrders({135      'account-id': 123456,136      symbol: 'btcusdt',137      size: 100,138    });139    console.log('cancelAllSpotOrders:', cancelAll);140  } catch (e) {141    console.error('cancelAllSpotOrders error:', e);142  }143}144 145start();