{
  "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
  }
}

Overview

Receive balance changes resulting from settlements, transfers, and funding via the balance channel.

Channel Information

PropertyValue
Channel Namebalance
AuthenticationRequired
Update FrequencyOn balance events
Data TypeBalance update object

Subscribe

{
  "op": "subscribe",
  "args": [ { "channel": "balance" } ]
}

Message Format

{
  "type": "balance",
  "data": {
    "accountId": "01234567-89ab-7def-8123-456789abcdef",
    "balanceBefore": "1.50000000",
    "balanceAfter": "1.49950000",
    "amount": "-0.00050000",
    "unit": "btc",
    "updateType": "ordersettle",
    "timestamp": 1640995200000000000
  }
}
data
object
Balance update fields