Sign in

v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v1

Get the balances from a ledger's account

get/{ledger}/balances

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

Query parameters

addressstring
Example:users:001

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

pageSizeinteger

The maximum number of results to return per page.

afterstring
Example:users:003

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

cursorstring
Example:aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

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.

pagination_tokenstring
Example:aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

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.

Response

OK

Example response

{
  "cursor": {
    "pageSize": 15,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "data": [
      {
        "account1": {
          "USD": 100,
          "EUR": 23
        },
        "account2": {
          "CAD": 20,
          "JPY": 21
        }
      }
    ]
  }
}