Skip to content

List ledgers

Request

Security
httpAuth
Query
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, non-empty

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""alias""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/ledgers?limit=1&startingAfter=string&sortBy=id&sortOrder=ASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
itemsArray of objectsrequired
countinteger, (int32)required
currentStartingAfterstring
nextStartingAfterstring
Response
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}