Skip to content

Interface: WSClientConfigurableOptions ​

Extended by ​

Properties ​

PropertyTypeDescription
accounts?APICredentials[]-
customSignMessageFn?(message: string, secret: string) => Promise<string>Provide a custom signing function. The SDK passes the serialized signing payload and API secret to this function and uses its returned signature.
demoTrading?booleanSet to true to use OKX's demo trading functionality
disableHeartbeat?boolean-
market?APIMarketThe API group this client should connect to: - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com (WS same as GLOBAL) - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
pingInterval?numberHow often to check if the connection is alive
pongTimeout?numberHow long to wait for a pong (heartbeat reply) before assuming the connection is dead
reconnectTimeout?numberDelay in milliseconds before respawning the connection
requestOptions?RestClientOptions-
wsOptions?{ protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">)-
wsUrl?string-

Built by Siebly. Open source SDKs for exchange APIs.