Sign in
ledger.v2

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

get/v2/{ledger}/volumes

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

Query parameters

pageSizeinteger

The maximum number of results to return per page.

cursorstring
Example:aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

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.

endTimestring date-time
startTimestring date-time
insertionDateboolean

Use insertion date instead of effective date

groupByinteger

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

sortstring
Example:id:desc

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.

Request body

object required

Response

OK

resource'volumes'

The resource type carried by this cursor

Example response

{
  "cursor": {
    "pageSize": 15,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "aW0gdmVuaWFtLCBxdWlzIG5vc3RydWQ="
  }
}

Changes

Changed in 7 of the 52 revisions of this API.153

  • c0620f81a6491See the full diff
    • ○

      added the optional property resource to the response with the 200 status

      response-optional-property-added

  • 2945092328b92See the full diff
    • ●

      added the new SCHEMA_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • ●

      added the new SCHEMA_NOT_SPECIFIED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

  • c51f6899d1011See the full diff
    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

  • a13b37bacc1f1See the full diff
    • ▲

      request body became required

      request-body-became-required

  • 7ee573f0087f11See the full diff
    • ●

      added the new OUTDATED_SCHEMA enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • ○

      removed the BUCKET_OUTDATED enum value from the errorCode response property for the response status default

      response-property-enum-value-removed

  • d93e4ae21e381See the full diff
    • ●

      added the new BUCKET_OUTDATED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

  • dcde15f756b51See the full diff
    • ●

      added the new LEDGER_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added