Sign in

v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v1

List accounts from a ledger

List accounts from a ledger, sorted by address in descending order.

get/{ledger}/accounts

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

Query parameters

pageSizeinteger

The maximum number of results to return per page.

page_sizeinteger

The maximum number of results to return per page. Deprecated, please use pageSize instead.

afterstring
Example:users:003

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

addressstring
Example:users:.+

Filter accounts by address pattern (regular expression placed between ^ and $).

metadataobject

Filter accounts by metadata key value pairs. Nested objects can be used as seen in the example below.

balanceinteger
Example:2400

Filter accounts by their balance (default operator is gte)

balanceOperator'gte' | 'lte' | 'gt' | 'lt' | 'e' | 'ne'
Example:gte

Operator used for the filtering of balances can be greater than/equal, less than/equal, greater than, less than, equal or not.

balance_operator'gte' | 'lte' | 'gt' | 'lt' | 'e' | 'ne'
Example:gte

Operator used for the filtering of balances can be greater than/equal, less than/equal, greater than, less than, equal or not. Deprecated, please use balanceOperator instead.

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. 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. Deprecated, please use cursor instead.

Response

OK

Example response

{
  "cursor": {
    "pageSize": 15,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "data": [
      {
        "address": "users:001",
        "type": "virtual",
        "metadata": {
          "admin": true,
          "a": {
            "nested": {
              "key": "value"
            }
          }
        }
      }
    ]
  }
}