Get list of volumes with balances for (account/asset)

GET /api/ledger/v2/{ledger}/volumes

Try it

Get list of volumes with balances for (account/asset)

cURL

curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger}/volumes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "data": [
      {
        "account": "<string>",
        "asset": "<string>",
        "input": 123,
        "output": 123,
        "balance": 123
      }
    ],
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": ""
  }
}

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=="

endTime · string<date-time>

startTime · string<date-time>

insertionDate · boolean

Use insertion date instead of effective date

groupBy · integer<int64>

Group volumes and balance by the level of the segment of the address

Required range: 0 <= x <= 1000

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

200

application/json

OK

cursor · object · required

Show child attributes

cursor. pageSize · integer<int64> · required

Required range: 1 <= x <= 1000

Example:

15

cursor. hasMore · boolean · required

Example:

false

cursor. data · object[] · required

Show child attributes

cursor.data. account · string · required

cursor.data. asset · string · required

cursor.data. input · integer<bigint> · required

cursor.data. output · integer<bigint> · required

cursor.data. balance · integer<bigint> · required

cursor. previous · string

Example:

"YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="

cursor. next · string

Example:

""