Get Currencies - Relay

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request POST \
  --url https://api.relay.link/currencies/v2 \
  --header 'Content-Type: application/json' \
  --data '\
{\
  "defaultList": true,\
  "chainIds": [\
    123\
  ],\
  "term": "<string>",\
  "address": "<string>",\
  "currencyId": "<string>",\
  "tokens": [\
    "<string>"\
  ],\
  "verified": true,\
  "limit": 20,\
  "includeAllChains": true,\
  "useExternalSearch": true,\
  "depositAddressOnly": true\
}\
'` 

JavaScript

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    defaultList: true,
    chainIds: [123],
    term: '<string>',
    address: '<string>',
    currencyId: '<string>',
    tokens: ['<string>'],
    verified: true,
    limit: 20,
    includeAllChains: true,
    useExternalSearch: true,
    depositAddressOnly: true
  })
};

fetch('https://api.relay.link/currencies/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Python

import requests

url = "https://api.relay.link/currencies/v2"

payload = {
    "defaultList": True,
    "chainIds": [123],
    "term": "<string>",
    "address": "<string>",
    "currencyId": "<string>",
    "tokens": ["<string>"],
    "verified": True,
    "limit": 20,
    "includeAllChains": True,
    "useExternalSearch": True,
    "depositAddressOnly": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200 Response Example

[\
  {\
    "chainId": 123,\
    "address": "<string>",\
    "symbol": "<string>",\
    "name": "<string>",\
    "decimals": 123,\
    "metadata": {\
      "logoURI": "<string>",\
      "verified": true,\
      "isNative": true\
    }\
  }\
]

Headers

x-api-key

• Optional API key for authentication and higher rate limits.

Body

defaultList

• boolean: Return default currencies

chainIds

• number[]: Chain IDs to search for currencies

term

• string: Search term for currencies

address

• string: Address of the currency contract

currencyId

• string: ID to search for a currency

tokens

• string[]: List of token addresses, like: chainId:address

verified

• boolean: Filter verified currencies

limit

• number: default:20. Limit the number of results. Required range: x <= 100

includeAllChains

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

useExternalSearch

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

depositAddressOnly

• boolean: Returns only currencies supported with deposit address bridging

Response

• 200 - application/json: List of currencies

Response Items

• chainId: number
• address: string
• symbol: string
• name: string
• decimals: number
• metadata: object
  • logoURI: string
  • verified: boolean
  • isNative: boolean