Messages
No examples foundNo examples found{
"id": 123,
"cmd": "<string>"
}No examples foundNo examples foundNo examples found{
"id": 123,
"type": "<string>",
"msg": {
"channel": "<string>",
"sid": 123
}
}{
"id": 123,
"sid": 123,
"seq": 123,
"type": "<string>"
}No examples found{
"id": 123,
"type": "<string>",
"msg": {
"channel": "<string>",
"sid": 123
}
}{
"id": 123,
"type": "<string>",
"msg": {
"code": 123,
"msg": "<string>",
"market_ticker": "<string>"
}
}WebSockets
WebSocket Connection
Main WebSocket connection endpoint. Authentication is required during the WebSocket handshake.
WSS
/
Messages
No examples foundNo examples found{
"id": 123,
"cmd": "<string>"
}No examples foundNo examples foundNo examples found{
"id": 123,
"type": "<string>",
"msg": {
"channel": "<string>",
"sid": 123
}
}{
"id": 123,
"sid": 123,
"seq": 123,
"type": "<string>"
}No examples found{
"id": 123,
"type": "<string>",
"msg": {
"channel": "<string>",
"sid": 123
}
}{
"id": 123,
"type": "<string>",
"msg": {
"code": 123,
"msg": "<string>",
"market_ticker": "<string>"
}
}apiKey
type:apiKey
API key authentication required for margin WebSocket connections.
method
type:string
GET
Subscribe Command
type:object
Subscribe to one or more margin channels
Unsubscribe Command
type:object
Cancel one or more subscriptions
List Subscriptions Command
type:object
List all active subscriptions
Update Subscription - Add Markets
type:object
Add markets to an existing subscription
Update Subscription - Delete Markets
type:object
Remove markets from an existing subscription
Update Subscription - Single SID
type:object
Update a subscription using sid rather than sids
Subscribed Response
type:object
Confirmation that subscription was successful
Unsubscribed Response
type:object
Confirmation that unsubscription was successful
OK Response
type:object
Successful update operation response
List Subscriptions Response
type:object
Response containing all active subscriptions
Error Response
type:object
Error response for failed operations
⌘I