Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Client Messages

All messages sent from the client to the server.

Subscribe

{"method": "subscribe", "subscription": {...}}

See Subscriptions for available subscription types.

Unsubscribe

{"method": "unsubscribe", "subscription": {...}}

Ping

{"method": "ping"}

The server responds with {"channel": "pong"}.

Post (Query)

{"method": "post", "id": 123, "request": {...}}

See Post Requests for available query types.

Example: wscat

wscat -c "wss://api.example.com/ws?jwt=<token>"

Once connected:

> {"method": "subscribe", "subscription": {"type": "l2Book", "coin": "BTC"}}
> {"method": "ping"}
> {"method": "unsubscribe", "subscription": {"type": "l2Book", "coin": "BTC"}}