GetTokenList will return a list of tokens based on the provided filters.
Routes & Tokens
GetTokenList
POST
GetTokenList will return a list of tokens based on the provided filters.
Overview
TheGetTokenList endpoint retrieves a list of tokens available on specified chains. This is useful for building token selection UIs, searching for tokens, and discovering available assets for swaps and transfers.
Use Cases
- Build token selector dropdowns
- Implement token search functionality
- Display featured/popular tokens
- Filter tokens by chain
- Look up specific token addresses
- Exclude certain tokens from selection
Request Parameters
Required Fields
- chainIds (number[]): Array of chain IDs to get tokens for
Optional Fields
- searchQuery (string): Search tokens by name, symbol, or address
- limit (number): Maximum number of tokens to return
- tokenAddress (string): Filter to a specific token address
- includeAllListed (boolean): Include all listed tokens, not just featured
- includeExternal (boolean): Include external/non-native tokens
- excludeTokens (string[]): Array of token addresses to exclude
Response
The response includes:- tokens (TokenInfo[]): Array of token information
TokenInfo Object Structure
Each token object contains:- chainId (number): Chain where the token exists
- address (string): Token contract address
- name (string): Token name
- symbol (string): Token symbol
- decimals (number): Token decimals
- supportsBridging (boolean, optional): Whether the token supports bridging
- logoUri (string, optional): URL to token logo
- featured (boolean): Whether this is a featured/popular token
- featureIndex (number): Sort order for featured tokens
Examples
Get Featured Tokens for Multiple Chains
Search for a Token
Look Up Specific Token
Build Token Selector with Search
Get All Tokens Including External
Exclude Specific Tokens
Filtering Tips
Featured tokens are curated for popularity and liquidity. Use
includeAllListed for comprehensive token lists.Next Steps
GetChains
Get supported chains for token selection
GetTokenPrices
Get USD prices for selected tokens