Balances

Real-time account balance updates. Authentication required.

warning

This is a private channel. You must authenticate the WebSocket connection before subscribing. See the WebSocket overview for authentication details.

Subscribe Request:

{
  "id": "12345",
  "method": "subscribe",
  "params": {
    "channel": "balances"
  }
}

Response

Subscribe Response:

{
  "id": "12345",
  "result": {
    "success": true
  }
}

Subscription Push Example:

{
  "method": "subscription",
  "params": {
    "channel": "balances",
    "data": {
      "balances": [
        {
          "asset": "BTC",
          "balance": "1.23456789",
          "available": "1.00000000",
          "holds": "0.23456789"
        },
        {
          "asset": "USDT",
          "balance": "5678.90",
          "available": "5000.00",
          "holds": "678.90"
        }
      ]
    }
  }
}

Response Parameters

Parameter	Description
asset (required)	The symbol of the crypto or asset (e.g., "BTC", "ETH", "USDT"). Type: string.
balance (required)	The total balance amount of the asset in the account (available + holds). Type: string.
available (required)	The amount of the asset available for trading, withdrawals, or transfers. Type: string.
holds (required)	The amount of the asset locked or reserved due to open orders or pending actions (also referred to as locked balance). Type: string.