​
Parameters

ParameterDescriptionRequired
baseApiUrlBase api url for the relay api, defaults to https://api.relay.link but can also be configured to https://api.testnets.relay.link❌
optionsQuery parameters that map directly to the currencies api❌
queryOptionsTanstack query options. Refer to the Tanstack docs.❌

​
Return Data

The hook returns an object with the base Tanstack Query response. The data property maps to the object returned in the aforementioned currencies api.

​
Usage

​
Query Function

import { queryTokenList } from '@reservoir0x/relay-kit-hooks'

queryTokenList(
  "https://api.relay.link", 
  { 
    limit: 20,
    term: "usdc"
  }
)
useRequestsGetting Started