Skip to main content

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.

​
Returns

​
Arguments

We support lock info on UniV3, UniV4, RaydiumV4, PumpAMM, and token burns on Solana.

​
Usage Guidelines

  • Query using tokenAddress (contract address) and networkId (chain ID)
  • lockedLiquidityPercentage is a value between 0 and 1 (e.g., 0.5 = 50% locked)
  • lockBreakdown shows how liquidity is distributed across different lock protocols
  • Use totalTokenLiquidityShifted and lockedTokenLiquidityShifted for human-readable token amounts (adjusted for decimals)
  • Liquidity data is aggregated across up to 100 pairs containing the token

​
Troubleshooting Tips

Use liquidityMetadataByToken when you want aggregated liquidity data across all pairs containing a token (up to 100 pairs), including total locked percentage and USD values. Use liquidityMetadata when you have a specific pair and want detailed lock info for that pool only.
We track liquidity locked via UNCX_V2, UNCX_V3, BASECAMP_V1, BITBOND, METEORA_DAMM_V2, and BURN (burned LP tokens). Support includes UniV3, UniV4, RaydiumV4, PumpAMM, and Solana token burns.
Not all tokens have locked liquidity. Many tokens, especially older or larger ones like WETH, may have unlocked liquidity. A 0% locked percentage simply means the liquidity can be removed by LP providers.
totalTokenLiquidity is the raw token amount. totalTokenLiquidityShifted divides by the token’s decimals for a human-readable value. For example, if a token has 18 decimals, 1000000000000000000 raw becomes 1.0 shifted.
We track liquidity across up to 100 pairs per token. Tokens with more pairs may have partial data. Also, some lock protocols or DEXs may not be supported yet.