Swagger UI

Use the latest API endpoints for new integrations. Legacy endpoints are maintained for backward compatibility.

Key Information Fields

The following table describes the key information that can be retrieved:

FieldDescription
pool_addressToken mint address of the token in the pool (e.g. USDC-USDT)
pool_token_mintsPool token mints for the pool, for both tokens
pool_token_amountsPool token amounts for both tokens
pool_token_usd_amountsPool tokens amounts in USD value
lp_mintLiquidity Pool (LP) Token mint address
pool_tvlPool Total Value Locked
farm_tvlFarm Total Value Locked
farming_poolFarming pool address that is linked with the AMM pool (Note: not all AMM pools have the farming pool)
farming_apyFarm APY data
is_monitoringN/A
pool_orderN/A
farm_orderN/A
pool_versionIndicate whether the pool is Multi-token Stable Pool (1) or Dynamic AMM Pools (2)
pool_namePool name
lp_decimalLP token decimals place
farm_reward_duration_endFarm reward duration end timestamp
farm_expireFarm expiration
pool_lp_price_in_usdLP Token price in USD
trading_volumeTrading Volume
fee_volumeFee Volume
weekly_trading_volumeWeekly Trading Volume
weekly_fee_volumeWeekly Fee Volume
yield_volume24h Yield
accumulated_trading_volumeAccumulated Trading Volume
accumulated_fee_volumeAccumulated Fee Volume
accumulated_yield_volumeAccumulated Yield Volume
trade_apyTrading fees APY
weekly_trade_apyWeekly trading fees APY
virtual_price_apyVirtual Price APY
daily_base_apyDaily Base APY (Including lending yield from vault)
weekly_base_apyWeekly Base APY (Including lending yield from vault)
farm_newNew farm tag
permissionedPermission / Permissionless pool
unknownUnknown / new token
total_fee_pctSwap fee of the pool
is_lstLST pool tag indicate whether the pool is LST or not

Example Response

{
    "pool_address": "32D4zRxNc1EssbJieVHfPhZM3rH6CzfUPrWUuWxD9prG",
    "pool_token_mints": [
      "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB"
    ],
    "pool_token_amounts": [
      "147848.134080",
      "319838.170088"
    ],
    "pool_token_usd_amounts": [
      "147848.134080",
      "319794.991935"
    ],
    "lp_mint": "xLebAypjbaQ9tmxUKHV6DZU4mY8ATAAP2sfkNNQLXjf",
    "pool_tvl": "467643.126015",
    "farm_tvl": "0",
    "farming_pool": null,
    "farming_apy": "0",
    "is_monitoring": false,
    "pool_order": 21,
    "farm_order": 0,
    "pool_version": 2,
    "pool_name": "USDT-USDC",
    "lp_decimal": 6,
    "farm_reward_duration_end": 0,
    "farm_expire": false,
    "pool_lp_price_in_usd": "1.033891",
    "trading_volume": 192226.124643,
    "fee_volume": 14.416761,
    "weekly_trading_volume": 707133.354544,
    "weekly_fee_volume": 53.033889,
    "yield_volume": "21.232559",
    "accumulated_trading_volume": "27982256.437910",
    "accumulated_fee_volume": "1359.906515",
    "accumulated_yield_volume": "3571.774818",
    "trade_apy": "1.131579",
    "weekly_trade_apy": "0.591424",
    "virtual_price_apy": "2.878042",
    "daily_base_apy": "2.878042",
    "weekly_base_apy": "2.572358",
    "farm_new": false,
    "permissioned": true,
    "unknown": false,
    "total_fee_pct": "0.01",
    "is_lst": false
}