Interface: WSClientConfigurableOptions
General configuration for the WebsocketClient
Extended by
Properties
| Property | Type | Description |
|---|---|---|
apiKey? | string | Your API key |
apiPass? | string | The passphrase you set when creating the API Key (NOT your account password) |
apiSecret? | string | Your API secret |
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? | boolean | Set to true to use Bitget demo WebSocket endpoints. Use demo API credentials. See the Classic V2 and UTA V3 demo references. |
disableHeartbeat? | boolean | - |
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 |
reconnectTimeout? | number | Delay in milliseconds before respawning the connection |
recvWindow? | number | Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds |
requestOptions? | RestClientOptions | - |
wsOptions? | { protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">) | - |
wsUrl? | string | - |