Usage Guidelines
- Query 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 - 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 - Use
enhancedToken0andenhancedToken1for additional token metadata like social links, images, and launchpad data
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 pair ID format is pairAddress:networkId.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.What's the difference between pairMetadata and onPairMetadataUpdated?
What's the difference between pairMetadata and onPairMetadataUpdated?
pairMetadata is a one-time query that returns current data. onPairMetadataUpdated is a WebSocket subscription that streams real-time updates as trades occur. Use the query for initial data and the subscription for live updates.Why are some price/volume fields null?
Why are some price/volume fields null?
Price change and volume fields may be null for very new pairs that don’t have enough historical data for the specified time window (e.g.,
priceChange24 requires 24 hours of data).How do I get enhanced token metadata?
How do I get enhanced token metadata?
Use the
enhancedToken0 and enhancedToken1 fields to access additional token information like social links, images, creator address, and launchpad data. These fields provide more comprehensive token details than the basic token0 and token1 fields.How do I check if a token in a pair is verified?
How do I check if a token in a pair is verified?
Codex does not have a separate
isVerified field. Instead, use isScam: false as the equivalent of a token being “verified.” Access it via enhancedToken0 { isScam } or enhancedToken1 { isScam } on the pairMetadata query, or through the token / tokens queries directly.