account

Account balances

Authenticated balance updates for one root account or subaccount. JSON uses decimal amount strings; Protobuf uses unsigned 128-bit amount parts.

Transport

WebSocket

Encoding

JSON Protobuf

Visibility

Channel

private:ledger:balances:{accountPublicId}

Subscribe frame

{
  "type": "subscribe",
  "channel": "private:ledger:balances:6MSXSqCnTZa"
}

accountPublicId string

Public root account or subaccount identifier authorized by the subscription token.

e.g. 6MSXSqCnTZa

Payload JSON object

available string

Spendable trading amount, computed as max(trading minus reserved, 0), in asset units as a decimal string with up to 18 fractional digits.

Example 225.125

funding string

Funding balance in asset units as a decimal string with up to 18 fractional digits.

Example 1000.5

fundingRevision string

Opaque monotonic revision for the funding value. "0" means not yet observed.

Example 81

reserved string

Amount reserved from the trading balance in asset units as a decimal string with up to 18 fractional digits.

Example 25.125

symbol string

Unified asset symbol for these balances.

Example USDT

trading string

Trading balance in asset units as a decimal string with up to 18 fractional digits.

Example 250.25

tradingRevision string

Opaque monotonic revision for the atomic trading, reserved, and available values. "0" means not yet observed.

Example 42