API Reference
Get Currencies
This api returns currency metadata from a curated list
POST
/
currencies
/
v1
Body
application/json
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 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