Interface: WSClientConfigurableOptions
General configuration for the WebsocketClient
Extended by
Properties
| Property | Type | Description |
|---|---|---|
apiKey? | string | Your API key |
apiSecret? | string | Your API secret |
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. |
pingInterval? | number | How often to check if the connection is alive |
pongTimeout? | number | How long to wait for a pong (heartbeat reply) before assuming the connection is dead |
reauthWSAPIOnReconnect? | boolean | Reconnect authentication option in the WebSocket client configuration. Kraken Spot attaches authentication to individual requests. |
reconnectTimeout? | number | Delay in milliseconds before respawning the connection |
recvWindow? | number | Receive-window option in the WebSocket client configuration. |
requestOptions? | AxiosRequestConfig<any> | - |
restOptions? | RestClientOptions | - |
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. |
wsOptions? | { protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">) | - |
wsUrl? | string | - |