Documentation Index
Fetch the complete documentation index at: https://docs.codex.io/llms.txt
Use this file to discover all available pages before exploring further.
The contract address of the pair.
The address for the exchange factory contract.
The exchange fee for swaps.
The ID for the pair (
address:networkId).The network ID the pair is deployed on.
The protocol of the pair. E.g. UniswapV4, RaydiumV4, PumpV1, etc.
The amount of required tick separation. Only applicable for pairs on UniswapV3.
The contract address of
token0.The contract address of
token1.The unix timestamp for the creation of the pair.
Metadata for the first token in the pair.
See EnhancedToken
Show Properties
Show Properties
The ID of the token (
address:networkId).The contract address of the token.
The token ID on CoinMarketCap.
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Whether the token has been flagged as a scam.
The token name. For example,
ApeCoin.The network ID the token is deployed on.
The token symbol. For example,
APE.Community gathered links for the socials of this token.
See SocialLinks
More metadata about the token.
See TokenInfo
Show Properties
Show Properties
Uniquely identifies the token.
The contract address of the token.
The circulating supply of the token.
The token ID on CoinMarketCap.
The Grid asset ID, if this token is linked to a Grid asset.
The Grid bluechip rating for this token (e.g.
A+, B-).Whether the token has been flagged as a scam.
The token name. For example,
ApeCoin.The network ID the token is deployed on.
The token symbol. For example,
APE.The total supply of the token.
The thumbhash of the token logo.
The thumbnail token logo URL.
The small token logo URL.
The large token logo URL.
The token banner URL.
The original URL/URI for the video associated with the token.
A description of the token.
The Grid asset ID, if this token is linked to a Grid asset.
The Grid bluechip rating for this token (e.g.
A+, B-).The Grid organization associated with this token.
See Organization
Show Properties
Show Properties
The organization name.
The founding date of the organization.
A short description of the organization.
A detailed description of the organization.
The organization’s tagline.
The type of organization (e.g.
protocol, company).The sector the organization operates in.
URLs associated with the organization.
See OrganizationUrl
Social links for the organization.
See OrganizationSocial
The organization’s logo URL.
The organization’s icon URL.
The Grid root ID for the organization.
Assets managed by this organization.
See Asset
Show Properties
Show Properties
The Grid asset ID.
The asset name.
A description of the asset.
The asset ticker symbol.
The asset type (e.g.
token, stablecoin).The asset status.
The asset icon URL.
The Grid root ID for the parent organization.
Deployments of this asset across chains.
See AssetDeployment
Show Properties
Show Properties
The deployment ID.
The network ID the asset is deployed on.
The contract address of the deployment.
The token standard (e.g.
ERC20, SPL).The Grid asset ID.
The Grid root ID for the parent organization.
The enhanced token this deployment represents.
See EnhancedToken
The Grid asset associated with this token.
See Asset
Show Properties
Show Properties
The Grid asset ID.
The asset name.
A description of the asset.
The asset ticker symbol.
The asset type (e.g.
token, stablecoin).The asset status.
The asset icon URL.
The Grid root ID for the parent organization.
Deployments of this asset across chains.
See AssetDeployment
Show Properties
Show Properties
The deployment ID.
The network ID the asset is deployed on.
The contract address of the deployment.
The token standard (e.g.
ERC20, SPL).The Grid asset ID.
The Grid root ID for the parent organization.
The enhanced token this deployment represents.
See EnhancedToken
A list of exchanges where the token has been traded.
See Exchange
Show Properties
Show Properties
The ID of the exchange (
address:id).The contract address of the exchange.
The hex string for the exchange color.
The name of the exchange.
The version of the exchange, if applicable.
The exchange logo URL.
The network ID the exchange is deployed on.
The URL for the exchange.
The token creator’s wallet address.
The block height the token was created at.
The transaction hash of the token’s creation.
The unix timestamp for the creation of the token.
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.
See LaunchpadData
Show Properties
Show Properties
The name of the launchpad.
The percentage of the pool that was sold to the public.
The address of the pool.
The unix timestamp when the launchpad was completed.
Indicates if the launchpad is completed.
The slot number when the launchpad was completed.
The slot number when the launchpad was migrated.
The unix timestamp when the launchpad was migrated.
Indicates if the launchpad was migrated.
The pool address after the launchpad was migrated.
The launchpad protocol.
The icon URL of the launchpad.
Whether cashback is enabled for this launchpad token (Pump V1/V2 only).
The token category assigned by the launchpad. Populated by launchpads that publish a category taxonomy (e.g. Scale/Creator, Eitherway). Values include platform, meme, utility, etc.
The name of the launchpad.
This field is deprecated. Use launchpadName instead
The percentage of total supply held by the top 10 holders (excluding exchanges/pairs).
Whether the token name or symbol contains profanity.
All-time high and low price/market cap data for the token.
See TokenExtrema
Show Properties
Show Properties
The token ID (
address:networkId).The contract address of the token.
The network ID the token is deployed on.
The all-time high price in USD.
The unix timestamp when the all-time high price was reached.
The all-time low price in USD.
The unix timestamp when the all-time low price was reached.
The all-time high fully diluted market cap.
The unix timestamp when the all-time high FDV was reached.
The all-time low fully diluted market cap.
The unix timestamp when the all-time low FDV was reached.
The all-time high circulating market cap.
The unix timestamp when the all-time high circulating market cap was reached.
The all-time low circulating market cap.
The unix timestamp when the all-time low circulating market cap was reached.
The Coin Community data for the token
See CoinCommunity
The total supply of the token.
This field is deprecated. Use the TokenInfo type
Information about the token from 3rd party sources.
See ExplorerTokenData
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The ID of the token (
address:networkId).Whether the token has been verified on CoinGecko.
A description of the token.
The precision to which the token can be divided.
The token price in USD.
The token type.
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 amount of this token in the pair.
This field is deprecated. Pooled can be found on the pair instead
Metadata for the second token in the pair.
See EnhancedToken
Show Properties
Show Properties
The ID of the token (
address:networkId).The contract address of the token.
The token ID on CoinMarketCap.
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
Whether the token has been flagged as a scam.
The token name. For example,
ApeCoin.The network ID the token is deployed on.
The token symbol. For example,
APE.Community gathered links for the socials of this token.
See SocialLinks
More metadata about the token.
See TokenInfo
Show Properties
Show Properties
Uniquely identifies the token.
The contract address of the token.
The circulating supply of the token.
The token ID on CoinMarketCap.
The Grid asset ID, if this token is linked to a Grid asset.
The Grid bluechip rating for this token (e.g.
A+, B-).Whether the token has been flagged as a scam.
The token name. For example,
ApeCoin.The network ID the token is deployed on.
The token symbol. For example,
APE.The total supply of the token.
The thumbhash of the token logo.
The thumbnail token logo URL.
The small token logo URL.
The large token logo URL.
The token banner URL.
The original URL/URI for the video associated with the token.
A description of the token.
The Grid asset ID, if this token is linked to a Grid asset.
The Grid bluechip rating for this token (e.g.
A+, B-).The Grid organization associated with this token.
See Organization
Show Properties
Show Properties
The organization name.
The founding date of the organization.
A short description of the organization.
A detailed description of the organization.
The organization’s tagline.
The type of organization (e.g.
protocol, company).The sector the organization operates in.
URLs associated with the organization.
See OrganizationUrl
Social links for the organization.
See OrganizationSocial
The organization’s logo URL.
The organization’s icon URL.
The Grid root ID for the organization.
Assets managed by this organization.
See Asset
Show Properties
Show Properties
The Grid asset ID.
The asset name.
A description of the asset.
The asset ticker symbol.
The asset type (e.g.
token, stablecoin).The asset status.
The asset icon URL.
The Grid root ID for the parent organization.
Deployments of this asset across chains.
See AssetDeployment
Show Properties
Show Properties
The deployment ID.
The network ID the asset is deployed on.
The contract address of the deployment.
The token standard (e.g.
ERC20, SPL).The Grid asset ID.
The Grid root ID for the parent organization.
The enhanced token this deployment represents.
See EnhancedToken
The Grid asset associated with this token.
See Asset
Show Properties
Show Properties
The Grid asset ID.
The asset name.
A description of the asset.
The asset ticker symbol.
The asset type (e.g.
token, stablecoin).The asset status.
The asset icon URL.
The Grid root ID for the parent organization.
Deployments of this asset across chains.
See AssetDeployment
Show Properties
Show Properties
The deployment ID.
The network ID the asset is deployed on.
The contract address of the deployment.
The token standard (e.g.
ERC20, SPL).The Grid asset ID.
The Grid root ID for the parent organization.
The enhanced token this deployment represents.
See EnhancedToken
A list of exchanges where the token has been traded.
See Exchange
Show Properties
Show Properties
The ID of the exchange (
address:id).The contract address of the exchange.
The hex string for the exchange color.
The name of the exchange.
The version of the exchange, if applicable.
The exchange logo URL.
The network ID the exchange is deployed on.
The URL for the exchange.
The token creator’s wallet address.
The block height the token was created at.
The transaction hash of the token’s creation.
The unix timestamp for the creation of the token.
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.
See LaunchpadData
Show Properties
Show Properties
The name of the launchpad.
The percentage of the pool that was sold to the public.
The address of the pool.
The unix timestamp when the launchpad was completed.
Indicates if the launchpad is completed.
The slot number when the launchpad was completed.
The slot number when the launchpad was migrated.
The unix timestamp when the launchpad was migrated.
Indicates if the launchpad was migrated.
The pool address after the launchpad was migrated.
The launchpad protocol.
The icon URL of the launchpad.
Whether cashback is enabled for this launchpad token (Pump V1/V2 only).
The token category assigned by the launchpad. Populated by launchpads that publish a category taxonomy (e.g. Scale/Creator, Eitherway). Values include platform, meme, utility, etc.
The name of the launchpad.
This field is deprecated. Use launchpadName instead
The percentage of total supply held by the top 10 holders (excluding exchanges/pairs).
Whether the token name or symbol contains profanity.
All-time high and low price/market cap data for the token.
See TokenExtrema
Show Properties
Show Properties
The token ID (
address:networkId).The contract address of the token.
The network ID the token is deployed on.
The all-time high price in USD.
The unix timestamp when the all-time high price was reached.
The all-time low price in USD.
The unix timestamp when the all-time low price was reached.
The all-time high fully diluted market cap.
The unix timestamp when the all-time high FDV was reached.
The all-time low fully diluted market cap.
The unix timestamp when the all-time low FDV was reached.
The all-time high circulating market cap.
The unix timestamp when the all-time high circulating market cap was reached.
The all-time low circulating market cap.
The unix timestamp when the all-time low circulating market cap was reached.
The Coin Community data for the token
See CoinCommunity
The total supply of the token.
This field is deprecated. Use the TokenInfo type
Information about the token from 3rd party sources.
See ExplorerTokenData
This field is deprecated. Use the TokenInfo type
Show Properties
Show Properties
The ID of the token (
address:networkId).Whether the token has been verified on CoinGecko.
A description of the token.
The precision to which the token can be divided.
The token price in USD.
The token type.
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 amount of this token in the pair.
This field is deprecated. Pooled can be found on the pair instead
The pooled amounts of each token in the pair.
See PooledTokenValues
The virtual pooled amounts of each token in the pair.
See PooledTokenValues
Custom data for the pair, only certain protocols have this. (uniswapv4, arenatrade for example)
See ProtocolData
Show Properties
Show Properties
See UniswapV4Data
Show Properties
Show Properties
The address of the hook contract for Uniswap V4 pools.
Whether the token is the network token for the Uniswap V4 pool.
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.
See ArenaTradeData
The per-protocol data for the pair, if applicable
See PairProtocolCustomData
This field is deprecated. Use protocolData instead
Show Properties
Show Properties
The address of the hook contract for Uniswap V4 pools.
Used By
Returned by- filterPairs: Returns a list of pairs based on a variety of filters.
- filterTokens: Discover, screen, and rank tokens across every supported network using 100+ on-chain signals: trading activity, liquidity, holder behavior, fee economics, and launchpad lifecycle.
- getBars: Returns bar chart data to track price changes over time.
- getDetailedPairsStats: Returns bucketed stats for a given token within a list of pairs.
- getDetailedPairStats: Returns bucketed stats for a given token within a pair.
- listPairsForToken: Returns a list of pairs containing a given token.
- listPairsWithMetadataForToken: Returns a list of pair metadata for a token.
- onFilterTokensUpdated: Live-streamed filter token updates for the current
filterTokensresult set.