The single WebSocket channel for a given asset-class host. After the
connection is established the client publishes `login` and `subscribe`
(and optionally `unsubscribe`) control events, and the server publishes
a continuous stream of quote / trade messages for the subscribed tickers.
Client-sent control events (login, subscribe, unsubscribe).
subscribe
receiveMarketMessage
Server-pushed real-time market data messages.
Messages
LoginEvent
Authenticates the WebSocket connection with the account API key.
Content-Type: application/json
SubscribeEvent
Subscribes the connection to one or more tickers.
Content-Type: application/json
UnsubscribeEvent
Unsubscribes the connection from one or more tickers.
Content-Type: application/json
MarketMessage
A trade, quote, or trade-break message for a subscribed ticker.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.