Skip to content

Class: WebsocketAPIClient ​

Promise-based wrapper around WebsocketClient for HTX Spot and derivatives trading commands. The wrapper selects the connection for each method and handles authentication.

Constructors ​

Constructor ​

ts
new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;

Parameters ​

ParameterType
options?WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>
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 ​

WebsocketAPIClient

Methods ​

cancelAllCoinDeliveryOrders() ​

ts
cancelAllCoinDeliveryOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>


cancelAllCoinSwapOrders() ​

ts
cancelAllCoinSwapOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>


cancelAllLinearSwapCrossOrders() ​

ts
cancelAllLinearSwapCrossOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancelall">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancelall">>


cancelAllLinearSwapOrders() ​

ts
cancelAllLinearSwapOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>


cancelAllLinearSwapV5Orders() ​

ts
cancelAllLinearSwapV5Orders(params: WSAPIDerivativesV5CancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesV5CancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders">>


cancelAllSpotOrders() ​

ts
cancelAllSpotOrders(params: WSAPISpotCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPISpotCancelAllOrdersResult, "cancelall">>;

Parameters ​

ParameterType
paramsWSAPISpotCancelAllOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPISpotCancelAllOrdersResult, "cancelall">>


cancelCoinDeliveryOrder() ​

ts
cancelCoinDeliveryOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>


cancelCoinSwapOrder() ​

ts
cancelCoinSwapOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>


cancelLinearSwapCrossOrder() ​

ts
cancelLinearSwapCrossOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancel">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancel">>


cancelLinearSwapOrder() ​

ts
cancelLinearSwapOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesCancelOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>


cancelLinearSwapV5BatchOrders() ​

ts
cancelLinearSwapV5BatchOrders(params: WSAPIDerivativesV5CancelOrderParams[]): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesV5CancelOrderParams[]

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders">>


cancelLinearSwapV5Order() ​

ts
cancelLinearSwapV5Order(params: WSAPIDerivativesV5CancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesV5CancelOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_order">>


cancelSpotOrders() ​

ts
cancelSpotOrders(params: WSAPISpotCancelOrdersParams): Promise<WSAPIBaseResponse<WSAPISpotCancelOrdersResult, "cancel">>;

Parameters ​

ParameterType
paramsWSAPISpotCancelOrdersParams

Returns ​

Promise<WSAPIBaseResponse<WSAPISpotCancelOrdersResult, "cancel">>


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Returns ​

string


getOrderIdPrefix() ​

ts
getOrderIdPrefix(): string;

Returns ​

string


getWSClient() ​

ts
getWSClient(): WebsocketClient;

Returns ​

WebsocketClient


placeLinearSwapBatchOrders() ​

ts
placeLinearSwapBatchOrders(params: WSAPIDerivativesBatchPlaceOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesBatchPlaceOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders">>


placeLinearSwapOrder() ​

ts
placeLinearSwapOrder(params: WSAPIDerivativesPlaceOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "place_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesPlaceOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "place_order">>


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void


submitCoinDeliveryBatchOrders() ​

ts
submitCoinDeliveryBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesBatchOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>


submitCoinDeliveryOrder() ​

ts
submitCoinDeliveryOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>


submitCoinSwapBatchOrders() ​

ts
submitCoinSwapBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesBatchOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>


submitCoinSwapOrder() ​

ts
submitCoinSwapOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>


submitLinearSwapBatchOrders() ​

ts
submitLinearSwapBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesBatchOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>


submitLinearSwapCrossBatchOrders() ​

ts
submitLinearSwapCrossBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesBatchOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder">>


submitLinearSwapCrossOrder() ​

ts
submitLinearSwapCrossOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_cross_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_cross_order">>


submitLinearSwapOrder() ​

ts
submitLinearSwapOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;

Parameters ​

ParameterType
paramsWSAPIDerivativesOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>


submitSpotBatchOrders() ​

ts
submitSpotBatchOrders(params: WSAPISpotBatchOrderParams): Promise<WSAPIBaseResponse<WSAPISpotOrderResult[], "create-batchorder">>;

Parameters ​

ParameterType
paramsWSAPISpotBatchOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPISpotOrderResult[], "create-batchorder">>


submitSpotMarginOrder() ​

ts
submitSpotMarginOrder(params: WSAPISpotMarginOrderParams): Promise<WSAPIBaseResponse<WSAPISpotOrderResult, "create-margin-order">>;

Parameters ​

ParameterType
paramsWSAPISpotMarginOrderParams

Returns ​

Promise<WSAPIBaseResponse<WSAPISpotOrderResult, "create-margin-order">>


submitSpotOrder() ​

ts
submitSpotOrder(params: WSAPISpotOrderParams): Promise<WSAPIBaseResponse<string | WSAPISpotOrderResult, "create-order">>;

Parameters ​

ParameterType
paramsWSAPISpotOrderParams

Returns ​

Promise<WSAPIBaseResponse<string | WSAPISpotOrderResult, "create-order">>

See ​

Submit a Spot WebSocket order

Built by Siebly. Open source SDKs for exchange APIs.