Retrieve all generated addresses

Request

Security

httpAuth

Path

domainIdstring, (uuid)required

Unique identifier for the domain.

accountIdstring, (uuid)required

Query

limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

AccountAddressId id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""ledgerId""address""createdAt""scope"

sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"

ledgerIdArray of strings

Return addresses matching given ledgers.

Example:ledgerId=1234567&ledgerId=abcdefg

lastOnlyboolean

Return only last addresses for matching ledgers.

Example:lastOnly=true

scopeArray of strings

Return addresses matching given scopes.

Items Enum:"Internal""External"

Example:scope=External

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.41/devbox/v1/domains/{domainId}/accounts/{accountId}/addresses?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&ledgerId=1234567%2Cabcdefg&lastOnly=true&scope=External' \
  -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"
}