Single multiplexed WebSocket channel. Message type is carried in the type field. Since the feed contains all action reports, a client receives both its own initial action reports and subsequent fills against its resting limit orders.
Receive streamed orders, trades, cancels, top-of-book changes and exchange heartbeats.
Messages
action_report
Describes activity on the market, such as fills, cancels and limit order insertions onto the Central Limit Order Book. Status codes are catalogued in errors/ledgerx-error-codes.yml.
Content-Type:
book_top
Dispatched for a contract every time the best price on that contract changes.
Content-Type:
heartbeat
Sent roughly once per second. Indicates the exchange is running and, if any contracts are active, whether those markets are open for trading.
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.