Overview
Receive balance changes resulting from settlements, transfers, and funding via thebalance channel.
Channel information
Subscribe
Message format
Balance update fields
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
🛢️ New OIL-BTC contract live! Learn more →
{
"op": "subscribe",
"args": [ { "channel": "balance" } ]
}
{
"type": "balance",
"data": {
"accountId": "01234567-89ab-7def-8123-456789abcdef",
"balanceBefore": "1.50000000",
"balanceAfter": "1.49950000",
"amount": "-0.00050000",
"unit": "btc",
"updateType": "ordersettle",
"timestamp": 1640995200000000000
}
}
Receive real-time balance changes from settlements, transfers, and funding fees via WebSocket.
balance channel.
| Property | Value |
|---|---|
| Channel Name | balance |
| Authentication | Required |
| Update Frequency | On balance events |
| Data Type | Balance update object |
{
"op": "subscribe",
"args": [ { "channel": "balance" } ]
}
{
"type": "balance",
"data": {
"accountId": "01234567-89ab-7def-8123-456789abcdef",
"balanceBefore": "1.50000000",
"balanceAfter": "1.49950000",
"amount": "-0.00050000",
"unit": "btc",
"updateType": "ordersettle",
"timestamp": 1640995200000000000
}
}
Show Balance properties
btcordersettle, transfer, fundingfee, insurancefundreimbursementWas this page helpful?