Skip to content

Class: WebsocketAPIClient ​

Promise-based wrapper for the OKX WebSocket trading API. Use its methods to await trading responses, or call WebsocketClient.sendWSAPIRequest() directly. For order placement and cancellation, use instIdCode.

Constructors ​

Constructor ​

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

Parameters ​

ParameterTypeDescription
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) => voidPing/pong events and other raw messages that might be noisy. Enable this while troubleshooting.

Returns ​

WebsocketAPIClient

Methods ​

amendMultipleOrders() ​

ts
amendMultipleOrders(params: WSAPIAmendOrderRequestV5[]): Promise<WSAPIResponse<[OrderResult], "batch-amend-orders">>;

Amend multiple orders

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders

Parameters ​

ParameterType
paramsWSAPIAmendOrderRequestV5[]

Returns ​

Promise<WSAPIResponse<[OrderResult], "batch-amend-orders">>


amendOrder() ​

ts
amendOrder(params: WSAPIAmendOrderRequestV5): Promise<WSAPIResponse<[OrderResult], "amend-order">>;

Amend a single order

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order

Parameters ​

ParameterType
paramsWSAPIAmendOrderRequestV5

Returns ​

Promise<WSAPIResponse<[OrderResult], "amend-order">>


amendSpreadOrder() ​

ts
amendSpreadOrder(params: WSAPIAmendSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadAmendOrderResultV5], "sprd-amend-order">>;

Amend a spread order

https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order

Parameters ​

ParameterType
paramsWSAPIAmendSpreadOrderRequestV5

Returns ​

Promise<WSAPIResponse<[WSAPISpreadAmendOrderResultV5], "sprd-amend-order">>


cancelMultipleOrders() ​

ts
cancelMultipleOrders(params: OrderIdRequest[]): Promise<WSAPIResponse<WSAPICancelOrderResultV5[], "batch-cancel-orders">>;

Cancel multiple orders

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders

Parameters ​

ParameterType
paramsOrderIdRequest[]

Returns ​

Promise<WSAPIResponse<WSAPICancelOrderResultV5[], "batch-cancel-orders">>


cancelOrder() ​

ts
cancelOrder(params: OrderIdRequest): Promise<WSAPIResponse<[WSAPICancelOrderResultV5], "cancel-order">>;

Cancel a single order

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order

Parameters ​

ParameterType
paramsOrderIdRequest

Returns ​

Promise<WSAPIResponse<[WSAPICancelOrderResultV5], "cancel-order">>


cancelSpreadOrder() ​

ts
cancelSpreadOrder(params: WSAPICancelSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadCancelOrderResultV5], "sprd-cancel-order">>;

Cancel a spread order

https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order

Parameters ​

ParameterType
paramsWSAPICancelSpreadOrderRequestV5

Returns ​

Promise<WSAPIResponse<[WSAPISpreadCancelOrderResultV5], "sprd-cancel-order">>


connectWSAPI() ​

ts
connectWSAPI(): Promise<unknown[]>;

Open and authenticate the underlying WebSocket API connections before the first command. Optional: command methods also prepare connections automatically.

Returns ​

Promise<unknown[]>


getWSClient() ​

ts
getWSClient(): WebsocketClient;

Returns ​

WebsocketClient


massCancelOrders() ​

ts
massCancelOrders(params: WSAPIMassCancelOrdersRequestV5): Promise<WSAPIResponse<[{
  result: boolean;
}], "mass-cancel">>;

Mass cancel orders

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order

Parameters ​

ParameterType
paramsWSAPIMassCancelOrdersRequestV5

Returns ​

Promise<WSAPIResponse<[{ result: boolean; }], "mass-cancel">>


massCancelSpreadOrders() ​

ts
massCancelSpreadOrders(params: WSAPISpreadMassCancelOrdersRequestV5): Promise<WSAPIResponse<[{
  result: boolean;
}], "sprd-mass-cancel">>;

Mass cancel spread orders

https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders

Parameters ​

ParameterType
paramsWSAPISpreadMassCancelOrdersRequestV5

Returns ​

Promise<WSAPIResponse<[{ result: boolean; }], "sprd-mass-cancel">>


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void


submitMultipleOrders() ​

ts
submitMultipleOrders(params: WSAPIPlaceOrderRequestV5[]): Promise<WSAPIResponse<OrderResult[], "batch-orders">>;

Submit multiple orders in a batch

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders

Parameters ​

ParameterType
paramsWSAPIPlaceOrderRequestV5[]

Returns ​

Promise<WSAPIResponse<OrderResult[], "batch-orders">>


submitNewOrder() ​

ts
submitNewOrder(params: WSAPIPlaceOrderRequestV5): Promise<WSAPIResponse<[OrderResult], "order">>;

Submit a new order

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order

Parameters ​

ParameterType
paramsWSAPIPlaceOrderRequestV5

Returns ​

Promise<WSAPIResponse<[OrderResult], "order">>

See ​

WebSocket API requests


submitSpreadOrder() ​

ts
submitSpreadOrder(params: WSAPIPlaceSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], "sprd-order">>;

Submit a new spread order

https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order

Parameters ​

ParameterType
paramsWSAPIPlaceSpreadOrderRequestV5

Returns ​

Promise<WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], "sprd-order">>

Built by Siebly. Open source SDKs for exchange APIs.