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
new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;Parameters
| Parameter | Type |
|---|---|
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()
cancelAllCoinDeliveryOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>
cancelAllCoinSwapOrders()
cancelAllCoinSwapOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>
cancelAllLinearSwapCrossOrders()
cancelAllLinearSwapCrossOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancelall">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancelall">>
cancelAllLinearSwapOrders()
cancelAllLinearSwapOrders(params: WSAPIDerivativesCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancelall">>
cancelAllLinearSwapV5Orders()
cancelAllLinearSwapV5Orders(params: WSAPIDerivativesV5CancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesV5CancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_all_orders">>
cancelAllSpotOrders()
cancelAllSpotOrders(params: WSAPISpotCancelAllOrdersParams): Promise<WSAPIBaseResponse<WSAPISpotCancelAllOrdersResult, "cancelall">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPISpotCancelAllOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPISpotCancelAllOrdersResult, "cancelall">>
cancelCoinDeliveryOrder()
cancelCoinDeliveryOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>
cancelCoinSwapOrder()
cancelCoinSwapOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>
cancelLinearSwapCrossOrder()
cancelLinearSwapCrossOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancel">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cross_cancel">>
cancelLinearSwapOrder()
cancelLinearSwapOrder(params: WSAPIDerivativesCancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesCancelOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "cancel">>
cancelLinearSwapV5BatchOrders()
cancelLinearSwapV5BatchOrders(params: WSAPIDerivativesV5CancelOrderParams[]): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesV5CancelOrderParams[] |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "cancel_batch_orders">>
cancelLinearSwapV5Order()
cancelLinearSwapV5Order(params: WSAPIDerivativesV5CancelOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesV5CancelOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "cancel_order">>
cancelSpotOrders()
cancelSpotOrders(params: WSAPISpotCancelOrdersParams): Promise<WSAPIBaseResponse<WSAPISpotCancelOrdersResult, "cancel">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPISpotCancelOrdersParams |
Returns
Promise<WSAPIBaseResponse<WSAPISpotCancelOrdersResult, "cancel">>
generateNewOrderID()
generateNewOrderID(): string;Returns
string
getOrderIdPrefix()
getOrderIdPrefix(): string;Returns
string
getWSClient()
getWSClient(): WebsocketClient;Returns
placeLinearSwapBatchOrders()
placeLinearSwapBatchOrders(params: WSAPIDerivativesBatchPlaceOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesBatchPlaceOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult[], "place_batch_orders">>
placeLinearSwapOrder()
placeLinearSwapOrder(params: WSAPIDerivativesPlaceOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "place_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesPlaceOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesV5OrderResult, "place_order">>
setTimeOffsetMs()
setTimeOffsetMs(newOffset: number): void;Parameters
| Parameter | Type |
|---|---|
newOffset | number |
Returns
void
submitCoinDeliveryBatchOrders()
submitCoinDeliveryBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesBatchOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>
submitCoinDeliveryOrder()
submitCoinDeliveryOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>
submitCoinSwapBatchOrders()
submitCoinSwapBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesBatchOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>
submitCoinSwapOrder()
submitCoinSwapOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>
submitLinearSwapBatchOrders()
submitLinearSwapBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesBatchOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_batchorder">>
submitLinearSwapCrossBatchOrders()
submitLinearSwapCrossBatchOrders(params: WSAPIDerivativesBatchOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesBatchOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult[], "create_cross_batchorder">>
submitLinearSwapCrossOrder()
submitLinearSwapCrossOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_cross_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_cross_order">>
submitLinearSwapOrder()
submitLinearSwapOrder(params: WSAPIDerivativesOrderParams): Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPIDerivativesOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPIDerivativesOrderResult, "create_order">>
submitSpotBatchOrders()
submitSpotBatchOrders(params: WSAPISpotBatchOrderParams): Promise<WSAPIBaseResponse<WSAPISpotOrderResult[], "create-batchorder">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPISpotBatchOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPISpotOrderResult[], "create-batchorder">>
submitSpotMarginOrder()
submitSpotMarginOrder(params: WSAPISpotMarginOrderParams): Promise<WSAPIBaseResponse<WSAPISpotOrderResult, "create-margin-order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPISpotMarginOrderParams |
Returns
Promise<WSAPIBaseResponse<WSAPISpotOrderResult, "create-margin-order">>
submitSpotOrder()
submitSpotOrder(params: WSAPISpotOrderParams): Promise<WSAPIBaseResponse<string | WSAPISpotOrderResult, "create-order">>;Parameters
| Parameter | Type |
|---|---|
params | WSAPISpotOrderParams |
Returns
Promise<WSAPIBaseResponse<string | WSAPISpotOrderResult, "create-order">>