Skip to content

Class: WebsocketClient ​

Client for HTX market subscriptions, private account updates and typed WebSocket trading requests.

Extends ​

Constructors ​

Constructor ​

ts
new WebsocketClient(options?: WSClientConfigurableOptions, logger?: object): WebsocketClient;

Parameters ​

ParameterType
options?WSClientConfigurableOptions
logger?{ error: (...params: LogParams) => void; info: (...params: LogParams) => void; trace: (..._params: LogParams) => void; }
logger.error?(...params: LogParams) => void
logger.info?(...params: LogParams) => void
logger.trace?(..._params: LogParams) => void

Returns ​

WebsocketClient

Overrides ​

BaseWebsocketClient<WsKey, HTXWSRequest | HTXWSAPIRawRequest>.constructor

Properties ​

defaultMaxListeners ​

ts
static defaultMaxListeners: number;

Inherited from ​

BaseWebsocketClient.defaultMaxListeners

Methods ​

addListener() ​

ts
addListener<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.addListener


assertIsAuthenticated() ​

ts
assertIsAuthenticated(wsKey: WsKey): Promise<unknown>;

Promise-driven method to assert that a ws has been successfully authenticated (will await until auth is confirmed)

Parameters ​

ParameterType
wsKeyWsKey

Returns ​

Promise<unknown>

Inherited from ​

BaseWebsocketClient.assertIsAuthenticated


close() ​

ts
close(wsKey: WsKey, force?: boolean): void;

Parameters ​

ParameterType
wsKeyWsKey
force?boolean

Returns ​

void

Inherited from ​

BaseWebsocketClient.close


closeAll() ​

ts
closeAll(force?: boolean): void;

Parameters ​

ParameterType
force?boolean

Returns ​

void

Inherited from ​

BaseWebsocketClient.closeAll


connect() ​

ts
connect(
   wsKey: WsKey, 
   customUrl?: string, 
   throwOnError?: boolean
): Promise<WSConnectedResult | undefined>;

Request connection to a specific websocket, instead of waiting for automatic connection.

Parameters ​

ParameterType
wsKeyWsKey
customUrl?string
throwOnError?boolean

Returns ​

Promise<WSConnectedResult | undefined>

Inherited from ​

BaseWebsocketClient.connect


connectAll() ​

ts
connectAll(): Promise<WSConnectedResult | undefined>[];

Request connection of all market/private sockets that are useful for subscriptions. Trade-command sockets are intentionally opened lazily by sendWSAPIRequest().

Returns ​

Promise<WSConnectedResult | undefined>[]

Overrides ​

BaseWebsocketClient.connectAll


connectWSAPI() ​

ts
connectWSAPI(wsKey?: keyof WSAPIWsKeyTopicMap, skipAuth?: boolean): Promise<unknown>;

Ensures a WS API connection is active and, unless skipped, authenticated.

Parameters ​

ParameterTypeDefault value
wsKey?keyof WSAPIWsKeyTopicMapWS_KEY_MAP.spotTrade
skipAuth?booleanundefined

Returns ​

Promise<unknown>


emit() ​

ts
emit<U extends keyof WSClientEventMap<TWSKey>>(event: U, ...args: Parameters<WSClientEventMap<WsKey>[U]>): boolean;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
...argsParameters<WSClientEventMap<WsKey>[U]>

Returns ​

boolean

Inherited from ​

BaseWebsocketClient.emit


eventNames() ​

ts
eventNames(): EventName[];

Returns ​

EventName[]

Inherited from ​

BaseWebsocketClient.eventNames


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Returns ​

string


getMaxListeners() ​

ts
getMaxListeners(): number;

Returns ​

number

Inherited from ​

BaseWebsocketClient.getMaxListeners


getOrderIdPrefix() ​

ts
getOrderIdPrefix(): string;

Returns ​

string


getTimeOffsetMs() ​

ts
getTimeOffsetMs(): number;

Returns ​

number

Inherited from ​

BaseWebsocketClient.getTimeOffsetMs


getWsStore() ​

ts
getWsStore(): WsStore<WsKey, WSTopicRequest<string, Record<string, unknown>>>;

Get the WsStore that tracks websockets & topics

Returns ​

WsStore<WsKey, WSTopicRequest<string, Record<string, unknown>>>

Inherited from ​

BaseWebsocketClient.getWsStore


isConnected() ​

ts
isConnected(wsKey: WsKey): boolean;

Parameters ​

ParameterType
wsKeyWsKey

Returns ​

boolean

Inherited from ​

BaseWebsocketClient.isConnected


listenerCount() ​

ts
listenerCount(event: keyof WSClientEventMap<TWSKey>, listener?: 
  | ((response: WSClientEventPayloadOrArray<WsKey>) => void)
  | ((evt: object) => void)
  | ((evt: object) => void)
  | ((response: WSClientEventPayloadOrArray<WsKey>) => void)
  | ((evt: object) => void)
  | ((evt: object) => void)
  | ((response: WSClientEventPayloadOrArray<WsKey>) => void)
  | ((event: WSClientEventPayload<WsKey>) => void)): number;

Parameters ​

ParameterType
eventkeyof WSClientEventMap<TWSKey>
listener?| ((response: WSClientEventPayloadOrArray<WsKey>) => void) | ((evt: object) => void) | ((evt: object) => void) | ((response: WSClientEventPayloadOrArray<WsKey>) => void) | ((evt: object) => void) | ((evt: object) => void) | ((response: WSClientEventPayloadOrArray<WsKey>) => void) | ((event: WSClientEventPayload<WsKey>) => void)

Returns ​

number

Inherited from ​

BaseWebsocketClient.listenerCount


listeners() ​

ts
listeners(event: keyof WSClientEventMap<TWSKey>): EventListener[];

Parameters ​

ParameterType
eventkeyof WSClientEventMap<TWSKey>

Returns ​

EventListener[]

Inherited from ​

BaseWebsocketClient.listeners


off() ​

ts
off<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.off


on() ​

ts
on<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.on


once() ​

ts
once<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.once


prependListener() ​

ts
prependListener<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.prependListener


prependOnceListener() ​

ts
prependOnceListener<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.prependOnceListener


rawListeners() ​

ts
rawListeners(eventName: EventName): EventListener[];

Parameters ​

ParameterType
eventNameEventName

Returns ​

EventListener[]

Inherited from ​

BaseWebsocketClient.rawListeners


removeAllListeners() ​

ts
removeAllListeners(event?: keyof WSClientEventMap<TWSKey>): this;

Parameters ​

ParameterType
event?keyof WSClientEventMap<TWSKey>

Returns ​

this

Inherited from ​

BaseWebsocketClient.removeAllListeners


removeListener() ​

ts
removeListener<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<TWSKey>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey>[U]

Returns ​

this

Inherited from ​

BaseWebsocketClient.removeListener


sendWSAPIRequest() ​

ts
sendWSAPIRequest<TWSKey extends keyof WSAPIWsKeyTopicMap, TWSOperation extends 
  | "cancel"
  | "create-order"
  | "create-batchorder"
  | "create-margin-order"
  | "cancelall"
  | "create_order"
  | "create_cross_order"
  | "create_batchorder"
  | "create_cross_batchorder"
  | "cross_cancel"
  | "cross_cancelall"
  | "place_order"
  | "place_batch_orders"
  | "cancel_order"
  | "cancel_batch_orders"
  | "cancel_all_orders", TWSParams extends 
  | WSAPISpotOrderParams & Record<never, never>
  | WSAPISpotMarginOrderParams & Record<never, never>
  | WSAPISpotCancelOrdersParams & Record<never, never>
  | WSAPISpotCancelAllOrdersParams & Record<never, never>
  | WSAPIDerivativesOrderParams & Record<never, never>
  | WSAPIDerivativesCancelOrderParams & Record<never, never>
  | WSAPIDerivativesCancelAllOrdersParams & Record<never, never>
  | WSAPIDerivativesPlaceOrderParams & Record<never, never>
  | WSAPIDerivativesV5CancelOrderParams & Record<never, never>
  | WSAPIDerivativesV5CancelAllOrdersParams & Record<never, never>
  | WSAPISpotBatchOrderParams & Record<never, never>
  | WSAPIDerivativesBatchOrderParams & Record<never, never>
  | WSAPIDerivativesBatchPlaceOrderParams & Record<never, never>
  | WSAPIDerivativesV5CancelOrderParams[] & Record<never, never>, TWSAPIResponse extends 
  | object
  | WSAPIResponse<string | WSAPISpotOrderResult, "create-order">
  | WSAPIResponse<WSAPISpotOrderResult[], "create-batchorder">
  | WSAPIResponse<WSAPISpotOrderResult, "create-margin-order">
  | WSAPIResponse<WSAPISpotCancelAllOrdersResult | WSAPIDerivativesOrderResult, "cancelall">
  | WSAPIResponse<WSAPISpotCancelOrdersResult | WSAPIDerivativesOrderResult, "cancel">
  | WSAPIResponse<WSAPIDerivativesOrderResult, "create_order">
  | WSAPIResponse<WSAPIDerivativesOrderResult, "create_cross_order">
  | WSAPIResponse<WSAPIDerivativesOrderResult[], "create_batchorder">
  | WSAPIResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder">
  | WSAPIResponse<WSAPIDerivativesOrderResult, "cross_cancel">
  | WSAPIResponse<WSAPIDerivativesOrderResult, "cross_cancelall">
  | WSAPIResponse<WSAPIDerivativesV5OrderResult, "place_order">
  | WSAPIResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders">
  | WSAPIResponse<WSAPIDerivativesV5OrderResult, "cancel_order">
  | WSAPIResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders">
  | WSAPIResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders"> = WSAPITopicResponseMap[TWSOperation]>(
   wsKey: TWSKey, 
   operation: TWSOperation, 
   params?: TWSParams, 
   requestFlags?: WSAPIRequestFlags
): Promise<TWSAPIResponse>;

Send a typed trading command on the selected connection. The SDK connects and authenticates unless authIsOptional is explicitly set. It generates signatures and a correlation ID. The promise resolves with the exchange reply or rejects on a recognized error or disconnect. Reconcile an uncertain trading outcome before retrying.

Type Parameters ​

Type ParameterDefault type
TWSKey extends keyof WSAPIWsKeyTopicMap-
TWSOperation extends | "cancel" | "create-order" | "create-batchorder" | "create-margin-order" | "cancelall" | "create_order" | "create_cross_order" | "create_batchorder" | "create_cross_batchorder" | "cross_cancel" | "cross_cancelall" | "place_order" | "place_batch_orders" | "cancel_order" | "cancel_batch_orders" | "cancel_all_orders"-
TWSParams extends | WSAPISpotOrderParams & Record<never, never> | WSAPISpotMarginOrderParams & Record<never, never> | WSAPISpotCancelOrdersParams & Record<never, never> | WSAPISpotCancelAllOrdersParams & Record<never, never> | WSAPIDerivativesOrderParams & Record<never, never> | WSAPIDerivativesCancelOrderParams & Record<never, never> | WSAPIDerivativesCancelAllOrdersParams & Record<never, never> | WSAPIDerivativesPlaceOrderParams & Record<never, never> | WSAPIDerivativesV5CancelOrderParams & Record<never, never> | WSAPIDerivativesV5CancelAllOrdersParams & Record<never, never> | WSAPISpotBatchOrderParams & Record<never, never> | WSAPIDerivativesBatchOrderParams & Record<never, never> | WSAPIDerivativesBatchPlaceOrderParams & Record<never, never> | WSAPIDerivativesV5CancelOrderParams[] & Record<never, never>-
TWSAPIResponse extends | object | WSAPIResponse<string | WSAPISpotOrderResult, "create-order"> | WSAPIResponse<WSAPISpotOrderResult[], "create-batchorder"> | WSAPIResponse<WSAPISpotOrderResult, "create-margin-order"> | WSAPIResponse<WSAPISpotCancelAllOrdersResult | WSAPIDerivativesOrderResult, "cancelall"> | WSAPIResponse<WSAPISpotCancelOrdersResult | WSAPIDerivativesOrderResult, "cancel"> | WSAPIResponse<WSAPIDerivativesOrderResult, "create_order"> | WSAPIResponse<WSAPIDerivativesOrderResult, "create_cross_order"> | WSAPIResponse<WSAPIDerivativesOrderResult[], "create_batchorder"> | WSAPIResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder"> | WSAPIResponse<WSAPIDerivativesOrderResult, "cross_cancel"> | WSAPIResponse<WSAPIDerivativesOrderResult, "cross_cancelall"> | WSAPIResponse<WSAPIDerivativesV5OrderResult, "place_order"> | WSAPIResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders"> | WSAPIResponse<WSAPIDerivativesV5OrderResult, "cancel_order"> | WSAPIResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders"> | WSAPIResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders">WSAPITopicResponseMap[TWSOperation]

Parameters ​

ParameterTypeDescription
wsKeyTWSKeyThe connection this event is for.
operationTWSOperation-
params?TWSParamsAny request parameters for the payload (contents of req_param in the docs). Signature generation is automatic, only send parameters such as order ID as per the docs.
requestFlags?WSAPIRequestFlags-

Returns ​

Promise<TWSAPIResponse>

Promise - tries to resolve with async WS API response. Rejects if disconnected or exception is seen in async WS API response

See ​

Send WebSocket trading requests

Overrides ​

BaseWebsocketClient.sendWSAPIRequest


setMaxListeners() ​

ts
setMaxListeners(count: number): this;

Parameters ​

ParameterType
countnumber

Returns ​

this

Inherited from ​

BaseWebsocketClient.setMaxListeners


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void

Inherited from ​

BaseWebsocketClient.setTimeOffsetMs


subscribe() ​

ts
subscribe(requests: 
  | string
  | WSTopicRequest<string, Record<string, unknown>>
  | (
  | string
  | WSTopicRequest<string, Record<string, unknown>>)[], wsKey: WsKey): void;

Subscribe to one or more channel strings or topic/payload objects on the specified connection key. Returns void; observe response, exception and message events to determine acceptance and data availability. Subscriptions are restored after reconnecting.

Parameters ​

ParameterType
requests| string | WSTopicRequest<string, Record<string, unknown>> | ( | string | WSTopicRequest<string, Record<string, unknown>>)[]
wsKeyWsKey

Returns ​

void

See ​

Subscribe to public market data


tryWsSend() ​

ts
tryWsSend(
   wsKey: WsKey, 
   wsMessage: string, 
   throwExceptions?: boolean
): void;

Parameters ​

ParameterType
wsKeyWsKey
wsMessagestring
throwExceptions?boolean

Returns ​

void

Inherited from ​

BaseWebsocketClient.tryWsSend


unsubscribe() ​

ts
unsubscribe(requests: 
  | string
  | WSTopicRequest<string, Record<string, unknown>>
  | (
  | string
  | WSTopicRequest<string, Record<string, unknown>>)[], wsKey: WsKey): void;

Remove one or more subscriptions from the specified connection and the reconnect subscription cache. Returns void.

Parameters ​

ParameterType
requests| string | WSTopicRequest<string, Record<string, unknown>> | ( | string | WSTopicRequest<string, Record<string, unknown>>)[]
wsKeyWsKey

Returns ​

void


validateOrderId() ​

ts
validateOrderId(params: 
  | SpotV1OrderPlaceReq
  | SpotV1OrderAutoPlaceReq, orderIdProperty: "client-order-id"): void;

Validate syntax meets requirements set by HTX. Log warning if not.

Parameters ​

ParameterType
params| SpotV1OrderPlaceReq | SpotV1OrderAutoPlaceReq
orderIdProperty"client-order-id"

Returns ​

void


listenerCount() ​

ts
static listenerCount(emitter: EventEmitterLike, eventName: EventName): number;

Parameters ​

ParameterType
emitterEventEmitterLike
eventNameEventName

Returns ​

number

Inherited from ​

BaseWebsocketClient.listenerCount

Built by Siebly. Open source SDKs for exchange APIs.