Skip to main content

Module client

Module client 

Source
Expand description

CoinAPI WebSocket V1 connection with whole-scope replacement and replay.

CoinAPI has no subscription acknowledgements. The connection authenticates through the X-CoinAPI-Key upgrade header, and the server validates it when the first hello arrives. A heartbeat or accepted data frame confirms the session and its subscriptions; an error frame is terminal and retires the connection instead of reconnecting.

A server reconnect notice is only logged. Reconnecting early would open a second connection while the old one is open, which a one-connection tier rejects; the server’s close triggers the normal reconnect instead.

Structs§

CoinApiWebSocketClient
Authenticated, data-only CoinAPI WebSocket client using one connection.
CoinApiWebSocketConfig
Transport configuration for the raw WebSocket client.

Constants§

WS_URL
Primary CoinAPI Market Data WebSocket V1 endpoint.