Skip to main content

Example

Usage Guidelines

  • Response limit: 200 tokens per request
  • Use trendingScore24 or volume24 rankings for better results instead of createdAt
  • Apply quality filters such as volume and liquidity minimums to avoid low quality tokens
  • Use phrase parameter for searching by token name, symbol, or contract address
  • For exact symbol searches, use the $ prefix and combine phrase with volume/liquidity rankings to improve results

Troubleshooting Tips

We actually remove potential scam tokens automatically without this filter. If you set potentialScamto true, your results will show all (potentially) scam tokens that we have flagged. If set to false, it will return similar results as without the filter, however, all majors and stables will be included now. While false positives can occur, our detection system significantly reduces exposure to scam tokens.We also allow users to flag scams on our frontend at Defined.fi (moderated daily) which will update our API.
Check if the token has been flagged as a potential scam by adding includeScams: true to your filters. Also verify you’re searching the correct network and the token has trading activity (we only index tokens after swaps have occurred).
Add quality filters to improve results. We recommend setting minimum thresholds for volume, liquidity, holders, etc. Additionally, rank results by trendingScore24 or volume24 rather than liquidity to get more meaningful results. Experiment with filters that will suit your needs.
Response times are generally 60-150ms and it takes ~2-5 seconds to update the search cluster with new data. Contact our team if you are experiencing consistently delayed response times.
A null or undefined value for Mintable/Freezable will both return null through Codex. To differentiate between the two, we’ve included an isMintableValid and isFreezableValid field to show whether the null value returned is trustworthy or if we simply lack that information for the token (ie: undefined).
Returns: TokenFilterConnection

Arguments

filters
TokenFilters
A set of filters to apply.
statsType
TokenPairStatisticsType
The type of statistics returned. Can be FILTERED or UNFILTERED. Default is UNFILTERED.
phrase
String
A phrase to search for. Can match a token contract address or partially match a token’s name or symbol.
tokens
[String]
A list of token IDs (address:networkId) or addresses. Can be left blank to discover new tokens.
excludeTokens
[String]
A list of token IDs (address:networkId) to exclude from results
rankings
[TokenRanking]
A list of ranking attributes to apply.
limit
Int
The maximum number of tokens to return.
offset
Int
Where in the list the server should start when returning items. Use count+page from the previous query to request the next page of results.

Schema

"""Returns a list of tokens based on a variety of filters."""
filterTokens(filters: TokenFilters, statsType: TokenPairStatisticsType, phrase: String, tokens: [String], excludeTokens: [String], rankings: [TokenRanking], limit: Int, offset: Int): TokenFilterConnection