Skip to content

Choose a client ​

  • SpotClient: Spot market data, balances, orders, margin and account operations.
  • FuturesClient: futures market data and trading, including linear swaps, coin-margined swaps, delivery contracts and V5 endpoints.
  • WebsocketClient: public market subscriptions and private account updates across HTX products.
  • WebsocketAPIClient: promise-based Spot and derivatives trading commands over WebSockets.

Match the product and account ​

Spot examples use lowercase symbols such as btcusdt. Derivatives methods use their own contract identifiers, margin modes and quantity units. Use the method's request type and current contract metadata rather than adapting Spot parameters by changing only the symbol.

FuturesClient exposes several API generations in one class. Choose the method for the account mode you actually use. A shared client does not imply that legacy and V5 request or response formats are interchangeable.

Select a WebSocket connection ​

Pass a connection key as the second argument to subscribe():

ProductPublic dataPrivate updatesTrading commands
SpotspotPublic, spotFeedspotPrivateV2spotTrade
Linear swapslinearSwapPubliclinearSwapPrivatelinearSwapTrade
Coin-margined deliverycoinDeliveryPubliccoinDeliveryPrivatecoinDeliveryTrade
Coin-margined swapscoinSwapPubliccoinSwapPrivatecoinSwapTrade

derivativesPrivateV5 is a separate unified derivatives account feed. derivativesIndex and derivativesSystem provide additional derivatives channels. Select only the connections your application needs; connectAll() opens multiple product connections.

The wrapper's methods choose trading connections for you. For low-level commands, use sendWSAPIRequest() with the matching key and operation. Read WebSocket API requests before using either approach.

Configuration · Public streams · API reference

Built by Siebly. Open source SDKs for exchange APIs.