> For the complete documentation index, see [llms.txt](https://noodles-finance.gitbook.io/docs.noodles.fi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://noodles-finance.gitbook.io/docs.noodles.fi/dex-pools/pool-liquidity.md). # Pool Liquidity ## Overview Retrieve detailed liquidity and performance data for specific DEX liquidity pools across supported protocols. ## Endpoint ``` GET /api/v1/partner/pool/liquidity-pools ``` ## Request Parameters | Name | Type | Required | Description | | --------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `pool_addresses` | string | No | Comma-separated list of pool IDs (addresses) to filter. Example: `0xfa54...a0a,0x3b45...f538`. | | `protocols` | string | No | Comma-separated list of protocols to include (e.g., `magma-clmm,cetus-clmm`). See full protocol list below. | | `coin_ids` | string | No | Comma-separated list of coin types to filter pools by (e.g., `0x...::usdc::USDC`). | | `tvl_min` | number | No | Minimum TVL (USD) filter. | | `tvl_max` | number | No | Maximum TVL (USD) filter. | | `coin_a_cap_min` | number | No | Minimum market cap for coin A. | | `coin_b_cap_min` | number | No | Minimum market cap for coin B. | | `coin_a_fdv_min` | number | No | Minimum FDV for coin A. | | `coin_b_fdv_min` | number | No | Minimum FDV for coin B. | | `coin_a_cap_max` | number | No | Maximum market cap for coin A. | | `coin_b_cap_max` | number | No | Maximum market cap for coin B. | | `coin_a_fdv_max` | number | No | Maximum FDV for coin A. | | `coin_b_fdv_max` | number | No | Maximum FDV for coin B. | | `strict_coin_cap_fdv` | boolean | No | If `true`, both coins must satisfy market cap/FDV filters. | | `sort_field` | string | No | Field to sort results by (e.g., `tvl_usd`, `apr_24h`, `apr_1w`, `volume_24h`, `volume_1w`, `total_apr_24h`, `total_apr_1w`, `fee_24h`, `fee_1w`, `created_at`, ). | | `sort_direction` | string | No | Sort order: `ASC` or `DESC`. | | `category_group` | string | No | Group filter (e.g., `meme`, `stablecoin`, `other`). | | `pool_type` | string | No | Pool type filter (e.g., `clmm`, `cpmm`, `dlmm`, `weighted`, `stableswap`, `oracle`). | | `limit` | integer | No | Number of results to return (default: 20, max: 20). | | `offset` | integer | No | Offset for pagination (default: 0). | #### List of supported protocols: | Protocol Key | Protocol Name | | ---------------------- | -------------------- | | `aftermath-cpmm` | Aftermath CPMM | | `aftermath-metastable` | Aftermath Metastable | | `bluefin-clmm` | Bluefin CLMM | | `bluemove-cpmm` | BlueMove CPMM | | `cetus-clmm` | Cetus CLMM | | `cetus-dlmm` | Cetus DLMM | | `ferra-clmm` | Ferra CLMM | | `ferra-dlmm` | Ferra DLMM | | `flowx-clmm` | FlowX CLMM (V3) | | `flowx-cpmm` | FlowX CPMM (V2) | | `fullsail-clmm` | Fullsail CLMM | | `haedal-cpmm` | Haedal CPMM | | `haedal-cpmm-v2` | Haedal CPMM V2 | | `interest-cpmm` | Interest CPMM | | `kriya-clmm` | Kriya CLMM (V3) | | `kriya-cpmm` | Kriya CPMM (V2) | | `magma-clmm` | Magma CLMM | | `magma-almm` | Magma ALMM | | `momentum-clmm` | Momentum CLMM | | `7k-cpmm` | 7K CPMM | | `steamm-cpmm` | STEAMM CPMM | | `srm-cpmm` | SRM CPMM | | `turbos-clmm` | Turbos CLMM | | `tradeport-clmm` | Tradeport CLMM | ## Headers | Header | Required | Description | | ----------- | -------- | --------------------------- | | `x-api-key` | Yes | API key for authentication. | ## cURL Example ```bash curl --location 'https://api.noodles.fi/api/v1/partner/pool/liquidity-pools?pool_addresses=0xfa54f1de53af9135aea64d31e8e4b543fc0b073a6c218f520f5b015d28951a0a&protocols=magma-clmm&coin_ids=0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT&tvl_min=100&sort_direction=desc&coin_a_cap_min=10000000&coin_b_cap_min=10000000&coin_a_fdv_min=100&coin_b_fdv_min=100&coin_a_cap_max=1000000000000&coin_b_cap_max=1000000000000&coin_a_fdv_max=1000000000000&coin_b_fdv_max=1000000000000&strict_coin_cap_fdv=false&sort_field=volume_24h&sort_direction=DESC&category_group=other&pool_type=clmm' \ --header 'x-api-key: YOUR_API_KEY' ``` ## Response | Field | Type | Nullable | Description | | --------- | ------ | -------- | -------------------------------- | | `code` | number | No | HTTP status code. | | `message` | string | No | Response message. | | `data` | array | No | Array of liquidity pool objects. | ### Liquidity Pool Object | Field | Type | Description | | -------------------- | ------- | ------------------------------------------------ | | `pool_id` | string | Unique identifier of the pool. | | `protocol` | string | Protocol key (e.g., `magma-clmm`, `cetus-clmm`). | | `coin_a` | object | Details of coin A in the pool. | | `coin_b` | object | Details of coin B in the pool. | | `amount_a` | number | Amount of coin A in the pool. | | `amount_b` | number | Amount of coin B in the pool. | | `amount_a_usd` | number | USD value of coin A. | | `amount_b_usd` | number | USD value of coin B. | | `price_a` | number | Price of coin A. | | `price_b` | number | Price of coin B. | | `price_ab` | number | Price ratio between A and B. | | `tvl_usd` | number | Total value locked (USD). | | `tvl_usd_24h_change` | number | 24-hour change in TVL (%). | | `fee_rate` | number | Pool fee rate (in %). | | `fee_24h` | number | Total fees generated in last 24h (USD). | | `fee_1w` | number | Total fees generated in last 7 days (USD). | | `fee_24h_change` | number | 24-hour fee change (%). | | `volume_24h` | number | Trading volume in last 24h (USD). | | `volume_24h_change` | number | 24-hour volume change (%). | | `volume_1w` | number | Weekly trading volume (USD). | | `fee_apr_24h` | number | Estimated 24h APR from fees. | | `fee_apr_1w` | number | Estimated 7d APR from fees. | | `rewards` | array | List of reward emission coins (see below). | | `active` | boolean | Whether the pool is active. | | `created_at` | string | Pool creation timestamp (ISO 8601). | | `pool_type` | string | Type of pool (e.g., `clmm`, `cpmm`, `dlmm`). | ### Reward Object | Field | Type | Description | | ------------------ | ------- | ----------------------------------- | | `coin_type` | string | Coin identifier for reward token. | | `symbol` | string | Token symbol. | | `decimals` | number | Number of decimal places. | | `icon_url` | string | Token icon URL. | | `verified` | boolean | Whether the token is verified. | | `daily_amount` | number | Number of tokens distributed daily. | | `daily_amount_usd` | number | USD value of daily reward. | | `apr` | number | APR contribution from rewards (%). | ### Coin Object (within pools) | Field | Type | Description | | ----------- | ------- | ---------------------------------------------------------------- | | `coin_type` | string | Unique identifier of the coin. | | `symbol` | string | Symbol or ticker of the coin. | | `decimals` | number | Decimal precision. | | `icon_url` | string | Icon URL. | | `verified` | boolean | Whether the coin is verified. | | `category` | string | Category of the coin (e.g., "Infrastructure", "Liquid Staking"). | ### Success Response Example ```json { "code": 200, "message": "OK", "data": [ { "pool_id": "0xfa54f1de53af9135aea64d31e8e4b543fc0b073a6c218f520f5b015d28951a0a", "protocol": "magma-clmm", "coin_a": { "coin_type": "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT", "symbol": "vSUI", "decimals": 9, "icon_url": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/vSUI.png/public", "verified": true, "category": "Liquid Staking" }, "coin_b": { "coin_type": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI", "symbol": "SUI", "decimals": 9, "icon_url": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/sui-coin.svg/public", "verified": true, "category": "Infrastructure" }, "amount_a": 232345.284413853, "amount_b": 3408282.85767515, "amount_a_usd": 531542.8, "amount_b_usd": 7391202.21, "price_a": 2.288, "price_b": 2.169, "price_ab": 1.055, "tvl_usd": 7922745.01, "tvl_usd_24h_change": 0, "fee_rate": 0.01, "fee_24h": 7.74, "fee_24h_change": 0, "fee_1w": 75.98, "fee_a_24h": { "fee_raw": 0.15650959, "fee_usd": 0.35 }, "fee_b_24h": { "fee_raw": 3.54402782, "fee_usd": 7.39 }, "fee_a_1w": { "fee_raw": 6.27958943, "fee_usd": 13.78 }, "fee_b_1w": { "fee_raw": 30.142331406, "fee_usd": 62.2 }, "volume_24h": 8495829.24, "volume_24h_change": -19.97, "volume_1w": 88408030.4, "fee_apr_24h": 0.04, "fee_apr_1w": 0.05, "rewards": [ { "coin_type": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI", "symbol": "SUI", "decimals": 9, "icon_url": "https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/sui-coin.svg/public", "verified": true, "daily_amount": 192.642857142, "daily_amount_usd": 416.84, "apr": 1.92 } ], "active": true, "created_at": "2025-03-01T06:46:01.901Z", "pool_type": "clmm" } ] } ``` *** > **See also:** [Environment Setup](/docs.noodles.fi/environment-setup/environment.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://noodles-finance.gitbook.io/docs.noodles.fi/dex-pools/pool-liquidity.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.