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/v1 \
--header 'Content-Type: application/json' \
--data '
{
"defaultList": true,
"chainIds": [
123
],
"term": "<string>",
"address": "<string>",
"currencyId": "<string>",
"tokens": [
"<string>"
],
"verified": true,
"limit": 123,
"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: 123,
includeAllChains: true,
useExternalSearch: true,
depositAddressOnly: true
})
};
fetch('https://api.relay.link/currencies/v1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests
url = "https://api.relay.link/currencies/v1"
payload = {
"defaultList": True,
"chainIds": [123],
"term": "<string>",
"address": "<string>",
"currencyId": "<string>",
"tokens": ["<string>"],
"verified": True,
"limit": 123,
"includeAllChains": True,
"useExternalSearch": True,
"depositAddressOnly": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
Response Structure
[
[
{
"groupID": "<string>",
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
}
]
]
API Headers
x-api-key
- string
- Optional API key for authentication and higher rate limits.
Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| 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 group |
| tokens | string[] | List of token addresses, like: chainId:address |
| verified | boolean | Filter verified currencies |
| limit | number | Limit the number of results |
| includeAllChains | boolean | Include all chains for a currency when filtering |
| useExternalSearch | boolean | Uses 3rd party API's to search for a token |
| depositAddressOnly | boolean | Returns only currencies supported with deposit address bridging |
Response
- 200 - application/json: List of currencies
| Field | Type | Description |
|---|---|---|
| groupID | string | Unique identifier for the currency group |
| chainId | number | Chain ID of the currency |
| address | string | Contract address of the currency |
| symbol | string | Symbol of the currency |
| name | string | Name of the currency |
| decimals | number | Decimal places of the currency |
| metadata | object | Additional information about the currency |