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
}
'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));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)[
{
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"vmType": "bvm",
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
}
]API Reference
Get Currencies
This api returns currency metadata from a curated list
POST
/
currencies
/
v2
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
}
'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));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)[
{
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"vmType": "bvm",
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
}
]Headers
Optional API key for authentication and higher rate limits.
Body
application/json
Return default currencies
Chain IDs to search for currencies
Search term for currencies
Address of the currency contract
ID to search for a currency
List of token addresses, like: chainId:address
Filter verified currencies
Limit the number of results
Required range:
x <= 100Include all chains for a currency when filtering by chainId and address
Uses 3rd party API's to search for a token, in case relay does not have it indexed
Returns only currencies supported with deposit address bridging
Was this page helpful?