Interface: WebsocketClientOptions
WS configuration that's always defined, regardless of user configuration (usually comes from defaults if there's no user-provided values)
Extends
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
apiKey? | string | Your API key name. - For the Advanced Trade or App APIs, this is your API Key Name. | - | WSClientConfigurableOptions.apiKey |
apiPassphrase? | string | Your API passphrase (NOT your account password). Only used for the API groups that use an API passphrase: - Coinbase Exchange API - Coinbase International API - Coinbase Prime API | - | WSClientConfigurableOptions.apiPassphrase |
apiSecret? | string | API signing secret for the selected product. For CDP authentication, pass the complete private key, including its original PEM header, footer and newlines when applicable. | - | WSClientConfigurableOptions.apiSecret |
authPrivateConnectionsOnConnect | boolean | - | - | - |
authPrivateRequests | boolean | - | - | - |
customSignMessageFn? | (message: string, secret: string) => Promise<string> | Custom signing callback option in the WebSocket client configuration. | - | WSClientConfigurableOptions.customSignMessageFn |
jwtExpiresSeconds? | number | For JWT auth (adv trade & app API), seconds until jwt expires. Defaults to 120 seconds. | - | WSClientConfigurableOptions.jwtExpiresSeconds |
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 | If you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason. | WSClientConfigurableOptions.reauthWSAPIOnReconnect | - |
reconnectTimeout | number | Delay in milliseconds before respawning the connection | WSClientConfigurableOptions.reconnectTimeout | - |
recvWindow | number | - | - | - |
requireConnectionReadyConfirmation | boolean | If true, require a "receipt" that the connection is ready for use (e.g. a specific event type) | - | - |
useSandbox | boolean | Connect to the sandbox for supported products - Coinbase Exchange: https://docs.cdp.coinbase.com/exchange/docs/sandbox - Coinbase International: https://docs.cdp.coinbase.com/intx/docs/sandbox - Coinbase Advanced Trade: No WebSocket sandbox (REST static sandbox only via RestClientOptions.useSandbox). - Coinbase App: No sandbox available. - Coinbase Prime: No sandbox available. | WSClientConfigurableOptions.useSandbox | - |
wsAPITimeout? | number | Time in milliseconds to wait for a Global WS API reply after sending. Default: 10000. Connection/authentication use their own lifecycle handling. | - | WSClientConfigurableOptions.wsAPITimeout |
wsOptions? | { protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">) | - | - | WSClientConfigurableOptions.wsOptions |
wsUrl? | string | - | - | WSClientConfigurableOptions.wsUrl |