HTX Derivatives JavaScript SDK example: wsAPI.RAW.ts
HTX Derivatives websocket API RAW JavaScript example for the Siebly HTX SDK, covering exchange REST API and WebSocket integration, setup, and production SDK docs.
We use environment variables in our examples for API keys. It is your responsibility to manage and secure your keys appropriately.
examples/HTX/Derivatives/WebSockets/wsAPI.RAW.ts
What this example covers
- HTX WebSocket stream JavaScript example.
- Uses the Siebly HTX SDK package
@siebly/htx-apiinstead of hand-written WebSocket plumbing. - Source path:
HTX/Derivatives/WebSockets/wsAPI.RAW.ts. - Example category: Derivatives.
- Imports SDK symbols including
DefaultLogger,WebsocketClient,WS_KEY_MAP. - Calls SDK methods such as
sendWSAPIRequest().
How to use this example
- Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
- For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
- Open the repository source when you need the latest committed version: GitHub source file.
// Raw low-level WS API example using WebsocketClient.sendWSAPIRequest().// Prefer WebsocketAPIClient for typed wrapper methods. import { DefaultLogger, LogParams, WebsocketClient, WS_KEY_MAP,} from '@siebly/htx-api'; const customLogger: DefaultLogger = { // eslint-disable-next-line @typescript-eslint/no-unused-vars trace: (...params: LogParams): void => { // console.log('trace', ...params); }, info: (...params: LogParams): void => { console.log('info', ...params); }, error: (...params: LogParams): void => { console.error('error', ...params); },}; async function start() { const account = { key: process.env.API_FUTURES_KEY || 'keyHere', secret: process.env.API_FUTURES_SECRET || 'secretHere', }; const client = new WebsocketClient( { apiKey: account.key, apiSecret: account.secret, }, customLogger, ); client .on('open', (data) => console.log('open:', data.wsKey)) .on('authenticated', (data) => console.log('authenticated:', data.wsKey)) .on('response', (data) => console.info('response:', JSON.stringify(data))) .on('exception', (data) => console.error('exception:', data)); const runLiveTradingExamples = false; if (!runLiveTradingExamples) { console.log('Set runLiveTradingExamples=true after reviewing the params.'); return; } const linearPlaceOrder = await client.sendWSAPIRequest( WS_KEY_MAP.linearSwapTrade, 'place_order', { contract_code: 'BTC-USDT', margin_mode: 'cross', position_side: 'long', side: 'buy', type: 'limit', time_in_force: 'gtc', price: '20000', volume: '1', reduce_only: 0, }, ); console.log('linear place_order:', linearPlaceOrder); const deliveryCreateOrder = await client.sendWSAPIRequest( WS_KEY_MAP.coinDeliveryTrade, 'create_order', { contract_code: 'BTC-USD', direction: 'buy', offset: 'open', price: '20000', lever_rate: 5, volume: 1, order_price_type: 'limit', }, ); console.log('delivery create_order:', deliveryCreateOrder); const coinSwapCreateOrder = await client.sendWSAPIRequest( WS_KEY_MAP.coinSwapTrade, 'create_order', { contract_code: 'BTC-USD', direction: 'buy', offset: 'open', price: '20000', lever_rate: 5, volume: 1, order_price_type: 'limit', }, ); console.log('coin swap create_order:', coinSwapCreateOrder);} start();