The Live Data WebSocket API provides real-time streaming via GET /ws on wss://api.hypedexer.com. The sidebar documents all available subscriptions and their schemas.
Connection
The ?mode=mirror query parameter is required for live data WebSocket connections. Connections without this parameter will not work.
Important: live data subscriptions only
A live data WebSocket connection (?mode=mirror) exclusively supports the subscriptions documented in this section:
- Market data —
allMids, trades, candle, allCandles, bbo, l2Book, l4Book, l4BookUpdates
- Asset context —
activeAssetCtx, allActiveAssetCtx, fundingRates, setOracleUpdates
- Fills & orders —
userFills, allFills, orderUpdates, allTwapStatusUpdates
- Account & events —
userEvents, webData2, liquidations
You can only subscribe to live data events on this connection. If you need to subscribe to other event types (e.g. historical or indexed data WebSockets), use a separate connection on wss://api.hypedexer.com/ws without the ?mode=mirror parameter.
Protocol
All messages are JSON. The client sends subscribe, unsubscribe, and pong messages. The server sends acknowledgements, snapshots, and real-time updates.
