Coinfair 技术文档

Appearance

CLMM 池子统计列表接口文档 ​

接口信息 ​

  • 接口路径: /clmm/stats_pools
  • 请求方法: POST
  • 接口描述: 获取全局池子统计列表，包含池子基本信息、TVL、交易量、手续费等统计数据

请求参数 ​

Request Body 参数 ​

参数名类型必填说明
filterstring否筛选条件，如 "verified"（仅显示已验证的池子）
sortBystring否排序字段，如 "vol"（交易量）、"tvl"（总锁定价值）等
sortOrderstring否排序顺序，"asc"（升序）或 "desc"（降序），默认为 "desc"
limitnumber是每页数量
offsetnumber是偏移量，用于分页，从 0 开始
coinTypesstring[]否代币类型数组，用于筛选包含指定代币的池子，如 ["0x...::sui::SUI"]

请求示例 ​

bash
POST /clmm/stats_pools
Content-Type: application/json

{
  "filter": "verified",
  "sortBy": "vol",
  "sortOrder": "desc",
  "limit": 20,
  "offset": 0,
  "coinTypes": [
    "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI"
  ]
}

响应数据结构 ​

响应格式 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 100,
    "list": [
      {
        "pool": "0xb8a67c149fd1bc7f9aca1541c61e51ba13bdded64c273c278e50850ae3bff073",
        "feeRate": 10,
        "showReverse": true,
        "coinA": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "coinB": {
          "coinType": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
          "symbol": "suiUSDT",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/H6RiSi7PDvKaKCzgsLybW1Pdaq4pvakBHnTvghWD5Kad"
        },
        "tvl": "5156172.92768828821246",
        "totalApr": null,
        "stats": [
          {
            "dateType": "24H",
            "vol": "27356569.71629699914127",
            "fee": "273.565697162969991431",
            "apr": null
          },
          {
            "dateType": "7D",
            "vol": "104250874.76531219906499",
            "fee": "1042.50874765312199078",
            "apr": null
          },
          {
            "dateType": "30D",
            "vol": "503582956.23392407441108",
            "fee": "5035.829562339240744692",
            "apr": null
          }
        ],
        "miningRewarders": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "display": true,
            "apr": null,
            "emissionsPerSecond": "0.0011574074074074"
          },
          {
            "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
            "symbol": "SUI",
            "decimals": 9,
            "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png",
            "display": true,
            "apr": null,
            "emissionsPerSecond": "0.0126273148148148"
          }
        ]
      }
    ]
  }
}

响应字段说明 ​

data 对象字段 ​

字段名类型必填说明
totalnumber是符合条件的池子总数
listarray是池子列表数据

list 数组项字段 ​

字段名类型必填说明
poolstring是池子地址（Pool ID）
feeRatenumber是手续费率，单位为基点（1 基点 = 0.01%），如 10 表示 0.1%
showReverseboolean是是否显示反向交易对
coinAobject是代币 A 信息
coinBobject是代币 B 信息
tvlstring是总锁定价值（Total Value Locked），字符串格式的数字
totalAprstring否总年化收益率，字符串格式的数字，当前可返回 null
statsarray是统计数据数组，包含不同时间段的交易量、手续费和 APR
miningRewardersarray否挖矿奖励代币列表

coinA/coinB 对象字段 ​

字段名类型必填说明
coinTypestring是代币的 Coin Type，完整类型标识符
symbolstring是代币符号，如 "USDC"、"SUI"
decimalsnumber是代币精度（小数位数）
isVerifiedboolean是是否已验证
logoURLstring否代币图标 URL

stats 数组项字段 ​

字段名类型必填说明
dateTypestring是时间段类型，如 "24H"（24 小时）、"7D"（7 天）、"30D"（30 天）
volstring是交易量，字符串格式的数字
feestring是手续费，字符串格式的数字
aprstring否年化收益率，字符串格式的数字，当前可返回 null

miningRewarders 数组项字段 ​

字段名类型必填说明
coinTypestring是奖励代币的 Coin Type
symbolstring是奖励代币符号
decimalsnumber是奖励代币精度（小数位数）
logoURLstring否奖励代币图标 URL
displayboolean是是否显示
aprstring否该奖励代币的年化收益率，字符串格式的数字，当前可返回 null
emissionsPerSecondstring是每秒释放量，字符串格式的数字

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 100,
    "list": [
      {
        "pool": "0xb8a67c149fd1bc7f9aca1541c61e51ba13bdded64c273c278e50850ae3bff073",
        "feeRate": 10,
        "showReverse": true,
        "coinA": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "coinB": {
          "coinType": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
          "symbol": "suiUSDT",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/H6RiSi7PDvKaKCzgsLybW1Pdaq4pvakBHnTvghWD5Kad"
        },
        "tvl": "5156172.92768828821246",
        "totalApr": null,
        "stats": [
          {
            "dateType": "24H",
            "vol": "27356569.71629699914127",
            "fee": "273.565697162969991431",
            "apr": null
          },
          {
            "dateType": "7D",
            "vol": "104250874.76531219906499",
            "fee": "1042.50874765312199078",
            "apr": null
          },
          {
            "dateType": "30D",
            "vol": "503582956.23392407441108",
            "fee": "5035.829562339240744692",
            "apr": null
          }
        ],
        "miningRewarders": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "display": true,
            "apr": null,
            "emissionsPerSecond": "0.0011574074074074"
          },
          {
            "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
            "symbol": "SUI",
            "decimals": 9,
            "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png",
            "display": true,
            "apr": null,
            "emissionsPerSecond": "0.0126273148148148"
          }
        ]
      }
    ]
  }
}

注意事项 ​

  1. 本接口使用 POST 方法，请求体为 JSON 格式
  2. limit 和 offset 为必填参数，用于分页，offset 从 0 开始
  3. filter、sortBy、sortOrder、coinTypes 为可选参数，可根据需要组合使用
  4. filter 参数目前支持 "verified" 值，用于筛选已验证的池子
  5. sortBy 参数支持多种排序字段，如 "vol"（交易量）、"tvl"（总锁定价值）等
  6. sortOrder 默认为 "desc"（降序），可设置为 "asc"（升序）
  7. coinTypes 为代币类型数组，用于筛选包含指定代币的池子，支持传入多个代币类型
  8. feeRate 单位为基点，1 基点 = 0.01%，如 10 表示 0.1%
  9. tvl、vol、fee、emissionsPerSecond 等字段为字符串格式的数字，前端需要根据需要进行格式化显示
  10. APR 相关字段说明：
    • totalApr：池子的总年化收益率，当前可返回 null
    • stats[].apr：各时间段的年化收益率，当前可返回 null
    • miningRewarders[].apr：挖矿奖励代币的年化收益率，当前可返回 null
    • 前端需要对 null 值进行兼容处理，可显示为 "-" 或 "计算中" 等占位文本
  11. stats 数组包含不同时间段的统计数据，前端可根据需要选择展示的时间段
  12. miningRewarders 数组可能为空或不存在，前端需要做兼容处理
  13. total 字段表示符合条件的池子总数，可用于计算总页数：总页数 = Math.ceil(total / limit)
  14. 响应格式遵循标准 API 格式：code 为 0 表示成功，msg 为状态消息
  15. showReverse 字段表示是否显示反向交易对，前端可根据此字段决定是否显示反向交易对信息