Skip to content

Class: WebsocketClient ​

Extends ​

Constructors ​

Constructor ​

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

Parameters ​

ParameterTypeDescription
options?WSClientConfigurableOptions-
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 ​

WebsocketClient

Properties ​

logger ​

ts
logger: object;

error ​

ts
error: (...params: any) => void;
Parameters ​
ParameterType
...paramsany
Returns ​

void

info ​

ts
info: (...params: any) => void;
Parameters ​
ParameterType
...paramsany
Returns ​

void

trace ​

ts
trace: (..._params: any) => void;

Ping/pong events and other raw messages that might be noisy. Enable this while troubleshooting.

Parameters ​
ParameterType
..._paramsany
Returns ​

void

Methods ​

assertIsAuthenticated() ​

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

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

Parameters ​

ParameterType
wsKeyWsKey
skipPublicWsKeyCheckboolean

Returns ​

Promise<unknown>


assertIsConnected() ​

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

Promise-driven method to assert that a ws has successfully connected (will await until connection is open)

Parameters ​

ParameterType
wsKeyWsKey

Returns ​

Promise<unknown>


close() ​

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

Parameters ​

ParameterType
wsKeyWsKey
force?boolean

Returns ​

void


closeAll() ​

ts
closeAll(force?: boolean): void;

Parameters ​

ParameterType
force?boolean

Returns ​

void

See ​

Shut down cleanly


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>


connectAll() ​

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

Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library

Returns ​

Promise<WSConnectedResult | undefined>[]


connectPrivate() ​

ts
connectPrivate(businessEndpoint?: boolean): Promise<WSConnectedResult | undefined>;

Parameters ​

ParameterType
businessEndpoint?boolean

Returns ​

Promise<WSConnectedResult | undefined>


connectPublic() ​

ts
connectPublic(businessEndpoint?: boolean): Promise<WSConnectedResult | undefined>;

Parameters ​

ParameterType
businessEndpoint?boolean

Returns ​

Promise<WSConnectedResult | undefined>


connectWSAPI() ​

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

Ensures the WS API connection is active and ready.

You do not need to call this, but if you call this before making any WS API requests, it can accelerate the first request (by preparing the connection in advance).

Returns ​

Promise<unknown[]>


emit() ​

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

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<WsKey, WsDataEvent<any>>

Parameters ​

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

Returns ​

boolean


executeReconnectableClose() ​

ts
executeReconnectableClose(wsKey: WsKey, reason: string): void;

Closes a connection, if it's even open. If open, this will trigger a reconnect asynchronously. If closed, trigger a reconnect immediately

Parameters ​

ParameterType
wsKeyWsKey
reasonstring

Returns ​

void


getCachedMidFlightRequest() ​

ts
getCachedMidFlightRequest(wsKey: WsKey, requestKey: string): 
  | WsRequestOperationOKX<object>
  | undefined;

Parameters ​

ParameterType
wsKeyWsKey
requestKeystring

Returns ​

| WsRequestOperationOKX<object> | undefined


getMarketWsKey() ​

ts
getMarketWsKey(type: "private" | "business"): WsKey;

Internal methods required to integrate with the BaseWSClient

Parameters ​

ParameterType
type"private" | "business"

Returns ​

WsKey


getTimeOffsetMs() ​

ts
getTimeOffsetMs(): number;

Returns ​

number


getWsStore() ​

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

Get the WsStore that tracks websockets & topics

Returns ​

WsStore<WsKey, WsTopicRequest<string, unknown>>


isConnected() ​

ts
isConnected(wsKey: WsKey): boolean;

Parameters ​

ParameterType
wsKeyWsKey

Returns ​

boolean


on() ​

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

Type Parameters ​

Type Parameter
U extends keyof WSClientEventMap<WsKey, WsDataEvent<any>>

Parameters ​

ParameterType
eventU
listenerWSClientEventMap<WsKey, any>[U]

Returns ​

this


removeCachedMidFlightRequest() ​

ts
removeCachedMidFlightRequest(wsKey: WsKey, requestKey: string): void;

Parameters ​

ParameterType
wsKeyWsKey
requestKeystring

Returns ​

void


sendWSAPIRequest() ​

ts
sendWSAPIRequest<TWSKey extends keyof WsAPIWsKeyTopicMap, TWSOperation extends 
  | WSAPIPrivateOperations
  | WSAPIBusinessOperations, TWSParams extends 
  | OrderIdRequest
  | WSAPIPlaceOrderRequestV5
  | WSAPIAmendOrderRequestV5
  | WSAPIMassCancelOrdersRequestV5
  | WSAPIPlaceSpreadOrderRequestV5
  | WSAPIAmendSpreadOrderRequestV5
  | WSAPICancelSpreadOrderRequestV5
  | WSAPISpreadMassCancelOrdersRequestV5
  | WSAPIPlaceOrderRequestV5[]
  | OrderIdRequest[]
  | WSAPIAmendOrderRequestV5[], TWSAPIResponse extends 
  | WSAPIResponse<[OrderResult], "order">
  | WSAPIResponse<OrderResult[], "batch-orders">
  | WSAPIResponse<[WSAPICancelOrderResultV5], "cancel-order">
  | WSAPIResponse<WSAPICancelOrderResultV5[], "batch-cancel-orders">
  | WSAPIResponse<[OrderResult], "amend-order">
  | WSAPIResponse<[OrderResult], "batch-amend-orders">
  | WSAPIResponse<[{
  result: boolean;
}], "mass-cancel">
  | WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], "sprd-order">
  | WSAPIResponse<[WSAPISpreadAmendOrderResultV5], "sprd-amend-order">
  | WSAPIResponse<[WSAPISpreadCancelOrderResultV5], "sprd-cancel-order">
  | WSAPIResponse<[{
  result: boolean;
}], "sprd-mass-cancel"> = WsAPIOperationResponseMap[TWSOperation]>(
   rawWsKey: WsKey, 
   operation: TWSOperation, 
   params: TWSParams & object, 
   requestFlags?: WSAPIRequestFlags
): Promise<TWSAPIResponse>;

OKX supports order placement via WebSockets. This is the WS API: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order

For convenient promise-wrapped usage of the WS API, instance the WebsocketAPIClient class exported by this SDK.

For demo trading, set demoTrading:true in the WS Client config.

Type Parameters ​

Type ParameterDefault type
TWSKey extends keyof WsAPIWsKeyTopicMap-
TWSOperation extends | WSAPIPrivateOperations | WSAPIBusinessOperations-
TWSParams extends | OrderIdRequest | WSAPIPlaceOrderRequestV5 | WSAPIAmendOrderRequestV5 | WSAPIMassCancelOrdersRequestV5 | WSAPIPlaceSpreadOrderRequestV5 | WSAPIAmendSpreadOrderRequestV5 | WSAPICancelSpreadOrderRequestV5 | WSAPISpreadMassCancelOrdersRequestV5 | WSAPIPlaceOrderRequestV5[] | OrderIdRequest[] | WSAPIAmendOrderRequestV5[]-
TWSAPIResponse extends | WSAPIResponse<[OrderResult], "order"> | WSAPIResponse<OrderResult[], "batch-orders"> | WSAPIResponse<[WSAPICancelOrderResultV5], "cancel-order"> | WSAPIResponse<WSAPICancelOrderResultV5[], "batch-cancel-orders"> | WSAPIResponse<[OrderResult], "amend-order"> | WSAPIResponse<[OrderResult], "batch-amend-orders"> | WSAPIResponse<[{ result: boolean; }], "mass-cancel"> | WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], "sprd-order"> | WSAPIResponse<[WSAPISpreadAmendOrderResultV5], "sprd-amend-order"> | WSAPIResponse<[WSAPISpreadCancelOrderResultV5], "sprd-cancel-order"> | WSAPIResponse<[{ result: boolean; }], "sprd-mass-cancel">WsAPIOperationResponseMap[TWSOperation]

Parameters ​

ParameterType
rawWsKeyWsKey
operationTWSOperation
paramsTWSParams & object
requestFlags?WSAPIRequestFlags

Returns ​

Promise<TWSAPIResponse>

a promise that resolves/rejects when a matching response arrives


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void


subscribe() ​

ts
subscribe(wsEvents: 
  | WsChannelSubUnSubRequestArg
  | WsChannelSubUnSubRequestArg[], isPrivateTopic?: boolean): Promise<unknown>[];

Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.

Parameters ​

ParameterTypeDescription
wsEvents| WsChannelSubUnSubRequestArg | WsChannelSubUnSubRequestArg[]topic or list of topics
isPrivateTopic?booleanoptional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)

Returns ​

Promise<unknown>[]

See ​

Subscribe to public market data


tryWsSend() ​

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

Parameters ​

ParameterType
wsKeyWsKey
wsMessagestring
throwExceptions?boolean

Returns ​

void


unsubscribe() ​

ts
unsubscribe(wsEvents: 
  | WsChannelSubUnSubRequestArg
  | WsChannelSubUnSubRequestArg[], isPrivateTopic?: boolean): Promise<unknown>[];

Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.

Parameters ​

ParameterTypeDescription
wsEvents| WsChannelSubUnSubRequestArg | WsChannelSubUnSubRequestArg[]-
isPrivateTopic?booleanoptional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)

Returns ​

Promise<unknown>[]

Built by Siebly. Open source SDKs for exchange APIs.