Authenticate the session by sending your API key in a login event.
send
sendSubscribe
Subscribe to live price updates for tickers, or to a predefined market stream.
send
sendUnsubscribe
Stop receiving updates for a ticker or market stream.
receive
receiveQuote
Receive real-time quote updates for subscribed tickers/streams.
receive
receiveHeartbeat
Regular heartbeat events signal an active connection; use to auto-reconnect.
Messages
login
Authenticate with API key
Content-Type:
subscribe
Subscribe to tickers (tickers) or a market stream (stream)
Content-Type:
unsubscribe
Unsubscribe a ticker or market stream
Content-Type:
loginResponse
Login confirmation
Content-Type:
quote
Real-time quote update
Content-Type:
heartbeat
Connection heartbeat
Content-Type:
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.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.