Skip to content

List tickers

Request

Security
httpAuth
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""ledgerId""kind""name""symbol"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
ledgerIdArray of strings

Return entities matching given ledger id.

Example:ledgerId=exemplaryLedgerId1&ledgerId=exemplaryLedgerId2
kindstring

Return entities matching given kind.

Enum:"Native""Contract""Token"
Example:kind=Native
nameArray of strings

Return entities with names that contains or equals to provided name.

Example:name=exemplaryTickerName1&name=exemplaryTickerName2
symbolArray of strings

Return entities with names that contains or equals to provided symbol.

Example:symbol=exemplaryTickerSymbol1&symbol=exemplaryTickerSymbol2
validationStatusstring

Return entities matching the requested validation status

Enum:"Validated""NonValidated"
Example:validationStatus=Validated
lockArray of strings

Return tickers matching given lock status.

Items Enum:"Unlocked""Locked""Archived"
Example:lock=Locked&lock=Archived
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.41/devbox/v1/tickers?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&ledgerId=exemplaryLedgerId1%2CexemplaryLedgerId2&kind=Native&name=exemplaryTickerName1%2CexemplaryTickerName2&symbol=exemplaryTickerSymbol1%2CexemplaryTickerSymbol2&validationStatus=Validated&lock=Locked%2CArchived' \
  -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"
}