Receive orderbook checkpoints and updates from the Orderbook Feed
Messages
getMarkets
Request the list of markets the server currently supports.
Content-Type:
orderbookSubscribe
Subscribe to orderbook updates for a market. subscriptionType=level yields L2 checkpoint plus per-side L2 deltas; subscriptionType=book yields L3 checkpoint plus per-side L3 additions/removals.
Content-Type:
orderbookUnsubscribe
Unsubscribe from orderbook updates for a given marketId.
Content-Type:
marketsList
Map of market pubkey -> market name returned in response to getMarkets.
Content-Type:
subscriptionAck
Server acknowledgement of a subscribe/unsubscribe command.
Content-Type:
orderbookL2Checkpoint
Initial L2 snapshot delivered immediately after an L2 subscription is accepted. Contains both sides of the book as [price, quantity] pairs.
Content-Type:
orderbookL2Update
Per-side L2 delta. Each entry in `update` is [price, quantity] where a quantity of 0 indicates a level removal.
Content-Type:
orderbookL3Checkpoint
Initial L3 snapshot delivered immediately after an L3 subscription is accepted. ownerPubkey is a Mango account for perp markets and an open orders account for spot markets.
Content-Type:
orderbookL3Update
Per-side L3 delta containing arrays of added and removed orders for a single side of the book.
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.