Skip to content

Class: WebsocketAPIClient ​

Promise-based wrapper for KuCoin WebSocket API order commands. Connections and authentication are handled as needed. Use getWSClient() for lifecycle events and shutdown. This release has no supported testnet constructor option; commands use live services.

Constructors ​

Constructor ​

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

Parameters ​

ParameterType
options?WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>
logger?{ error: (...params: any) => void; info: (...params: any) => void; trace: (..._params: any) => void; }
logger.error?(...params: any) => void
logger.info?(...params: any) => void
logger.trace?(..._params: any) => void

Returns ​

WebsocketAPIClient

Methods ​

amendFuturesOrder() ​

ts
amendFuturesOrder(params: AmendOrderRequestUTA, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<AmendOrderResponseUTA, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Amend a UTA futures order. Futures only (op: uta.amend).

Parameters ​

ParameterType
paramsAmendOrderRequestUTA
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<AmendOrderResponseUTA, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


cancelFuturesOrder() ​

ts
cancelFuturesOrder(params: 
  | {
  orderId: string;
}
  | {
  clientOid: string;
  symbol: string;
}, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<
  | {
  cancelledOrderIds: string[];
}
  | {
  clientOid: string;
}, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Cancel a futures order

Parameters ​

ParameterType
params| { orderId: string; } | { clientOid: string; symbol: string; }
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse< | { cancelledOrderIds: string[]; } | { clientOid: string; }, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


cancelMarginOrder() ​

ts
cancelMarginOrder(params: WSAPICancelOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<WSAPIOrderResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Cancel a margin order

Parameters ​

ParameterType
paramsWSAPICancelOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<WSAPIOrderResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


cancelMultipleFuturesOrders() ​

ts
cancelMultipleFuturesOrders(params: BatchCancelOrdersRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<BatchCancelOrderResult[], 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Cancel multiple futures orders

Parameters ​

ParameterType
paramsBatchCancelOrdersRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<BatchCancelOrderResult[], | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


cancelSpotOrder() ​

ts
cancelSpotOrder(params: WSAPICancelOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<WSAPIOrderResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Cancel a spot order

Parameters ​

ParameterType
paramsWSAPICancelOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<WSAPIOrderResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>

See ​

Send WebSocket API requests


cancelSyncSpotOrder() ​

ts
cancelSyncSpotOrder(params: WSAPICancelOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<SyncCancelHFOrderResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Cancel a sync spot order

Parameters ​

ParameterType
paramsWSAPICancelOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<SyncCancelHFOrderResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


connectWSAPI() ​

ts
connectWSAPI(wsKey: WSAPIWsKey): Promise<unknown>;

Private methods for handling some of the convenience/automation provided by the WS API Client

Parameters ​

ParameterType
wsKeyWSAPIWsKey

Returns ​

Promise<unknown>


getWSClient() ​

ts
getWSClient(): WebsocketClient;

Returns ​

WebsocketClient

See ​

Send WebSocket API requests


modifySpotOrder() ​

ts
modifySpotOrder(params: ModifyHFOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<{
  clientOid: string;
  newOrderId: string;
}, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Modify a spot order

Parameters ​

ParameterType
paramsModifyHFOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<{ clientOid: string; newOrderId: string; }, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>

See ​

Send WebSocket API requests


submitFuturesOrder() ​

ts
submitFuturesOrder(params: Order, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<WSAPIOrderResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Submit a futures order

Parameters ​

ParameterType
paramsOrder
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<WSAPIOrderResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


submitMarginOrder() ​

ts
submitMarginOrder(params: SubmitHFMarginOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<MarginSubmitOrderV3Response, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Submit a margin order

Parameters ​

ParameterType
paramsSubmitHFMarginOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<MarginSubmitOrderV3Response, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


submitMultipleFuturesOrders() ​

ts
submitMultipleFuturesOrders(params: Order[], wsKey?: WSAPIWsKey): Promise<WSAPIResponse<SubmitMultipleOrdersFuturesResponse[], 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Submit multiple futures orders

Parameters ​

ParameterType
paramsOrder[]
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<SubmitMultipleOrdersFuturesResponse[], | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>


submitNewSpotOrder() ​

ts
submitNewSpotOrder(params: SubmitHFOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<WSAPIOrderResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Submit a spot order

Parameters ​

ParameterType
paramsSubmitHFOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<WSAPIOrderResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>

See ​

Send WebSocket API requests


submitSyncSpotOrder() ​

ts
submitSyncSpotOrder(params: SubmitHFOrderRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<SubmitHFOrderSyncResponse, 
  | "ping"
  | "spot.order"
  | "spot.modify"
  | "spot.cancel"
  | "spot.sync_order"
  | "spot.sync_cancel"
  | "margin.order"
  | "margin.cancel"
  | "futures.order"
  | "futures.cancel"
  | "futures.multi_order"
  | "futures.multi_cancel"
| "uta.amend">>;

Submit a sync spot order

Parameters ​

ParameterType
paramsSubmitHFOrderRequest
wsKey?WSAPIWsKey

Returns ​

Promise<WSAPIResponse<SubmitHFOrderSyncResponse, | "ping" | "spot.order" | "spot.modify" | "spot.cancel" | "spot.sync_order" | "spot.sync_cancel" | "margin.order" | "margin.cancel" | "futures.order" | "futures.cancel" | "futures.multi_order" | "futures.multi_cancel" | "uta.amend">>

Built by Siebly. Open source SDKs for exchange APIs.