Get the aggregated balances from selected accounts

GET /api/ledger/{ledger}/aggregate/balances

Try it

Get the aggregated balances from selected accounts

cURL

curl --request GET \
  --url http://localhost/api/ledger/{ledger}/aggregate/balances \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "USD": 100,
    "EUR": 12
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

Query Parameters

address · string

Filter balances involving given account, either as source or destination.

Example:

"users:001"

useInsertionDate · boolean

Use insertion date instead of effective date

Response

200

application/json

OK

data · object · required

Show child attributes

data. {key} · integer<int64>

Example:

{ "USD": 100, "EUR": 12 }