GET
/
api
/
ledger
/
{ledger}
/
accounts
curl --request GET \
  --url http://localhost:55001/api/ledger/{ledger}/accounts \
  --header 'Authorization: Bearer <token>'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "",
    "data": [
      {
        "address": "users:001",
        "type": "virtual",
        "metadata": {
          "admin": true,
          "a": {
            "nested": {
              "key": "value"
            }
          }
        }
      }
    ]
  }
}

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

​
pageSize
integer

The maximum number of results to return per page.

Required range: 1 <= x <= 1000
​
page_size
integer
deprecated

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

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

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

Example:

"users:003"

​
address
string

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

Example:

"users:.+"

​
metadata
object

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

​
balance
integer

Filter accounts by their balance (default operator is gte)

Example:

2400

​
balanceOperator
enum<string>

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

Available options:
gte,
lte,
gt,
lt,
e,
ne
Example:

"gte"

​
balance_operator
enum<string>
deprecated

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.

Available options:
gte,
lte,
gt,
lt,
e,
ne
Example:

"gte"

​
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. 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.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

Response

200
application/json

OK

The response is of type object.