Message Format
WebSocket API message format
Messages that are sent to the various feeds will be JSON objects with the following similar format:
Property
Type
Description
sequence
int
The sequence number that the message was sent in
recipient
string
The corresponding WebSocket feed that the message was sent to
timestamp
int
The UNIX timestamp (in microseconds)
payload
JSON
The payload parameter will be a JSON string that contains then data
Please note that the sequence number sent by the WebSocket is not guaranteed to be in ascending order. If you detect any gaps or incorrect ordering you should reconnect.
Example Message
{
"sequence": 10,
"recipient": "private.user.balances",
"timestamp": 1649899310281716289,
"payload": [{
"currency": "aave",
"balance": "0.17572419",
"available": "0.17572419",
"held": "0",
"wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000"
}, {
"currency": "ada",
"balance": "42.32365721",
"available": "42.32365721",
"held": "0",
"wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000"
}, {
"currency": "atom",
"balance": "0.40485184",
"available": "0.40485184",
"held": "0",
"wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000"
}, {
"currency": "avax",
"balance": "0",
"available": "0",
"held": "0",
"wallet_display_id": "5a3f1b1c-719d-11e9-b0be-0ea0e44d1000"
}]
}
Copy link