Changed on
post/currencies/v2

Request

  • Base URL: https://api.relay.link
  • URL: https://api.relay.link/currencies/v2
  • Auth: none declared

Headers

x-api-keystring

Optional API key for authentication and higher rate limits.

Request body

defaultListboolean

Return default currencies

chainIdsnumber[]

Chain IDs to search for currencies

termstring

Search term for currencies

addressstring

Address of the currency contract

currencyIdstring

ID to search for a currency

tokensstring[]

List of token addresses, like: chainId:address

verifiedboolean

Filter verified currencies

limitnumber

Limit the number of results

includeAllChainsboolean

Include all chains for a currency when filtering by chainId and address

useExternalSearchboolean

Uses 3rd party API's to search for a token, in case relay does not have it indexed

depositAddressOnlyboolean

Returns eligible deposit-address input currencies for the caller's DA mode. Eligibility does not guarantee availability for every destination and amount.

Response

List of currencies

chainIdnumber
addressstring
symbolstring
namestring
decimalsnumber
vmType'bvm' | 'evm' | 'svm' | 'tvm' | 'tonvm' | 'hypevm' | 'lvm' | 'xrpvm' | 'hederavm' | 'atlasvm'

Changes

  • 85900d75d524Revision changes
    • warning

      added the new atlasvm enum value to the / response property for the response status

  • 4ae96c4238d5Revision changes
    • warning

      added the new hederavm enum value to the / response property for the response status