GET
/
api
/
ledger
/
{ledger}
/
balances
Get the balances from a ledger's account
curl --request GET \
  --url http://localhost:55001/api/ledger/{ledger}/balances \
  --header 'Authorization: Bearer <token>'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "",
    "data": [
      {
        "account1": {
          "USD": 100,
          "EUR": 23
        },
        "account2": {
          "CAD": 20,
          "JPY": 21
        }
      }
    ]
  }
}

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"

​
pageSize
integer

The maximum number of results to return per page.

Required range: 1 <= x <= 1000
​
after
string

Pagination cursor, will return accounts after given address, in descending order.

Example:

"users:003"

​
cursor
string

Parameter used in pagination requests. Maximum page size is set to 1000. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

​
pagination_token
string
deprecated

Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. Deprecated, please use cursor instead.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

Response

200
application/json

OK

The response is of type object.