Single WebSocket endpoint. Clients send a subscribe action specifying the order book and channel type, and receive a stream of envelope messages tagged with type and book, plus periodic keep-alive frames.
Receive subscription acks, channel messages, and keep-alives.
Messages
Subscribe
Sent by the client after the connection opens to subscribe to a channel for a specific order book.
Content-Type:
SubscribeAck
Server confirmation that a subscription was accepted.
Content-Type:
KeepAlive
Periodic server keep-alive message.
Content-Type:
TradesMessage
Emitted whenever the matching engine executes a trade in the subscribed order book.
Content-Type:
OrdersMessage
Snapshot-style update of the top 20 bids and asks for the subscribed book. Emitted when the top of book changes.
Content-Type:
DiffOrdersMessage
Incremental order-book change (new order, modification, cancellation, or partial fill). Includes a sequence number so clients can detect dropped messages and resync.
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.
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.