API reference
The streaming API is defined by an AsyncAPI 3.0 contract.
- Fetch the contract:
/docs/asyncapi.yaml, served asapplication/yaml. Each connection'swelcomeframe advertises this URL. A client can connect, readwelcome.spec, and fetch the contract from there.
Channels
All channels multiplex over one connection to /ws.
| Channel | Access | Payload |
|---|---|---|
orderbook:<market> | public | L2 book (snapshot + deltas) |
ticker:<market> | public | last price, best bid/ask, 24h stats |
candles:<market>:<interval> | public | OHLCV (1s/1m/1h/1d) |
markets | public | instrument directory |
stats | public | health + liveness heartbeat |
orders | private | your order updates |
account | private | your balances |
deposits | private | your deposit status |
Client ops: subscribe / unsubscribe / submit (the write path) / hello
/ usage. Server events: welcome / subscribed / submitted / error.
Data frames are { channel, type, data }, where type is snapshot (full
state) or update (a delta). Live updates are coalesced into a JSON array.
A rendered AsyncAPI viewer is planned for this page. Until then, the YAML contract above is the source of truth, and the guides cover the common flows.