Skip to content

Interface: WebsocketClientOptions ​

Internal WebSocket configuration, combining required runtime defaults with optional user settings.

Extends ​

Properties ​

PropertyTypeDescriptionOverridesInherited from
apiKey?stringYour API key-WSClientConfigurableOptions.apiKey
apiSecret?stringYour API secret-WSClientConfigurableOptions.apiSecret
authPrivateConnectionsOnConnectboolean---
authPrivateRequestsboolean---
customSignMessageFn?(message: string, secret: string) => Promise<string>Provide a signing callback. The SDK passes the signing message and secret to this function and uses its returned signature.-WSClientConfigurableOptions.customSignMessageFn
pingIntervalnumberHow often to check if the connection is aliveWSClientConfigurableOptions.pingInterval-
pongTimeoutnumberHow long to wait for a pong (heartbeat reply) before assuming the connection is deadWSClientConfigurableOptions.pongTimeout-
reauthWSAPIOnReconnectbooleanReconnect authentication option in the WebSocket client configuration. Kraken Spot attaches authentication to individual requests.WSClientConfigurableOptions.reauthWSAPIOnReconnect-
reconnectTimeoutnumberDelay in milliseconds before respawning the connectionWSClientConfigurableOptions.reconnectTimeout-
recvWindownumberReceive-window option in the WebSocket client configuration.WSClientConfigurableOptions.recvWindow-
requestOptions?AxiosRequestConfig<any>--WSClientConfigurableOptions.requestOptions
requireConnectionReadyConfirmationbooleanIf true, require a "receipt" that the connection is ready for use (e.g. a specific event type)--
restOptions?RestClientOptions--WSClientConfigurableOptions.restOptions
testnet?booleanSetting testnet to true throws when the SDK resolves a connection URL. Omit it or set it to false for live connections. Kraken retired its public Futures demo.-WSClientConfigurableOptions.testnet
useNativeHeartbeatsbooleanAttach listeners for native WebSocket ping/pong events when supported. This option does not select the outgoing ping format: Spot sends JSON ping requests, while Derivatives uses native ping frames.--
wsOptions?{ protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">)--WSClientConfigurableOptions.wsOptions
wsUrl?string--WSClientConfigurableOptions.wsUrl

Built by Siebly. Open source SDKs for exchange APIs.