Skip to content

Interface: WSClientConfigurableOptions ​

General configuration for the WebsocketClient

Extended by ​

Properties ​

PropertyTypeDescription
apiKey?stringYour API key name. - For the Advanced Trade or App APIs, this is your API Key Name.
apiPassphrase?stringYour 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
apiSecret?stringAPI signing secret for the selected product. For CDP authentication, pass the complete private key, including its original PEM header, footer and newlines when applicable.
customSignMessageFn?(message: string, secret: string) => Promise<string>Custom signing callback option in the WebSocket client configuration.
jwtExpiresSeconds?numberFor JWT auth (adv trade & app API), seconds until jwt expires. Defaults to 120 seconds.
pingInterval?numberHow often to check if the connection is alive
pongTimeout?numberHow long to wait for a pong (heartbeat reply) before assuming the connection is dead
reauthWSAPIOnReconnect?booleanIf you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason.
reconnectTimeout?numberDelay in milliseconds before respawning the connection
useSandbox?booleanConnect 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.
wsAPITimeout?numberTime in milliseconds to wait for a Global WS API reply after sending. Default: 10000. Connection/authentication use their own lifecycle handling.
wsOptions?{ protocols?: string[] | undefined; agent?: any; } & (Omit<Partial<ClientOptions>, "agent"> | Omit<Partial<ClientRequestArgs>, "agent">)-
wsUrl?string-

Built by Siebly. Open source SDKs for exchange APIs.