Returns
Show Properties
Show Properties
The list of tokens matching the filter parameters.
Show Properties
Show Properties
The exchanges the token is listed on.
Show Properties
Show Properties
Metadata for the token’s top pair.
Show Properties
Show Properties
Metadata for the first token in the pair.
Show Properties
Show Properties
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Community gathered links for the socials of this token.
More metadata about the token.
Show Properties
Show Properties
A list of exchanges where the token has been traded.
Show Properties
Show Properties
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
The launchpad data for the token, if applicable.
Show Properties
Show Properties
The total supply of the token.
This field is deprecated. Use the TokenInfo type
ExplorerTokenData
deprecated
Information about the token from 3rd party sources.
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
The small token logo URL.
This field is deprecated. Use the TokenInfo type
The large token logo URL.
This field is deprecated. Use the TokenInfo type
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
Metadata for the second token in the pair.
Show Properties
Show Properties
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Community gathered links for the socials of this token.
More metadata about the token.
Show Properties
Show Properties
A list of exchanges where the token has been traded.
Show Properties
Show Properties
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
The launchpad data for the token, if applicable.
Show Properties
Show Properties
The total supply of the token.
This field is deprecated. Use the TokenInfo type
ExplorerTokenData
deprecated
Information about the token from 3rd party sources.
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
The small token logo URL.
This field is deprecated. Use the TokenInfo type
The large token logo URL.
This field is deprecated. Use the TokenInfo type
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
Custom data for the pair, only certain protocols have this. (uniswapv4, arenatrade for example)
Show Properties
Show Properties
Show Properties
Show Properties
Whether the pool uses a dynamic fee. A fee of 0x80000 is used by Uniswap V4 to indicate a dynamic pool — in such cases, the fee percentage on the pair should be disregarded.
PairProtocolCustomData
deprecated
Metadata for the token’s most liquid pair
Show Properties
Show Properties
Metadata for the first token in the pair.
Show Properties
Show Properties
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Community gathered links for the socials of this token.
More metadata about the token.
Show Properties
Show Properties
A list of exchanges where the token has been traded.
Show Properties
Show Properties
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
The launchpad data for the token, if applicable.
Show Properties
Show Properties
The total supply of the token.
This field is deprecated. Use the TokenInfo type
ExplorerTokenData
deprecated
Information about the token from 3rd party sources.
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
The small token logo URL.
This field is deprecated. Use the TokenInfo type
The large token logo URL.
This field is deprecated. Use the TokenInfo type
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
Metadata for the second token in the pair.
Show Properties
Show Properties
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Community gathered links for the socials of this token.
More metadata about the token.
Show Properties
Show Properties
A list of exchanges where the token has been traded.
Show Properties
Show Properties
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
The launchpad data for the token, if applicable.
Show Properties
Show Properties
The total supply of the token.
This field is deprecated. Use the TokenInfo type
ExplorerTokenData
deprecated
Information about the token from 3rd party sources.
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
The small token logo URL.
This field is deprecated. Use the TokenInfo type
The large token logo URL.
This field is deprecated. Use the TokenInfo type
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
Custom data for the pair, only certain protocols have this. (uniswapv4, arenatrade for example)
Show Properties
Show Properties
Show Properties
Show Properties
Whether the pool uses a dynamic fee. A fee of 0x80000 is used by Uniswap V4 to indicate a dynamic pool — in such cases, the fee percentage on the pair should be disregarded.
PairProtocolCustomData
deprecated
Metadata for the token.
Show Properties
Show Properties
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Community gathered links for the socials of this token.
More metadata about the token.
Show Properties
Show Properties
A list of exchanges where the token has been traded.
Show Properties
Show Properties
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
The launchpad data for the token, if applicable.
Show Properties
Show Properties
The total supply of the token.
This field is deprecated. Use the TokenInfo type
ExplorerTokenData
deprecated
Information about the token from 3rd party sources.
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
The small token logo URL.
This field is deprecated. Use the TokenInfo type
The large token logo URL.
This field is deprecated. Use the TokenInfo type
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
The percentage of wallets that are less than 1d old that have traded in the last 24h
The percentage of wallets that are less than 7d old that have traded in the last 24h
Arguments
A set of filters to apply.
Show Properties
Show Properties
The list of exchange contract IDs to filter by. Applied in conjunction with
network filter using an OR condition. When used together, the query returns results that match either the specified exchanges or the specified network.The list of network IDs to filter by. Applied in conjunction with
exchangeId filter using an OR condition. When used together, the query returns results that match either the specified exchanges or the specified network.Whether to filter for tokens on testnet networks. Use
true for testnet tokens only, false for mainnet tokens only and undefined (default) for both.Whether to ignore pairs/tokens not relevant to trending. This is done checking against a few factors and ignoring uninteresting tokens like stables / network tokens. If you want all tokens regardless of these checks, then don’t include this field. (default) If you want only tokens that fail the trending ignore checks, then set it to
true. (i.e. stablecoins, rugs, network base tokens) If you want only tokens that pass the trending ignore checks, then set it to false.A list of launchpad names. Any of the following: Pump.fun, Pump Mayhem, Bonk, BONAD.fun, Nad.Fun, Baseapp, Baseapp Creator, Zora, Zora Creator, Four.meme, Four.meme Fair, Believe, Moonshot, Jupiter Studio, boop, Heaven, TokenMill V2, Virtuals, Clanker, Clanker V4, ArenaTrade, Moonit, LaunchLab, MeteoraDBC, Vertigo, Cooking.City, time.fun, BAGS, Circus, Dealr, OhFuckFun, PrintFun, Trend, shout.fun, xApple, Sendshot, DubDub, cults, OpenGameProtocol, Printr.
NumberFilter
deprecated
NumberFilter
deprecated
A phrase to search for. Can match a token contract address or partially match a token’s name or symbol.
A list of token IDs (
address:networkId) or addresses. Can be left blank to discover new tokens.A list of ranking attributes to apply.
Show Properties
Show Properties
The attribute to rank tokens by.
Show Properties
Show Properties
Usage Guidelines
- Response limit: 200 tokens per request
- Use
trendingScore24orvolume24rankings for better results instead ofcreatedAt - Apply quality filters such as volume and liquidity minimums to avoid low quality tokens
- Use
phraseparameter for searching by token name, symbol, or contract address - For exact symbol searches, use the
$prefix and combinephrasewith volume/liquidity rankings to improve results
Troubleshooting Tips
How can we use potentialScam to remove scams from results?
How can we use potentialScam to remove scams from results?
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.Token not being returned in search results
Token not being returned in search results
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).Results are returning too much junk data or scam tokens
Results are returning too much junk data or scam tokens
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.Responses seem slow. What is the expected response time for queries and how long does it take for new tokens to be queryable?
Responses seem slow. What is the expected response time for queries and how long does it take for new tokens to be queryable?
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.
How can I create trending pages similar to those on Defined.fi?
How can I create trending pages similar to those on Defined.fi?
Check out our Discover Tokens recipe for more useful tips on how to use
filterTokens.How do I know if I can trust a null value for Mintable/Freezable status?
How do I know if I can trust a null value for Mintable/Freezable status?
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).