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.
This endpoint requires a Growth or Enterprise plan. Learn more.
Returns
See PairMetadata
Show Properties
Show Properties
The exchange contract ID.
The exchange fee for swaps.
The ID for the pair (
address:networkId).The token of interest within the pair. Can be
token0 or token1.
See QuoteTokenThe network ID the pair is deployed on.
The total liquidity in the pair.
The token with higher liquidity within the pair. Can be
token0 or token1.The token with lower liquidity within the pair. Can be
token0 or token1.The contract address of the pair.
The type of statistics returned. Can be
FILTERED or UNFILTERED.
See TokenPairStatisticsTypeThe quote token price in USD.
The non-quote token price in USD.
The percent price change in the past 5 minutes. Decimal format.
The percent price change in the past hour. Decimal format.
The percent price change in the past 4 hours. Decimal format.
The percent price change in the past 12 hours. Decimal format.
The percent price change in the past 24 hours. Decimal format.
The amount of required tick separation. Only applicable for pairs on UniswapV3.
Pair metadata for the first token in the pair.
See PairMetadataToken
Show Properties
Show Properties
See ContractLabel
Show Properties
Show Properties
The unix timestamp for when the contract label was created.
The contract label sub-type. Can be
Generic, HighTax, HoneyPot or Imitator.
See ContractLabelSubTypeThe contract label type. Can be
Scam.
See ContractLabelTypePair metadata for the second token in the pair.
See PairMetadataToken
Show Properties
Show Properties
See ContractLabel
Show Properties
Show Properties
The unix timestamp for when the contract label was created.
The contract label sub-type. Can be
Generic, HighTax, HoneyPot or Imitator.
See ContractLabelSubTypeThe contract label type. Can be
Scam.
See ContractLabelTypeThe trade volume in USD in the past hour.
The trade volume in USD in the past 4 hours.
The trade volume in USD in the past 12 hours.
The trade volume in USD in the past 24 hours.
The trade volume in USD in the past 5 minutes.
The highest price in USD in the past 5 minutes.
The highest price in USD in the past hour.
The highest price in USD in the past 4 hours.
The highest price in USD in the past 12 hours.
The highest price in USD in the past 24 hours.
The lowest price in USD in the past 5 minutes.
The lowest price in USD in the past hour.
The lowest price in USD in the past 12 hours.
The lowest price in USD in the past 24 hours.
The lowest price in USD in the past 4 hours.
Token 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
Token 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
Wallet pattern data for the quote token, if available. Only populated for launchpad tokens.
See TokenWalletActivity
Show Properties
Show Properties
The number of bundler wallets that hold this token.
The percentage of token supply held by bundler wallets.
The percentage of token supply held by developer/creator wallet.
The number of insider wallets that hold this token.
The percentage of token supply held by insider wallets.
The number of sniper wallets that hold this token.
The percentage of token supply held by sniper wallets.
The unix timestamp for the creation of the pair.
The percentage of total supply held by the top 10 holders.
The percent price change in the past week. Decimal format.
This field is deprecated. Inaccurate
The trade trade volume in USD in the past week.
This field is deprecated. Inaccurate
The highest price in USD in the past week.
This field is deprecated. Inaccurate
The lowest price in USD in the past week.
This field is deprecated. Inaccurate
Arguments
The ID of the pair (
address:networkId).The token of interest within the pair. Can be
token0 or token1. If not specified, returns data for both tokens.
See QuoteTokenIf true, automatically selects the non-liquidity token as the quoteToken. Ignored if quoteToken is explicitly specified.
Example Subscription
subscription {
onPairMetadataUpdated(
id: "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1"
) {
id
pairAddress
networkId
liquidity
statsType
price
priceNonQuoteToken
priceChange5m
priceChange1
priceChange24
volume5m
volume1
volume24
token0 {
address
name
symbol
price
pooled
networkId
}
token1 {
address
name
symbol
price
pooled
networkId
}
}
}
Example Response
{
"data": {
"onPairMetadataUpdated": {
"id": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1",
"pairAddress": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
"networkId": 1,
"liquidity": "150000000",
"statsType": "UNFILTERED",
"price": "3245.67",
"priceNonQuoteToken": "0.000308",
"priceChange5m": 0.0012,
"priceChange1": 0.0089,
"priceChange24": -0.0234,
"volume5m": "125000",
"volume1": "2500000",
"volume24": "45000000",
"token0": {
"address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"name": "USD Coin",
"symbol": "USDC",
"price": "1.00",
"pooled": "75000000",
"networkId": 1
},
"token1": {
"address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
"name": "Wrapped Ether",
"symbol": "WETH",
"price": "3245.67",
"pooled": "23100",
"networkId": 1
}
}
}
}
Usage Guidelines
- Subscribe using the pair ID in format
pairAddress:networkId(e.g.,0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1) - Use
quoteTokenparameter (token0ortoken1) to specify which token’s perspective to use for price data - Use
useNonLiquidityTokenAsQuoteToken: trueto automatically select the non-liquidity token as the quote token - Updates are pushed in real-time as trades occur on the pair
- Price change fields (
priceChange5m,priceChange1, etc.) are in decimal format (0.01 = 1%) - Volume fields represent USD value traded in the specified time window
- Use
statsTypeto see if stats areFILTERED(bot-filtered) orUNFILTERED
Troubleshooting Tips
How do I get the pair ID for a token?
How do I get the pair ID for a token?
Use the
filterPairs or listPairsForToken query to find the pair address and network ID for your token. The subscription ID format is pairAddress:networkId.Why am I not receiving updates?
Why am I not receiving updates?
Updates are only pushed when trades occur on the pair. Low-activity pairs may have infrequent updates. Ensure your WebSocket connection is properly established and you’re subscribed to an active pair.
What's the difference between token0 and token1?
What's the difference between token0 and token1?
Token ordering is determined by the pair contract. Use the
quoteToken parameter to specify which token you want as the base for price calculations, or use useNonLiquidityTokenAsQuoteToken: true to automatically select the non-stable/non-major token.How do I handle WebSocket reconnections?
How do I handle WebSocket reconnections?
Implement reconnection logic in your client. When reconnecting, you’ll need to re-subscribe to the pairs you were monitoring. Consider using a library like
graphql-ws that handles reconnections automatically.Can I subscribe to multiple pairs at once?
Can I subscribe to multiple pairs at once?
Yes, you can open multiple subscriptions for different pairs over the same WebSocket connection. Each subscription operates independently and will receive updates for its specific pair.
Related Recipes
- Detailed Token Page: Build a comprehensive token detail page with price, holders, trades, and real-time updates