Skip to main content

​
Returns

​
Arguments

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

​
Usage Guidelines

  • Provide pairAddress and networkId to get liquidity and lock metadata for a specific trading pair
  • liquidity returns total active and inactive liquidity amounts in the pair
  • lockedLiquidity shows how much liquidity is locked, with a lockBreakdown by protocol
  • Lock protocols include BURN (burned LP tokens), UNCX_V2, UNCX_V3, BASECAMP_V1, BITBOND, METEORA_DAMM_V2
  • For token-level aggregated lock data across all pairs, use liquidityMetadataByToken instead
  • Active vs inactive liquidity: in concentrated liquidity pools (UniV3, Orca Whirlpool), liquidity outside the current price range is “inactive”

​
Troubleshooting Tips

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”.
BURN means LP tokens were sent to a burn address (permanently locked). UNCX_V2/UNCX_V3 refers to the UNCX liquidity locker. BASECAMP_V1 and BITBOND are other locker protocols. METEORA_DAMM_V2 is Meteora’s DAMM locker on Solana. Locked liquidity indicates developer commitment and reduces rug-pull risk.
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.
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.