This is a Socket.IO server, not a raw
ws endpoint. Connect with a
Socket.IO client (socket.io-client or equivalent) — Socket.IO adds its own
handshake and framing on top of the WebSocket protocol, so a plain browser
WebSocket cannot speak to it directly.Connection details
Connection details
string
required
/eventPage — the single Socket.IO path the server listens on. There is no
per-channel URL or namespace; every channel in the
channel table is reached over this one
connection.string
Default namespace (
/).string
Heartbeat is handled by Socket.IO itself, not an application-level
message — see Connection Keep-Alive for the
ping/pong schedule and reconnect behavior.
Authentication
Authentication
string
Bearer JWT — the same token used for REST requests. Pass it as
auth.token on the client, or as a token query parameter.user_{userId}) — how User Account Updates
reach you and no one else. Room membership follows the socket’s connect →
disconnect lifecycle, not any particular UI component mounting or
unmounting.Send
Every channel is subscribed to and unsubscribed from the same way: an event name plus channel-specific parameters. The event name, parameters, and acknowledgement shape differ per channel — see Orderbook & Market Updates, Public Trades, and User Account Updates for the concrete values.Subscribe Command
Subscribe Command
string
required
The channel’s subscribe event name, e.g.
SUBSCRIBE_MARKET.varies
Channel-specific parameters — e.g. a comma-separated market id string
for
SUBSCRIBE_MARKET. Some channels take none.function
Optional acknowledgement callback, invoked once with the
subscribed response. Not every channel provides one.
Subscription state is per-connection and is not restored automatically
on reconnect — re-subscribe to every channel you need after a reconnect.
Receive
Subscribed Response
Subscribed Response
Unsubscribed Response
Unsubscribed Response
Error Response
Error Response
boolean
Present when the failure surfaced through an ack callback.
false
indicates the subscribe/action failed.string
required
Human-readable failure reason, e.g.
"Authentication required".string
Present when the failure surfaced as a generic
error event rather
than an ack callback — names the inbound event that failed.- Ack callback failure
errorevent
