Skip to main content
GET
/
api
/
ledger
/
v2
/
{ledger}
/
accounts
List accounts from a ledger
curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "data": [
      {
        "address": "users:001",
        "metadata": {
          "admin": "true"
        },
        "insertionDate": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-01T00:00:00Z",
        "firstUsage": "2023-01-01T00:00:00Z",
        "volumes": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          },
          "EUR": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        },
        "effectiveVolumes": {
          "USD": {
            "input": 100,
            "output": 10,
            "balance": 90
          },
          "EUR": {
            "input": 100,
            "output": 10,
            "balance": 90
          }
        }
      }
    ],
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": ""
  }
}
Retrieve a paginated list of accounts from the ledger. Accounts are created automatically when they appear in transactions.

​
Parameters

ledger: The name of the ledger to query accounts from. (e.g., ledger001) pageSize: Number of accounts to return per page. Defaults to 15, maximum 1000. (e.g., 100) cursor: Pagination cursor from a previous response. Use the next or previous value to navigate pages. (e.g., aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==) expand: Include additional data. Use volumes to include balance and volume information for each account. (e.g., volumes) pit: Point-in-time query. Returns account state as it existed at this timestamp. (e.g., 2024-01-15T10:30:00Z)

​
Request Body

Filter criteria. Use $match to filter by address pattern or metadata. See Filtering Queries for full syntax. Example: 
{
  "$match": {
    "address": "users::wallet"
  }
}

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<int64>

The maximum number of results to return per page.

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

Parameter used in pagination requests. Maximum page size is set to 15. 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=="

​
expand
string
​
pit
string<date-time>
​
sort
string

Sort results using a field name and order (ascending or descending). Format: <field>:<order>, where <field> is the field name and <order> is either asc or desc.

Example:

"id:desc"

Body

application/json

The body is of type object.

Response

OK

​
cursor
object
required