Interface: WebsocketClientOptions
Internal WebSocket configuration, combining required runtime defaults with optional user settings.
Extends
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
apiKey? | string | Your API key | - | WSClientConfigurableOptions.apiKey |
apiSecret? | string | Your API secret | - | WSClientConfigurableOptions.apiSecret |
authPrivateConnectionsOnConnect | boolean | - | - | - |
authPrivateRequests | boolean | - | - | - |
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 |
pingInterval | number | How often to check if the connection is alive | WSClientConfigurableOptions.pingInterval | - |
pongTimeout | number | How long to wait for a pong (heartbeat reply) before assuming the connection is dead | WSClientConfigurableOptions.pongTimeout | - |
reauthWSAPIOnReconnect | boolean | Reconnect authentication option in the WebSocket client configuration. Kraken Spot attaches authentication to individual requests. | WSClientConfigurableOptions.reauthWSAPIOnReconnect | - |
reconnectTimeout | number | Delay in milliseconds before respawning the connection | WSClientConfigurableOptions.reconnectTimeout | - |
recvWindow | number | Receive-window option in the WebSocket client configuration. | WSClientConfigurableOptions.recvWindow | - |
requestOptions? | AxiosRequestConfig<any> | - | - | WSClientConfigurableOptions.requestOptions |
requireConnectionReadyConfirmation | boolean | If true, require a "receipt" that the connection is ready for use (e.g. a specific event type) | - | - |
restOptions? | RestClientOptions | - | - | WSClientConfigurableOptions.restOptions |
testnet? | boolean | Setting 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 |
useNativeHeartbeats | boolean | Attach 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 |