Pool Stats

Retrieve the statistics of a specific liquidity pool, including TVL, volume, fees, APR, and more.

---

Endpoint

GET /api/v1/partner/pool/stats

---

Request Parameters

Name	Type	Required	Description
pool_address	string	Yes	The address of the liquidity pool.

---

Headers

Header	Required	Description
x-api-key	No	API key for authorization.

---

cURL Example

curl --location 'https://api.noodles.fi/api/v1/partner/pool/stats?pool_address=0xb0a595cb58d35e07b711ac145b4846c8ed39772c6d6f6716d89d71c64384543b' \
--header 'x-api-key: YOUR_API_KEY'

---

Response

Fields

Field	Type	Nullable	Description
code	number	No	HTTP status code (200 for success).
message	string	No	Status message.
data	object	No	Pool statistics object.

Pool Statistics Object

Field	Type	Nullable	Description
pool_address	string	No	Pool address.
coin_a_type	string	No	Coin A type.
coin_b_type	string	No	Coin B type.
coin_a_symbol	string	No	Coin A symbol.
coin_b_symbol	string	No	Coin B symbol.
liquidity	string	No	Pool liquidity (big integer as string).
amount_a	float	No	Amount of coin A.
amount_b	float	Amount of coin B.
amount_a_usd	float	No	USD value of coin A.
amount_b_usd	float	No	USD value of coin B.
tvl_usd	float	No	Total value locked in USD.
volume_24h	float	No	24h trading volume.
volume_1w	float	No	1 week trading volume.
fee_24h	float	No	24h fee.
fee_1w	float	No	1 week fee.
fee_rate	float	No	Fee rate.
apr_24h	float	No	APR based on 24h fee.
apr_1w	float	No	APR based on 1 week fee.

Success Response

{
    "code": 200,
    "message": "OK",
    "data": {
        "pool_address": "0xb0a595cb58d35e07b711ac145b4846c8ed39772c6d6f6716d89d71c64384543b",
        "coin_a_type": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
        "coin_b_type": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
        "coin_a_symbol": "suiUSDT",
        "coin_b_symbol": "USDC",
        "liquidity": 179916363982307895,
        "amount_a": 7879565.818598,
        "amount_b": 20007862.99662,
        "amount_a_usd": 7899986.753,
        "amount_b_usd": 20069135.25,
        "tvl_usd": 27969122,
        "volume_24h": 18405098.342808455,
        "volume_1w": 129874657.90201668,
        "fee_24h": 1841.53504401918,
        "fee_1w": 13019.264858861268,
        "fee_rate": 0.01,
        "apr_24h": 2.403222707766804,
        "apr_1w": 2.4205328027843915
    }
}

---

See also: Environment Setup