Skip to content

List transaction orders

Request

Security
httpAuth
Path
domainIdstring, (uuid)required

Unique identifier for the domain.

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

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

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

Sort order applied to the query results.

Enum:"ASC""DESC"
accountIdArray of strings, (uuid)

Return entities matching given accountId.

Example:accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&accountId=fdeeeb4b-f987-4ec4-9880-1eb280581d49
ledgerIdArray of strings

Return entities matching given ledgerId.

Example:ledgerId=ledgerId1&ledgerId=ledgerId2
intentIdstring, (uuid)

Return entities matching given intentId.

Example:intentId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
parameters.typestring

Return entities that matches given parameter type.

Enum:"Algorand""Bitcoin""BitcoinRedirect""Cardano""Ethereum""Hedera""Solana""Substrate""Tezos""XRPL"
Example:parameters.type=XRPL
metadata.createdBystring, (uuid)

Return entities that were created by matching user.

Example:metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49
metadata.lastModifiedBystring, (uuid)

Return entities that were last modified by matching user.

Example:metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
metadata.createdAt.ltstring, (date-time)

Used to return only results created before the given date/time (lt=less than)

Example:metadata.createdAt.lt=2022-11-22T14:06:00.0000000+00:00
metadata.createdAt.gtstring, (date-time)

Used to return only results created after the given date/time (gt=greater than)

Example:metadata.createdAt.gt=2022-11-22T14:06:00.0000000+00:00
metadata.lastModifiedAt.ltstring, (date-time)

Used to return only results last modified before the given date/time (lt=less than)

Example:metadata.lastModifiedAt.lt=2022-11-22T14:06:00.0000000+00:00
metadata.lastModifiedAt.gtstring, (date-time)

Used to return only results last modified after the given date/time (gt=greater than)

Example:metadata.lastModifiedAt.gt=2022-11-22T14:06:00.0000000+00:00
metadata.descriptionstring, >= 0 characters

Return entities with descriptions that contains or equals to provided description.

Example:metadata.description=description1
metadata.customPropertiesArray of strings

Return entities that contains provided custom properties.

Example:metadata.customProperties=key1:value1&metadata.customProperties=key2:value2
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.34/devbox/v1/domains/{domainId}/transactions/orders?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be%2Cfdeeeb4b-f987-4ec4-9880-1eb280581d49&ledgerId=ledgerId1%2CledgerId2&intentId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&parameters.type=XRPL&metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49&metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&metadata.createdAt.lt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.createdAt.gt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.lastModifiedAt.lt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.lastModifiedAt.gt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.description=description1&metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2' \
  -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"
}