Accounts

Retrieve all generated addresses

get/v1/domains/{domainId}/accounts/{accountId}/addresses

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/accounts/:accountId/addresses/get.ts
A function with typed inputs. Its response is checked against the schema.

domainIdstring uuid required

Unique identifier for the domain.

accountIdstring uuid required

limitinteger

The number of entities to return.

startingAfterstring uuid

AccountAddressId id used to the determine beginning of query results.

sortBy'id' | 'ledgerId' | 'address' | 'createdAt' | 'scope'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

ledgerIdstring[]

Return addresses matching given ledgers.

lastOnlyboolean

Return only last addresses for matching ledgers.

scopeCoreAccountAddressScope[]

Return addresses matching given scopes.

countinteger required

currentStartingAfterstring

nextStartingAfterstring

{
  "items": [
    {
      "data": {
        "scope": "External"
      },
      "scope": "External"
    }
  ]
}

No recorded changes to this operation across all 3 revisions of this API.