balances channel streams client asset balances and transactions from the account ledger.
For derivatives margin requirements, margin equity, and available margin, see the margin channel.
This channel contains account specific data, an authentication token is required in the request.
Subscribe
- Request
- Response
asset_class parameter. Balances are account-wide and cover every asset class at once, so there is nothing to select. Sending params.asset_class on a subscribe or an unsubscribe is rejected with 'params.asset_class' is not valid for the balances channel.
Snapshot
The snapshot provides the value of each asset held in this account.string
Value:
balancesstring
One of:
snapshotobject[]
A list of assets held on account.
integer
The subscription message sequence number.
Update
An update will be streamed on each completed transaction to the client account.string
Value:
balancesstring
One of:
updateobject[]
A list of account ledger transactions for each asset.
integer
The subscription message sequence number.