Skip to content

API reference ​

The reference is generated from the exact released SDK source. Use the guides for workflow examples, then open the relevant client or type for parameters and response fields.

Clients ​

  • 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.

Types and helpers ​

All exports lists request and response types, WebSocket connection keys and helpers. Spot responses may carry data or tick; derivatives endpoints can use different envelopes. Read the return type of the specific method you call.

The clients handle signatures, connection recovery and message decompression. Transport helpers are also exported for custom integrations.

Choose a client · Configuration · Error handling

Built by Siebly. Open source SDKs for exchange APIs.