This endpoint requires a Growth or Enterprise plan. Learn more.
Returns
LiquidityMetadata
Arguments
String!
required
The address of the pair.
Int!
required
The network id of the pair.
Lock tracking covers all major EVM networks and Solana, gated by the lock mechanism a pool uses: burned LP, locker vaults such as UNCX, PinkSale and Team Finance, Uniswap V4 launch-hook custody on Robinhood Chain and Base, and position-state locks on Meteora DAMM v2, Orca and Raydium CLMM. See the coverage table for the full list. For per-pair lock state read from the chain right now, with vesting matured and a
lockedPercent, use liquidityLocksV2.Example
Test this query in the Explorer →Usage Guidelines
- Provide
pairAddressandnetworkIdto get liquidity and lock metadata for a specific trading pair liquidityreturns totalactiveandinactiveliquidity amounts in the pairlockedLiquidityshows how much liquidity is locked, with alockBreakdownby protocollockProtocolis aLiquidityLockProtocolvalue, for exampleBURN(burned LP tokens),UNCX_V2,UNCX_V3,PINKSALE,TEAM_FINANCE,METEORA_DAMM_V2,METAPLEX_GENESIS, or a launch hook such asDOPPLER,PONS_V2,O1_EXCHANGE,BAGSandLAUNCH_FAIR- For token-level aggregated lock data across all pairs, use
liquidityMetadataByTokeninstead - Active vs inactive liquidity: in concentrated liquidity pools (UniV3, Orca Whirlpool), liquidity outside the current price range is “inactive”
Troubleshooting Tips
What's the difference between active and inactive liquidity?
What's the difference between active and inactive liquidity?
In concentrated liquidity pools, liquidity providers choose price ranges.
active liquidity is within the current trading range and earns fees. inactive liquidity is outside the current range and doesn’t participate in trades until the price moves into its range. For constant-product AMMs, all liquidity is typically “active”.What do the lock protocols mean?
What do the lock protocols mean?
BURN means LP tokens were sent to a burn address (permanently locked). UNCX_V2/UNCX_V3, PINKSALE and TEAM_FINANCE are locker vaults that publish an unlock date per deposit. DOPPLER, PONS_V2, O1_EXCHANGE, BAGS and LAUNCH_FAIR are launchpads whose Uniswap V4 hook holds the pool position with no withdraw path. METEORA_DAMM_V2 is a position-state lock on Solana, and METAPLEX_GENESIS is a vesting launch bucket. The LiquidityLockProtocol page describes each value. Locked liquidity indicates developer commitment and reduces rug-pull risk.When should I use liquidityMetadata vs liquidityMetadataByToken?
When should I use liquidityMetadata vs liquidityMetadataByToken?
Use
liquidityMetadata when you have a specific pair and want detailed lock info for that pool. 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.Why is lockBreakdown empty for some pairs?
Why is lockBreakdown empty for some pairs?
Not all pairs have locked liquidity. If no LP tokens have been burned or locked via a supported protocol,
lockBreakdown will be an empty array. This is normal for many pairs — locked liquidity is a trust signal, not a requirement. It is also empty when the pool’s custodian is one Codex has not verified (for example a team multisig or an unregistered launchpad hook): Codex reports a lock only when it can prove it on chain, so an unverified lock reads as unlocked. If a locker or launchpad you rely on is missing, let us know with the pool address.