Get account balance
GET {{baseUrl}}/ledgers/:ledgerId/balances/accounts/:accountId
Retrieves asset balances for an account.
The account must have at least one transaction for a given asset for the balance of said asset to be returned.
The bookedBalance
is the current balance calculated from all transactions.
The availableBalance
is the current balance without transactions that are not yet created through the valueDate
transaction setting. bookedBalance
becomes availableBalance
once given transactions are cleared.
The parameter date
can be used to query the balance for a given point in time.
Allowed roles: VIEWER
, EDITOR
, BALANCE_VIEWER
and MARKET_MAKER
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
date | string | (Optional query) Include transactions only until given datetime (inclusive) in the balance calculation |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
tangany-version | number | (Required) API version | |
Accept | string |
RESPONSES
status: OK
{"date":"2022-10-05T14:48:00.000Z","balances":{"consequat_71f":{"bookedBalance":"0.00548","availableBalance":"0.00548"}}}