Messages
{
"op": "<string>",
"bearer": "<string>"
}{
"timestamp_ms": 123,
"api_key": "<string>",
"nonce": "<string>",
"op": "<string>",
"signature": "<string>"
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>"
}{
"success": true,
"op": "<string>"
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"server_ts": 123
}{
"op": "<string>",
"message": "<string>"
}{
"server_ts_ms": 123,
"op": "<string>"
}Websockets
Private
The private channel is used for subscribing to user-specific data.
WSS
/
ws
/
private
Messages
{
"op": "<string>",
"bearer": "<string>"
}{
"timestamp_ms": 123,
"api_key": "<string>",
"nonce": "<string>",
"op": "<string>",
"signature": "<string>"
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>"
}{
"success": true,
"op": "<string>"
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"args": {
"item": "<string>"
}
}{
"op": "<string>",
"server_ts": 123
}{
"op": "<string>",
"message": "<string>"
}{
"server_ts_ms": 123,
"op": "<string>"
}Auth
type:object
Authenticate the connection on the private channel using a bearer token (e.g., JWT). Server responds with AuthResponse.
AuthApiKey
type:object
Authenticate the connection on the private channel using an API key signature. Server responds with AuthResponse.
Subscribe
type:object
Subscribe to topics. Server will respond with a Subscribed message.
Unsubscribe
type:object
Unsubscribe from topics. Server will respond with an Unsubscribed message.
Ping
type:object
Ping the server. The server will respond with a Pong message. Client can use ts to measure RTT.
Auth
type:object
Response to an Auth request. Indicates whether authentication succeeded.
Subscribed
type:object
Subscription acknowledgement.
Unsubscribed
type:object
Unsubscribe acknowledgement.
Pong
type:object
Response to Ping.
Error
type:object
Error response.
Event
type:object
Streaming event message.
⌘I