Skip to content

池子列表接口文档

接口信息

  • 接口路径: /api/v3/sui/clmm/stats_pools
  • 请求方法: POST
  • 接口描述: 获取池子列表,支持按筛选条件、排序方式和关键字搜索查询

请求参数

Request Body 参数

参数名类型必填说明
filterstring筛选条件,如 "verified"(仅显示已验证的池子)
sortBystring排序字段,如 "vol"(交易量)、"tvl"(总锁定价值)、"apr"(年化收益率)等
sortOrderstring排序顺序,"asc"(升序)或 "desc"(降序),默认为 "desc"
limitnumber每页数量,默认值根据接口实现而定
offsetnumber偏移量,用于分页,从 0 开始
keywordstring关键字搜索,用于搜索包含指定代币符号或名称的池子,如 "SUI"、"USDC" 等
walletAddressstring钱包地址,用于查询指定钱包地址的仓位(我的仓位),如 "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38"

请求示例

bash
POST /api/v3/sui/clmm/stats_pools
Content-Type: application/json

{
  "filter": "verified",
  "sortBy": "vol",
  "sortOrder": "desc",
  "limit": 20,
  "offset": 0,
  "keyword": "SUI",
  "walletAddress": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38"
}

响应数据结构

响应格式

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 599,
    "list": [
      {
        "pool": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "feeRate": 500,
        "showReverse": true,
        "coinA": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "coinB": {
          "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
          "symbol": "SUI",
          "decimals": 9,
          "isVerified": true,
          "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png"
        },
        "tvl": "2800340.18913129396075282",
        "totalApr": "0.4503930413374682",
        "stats": [
          {
            "dateType": "24H",
            "vol": "5796524.98260809771325342",
            "fee": "2898.262491304048856628",
            "apr": "0.3743557809980185"
          },
          {
            "dateType": "7D",
            "vol": "48131093.60452628836647983",
            "fee": "24065.546802263144183347",
            "apr": "0.4623911955072325"
          },
          {
            "dateType": "30D",
            "vol": "305029663.24252155690555337",
            "fee": "152514.831621260778453186",
            "apr": "0.594630401647667"
          }
        ],
        "miningRewarders": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "display": true,
            "apr": "0.0760372603394497",
            "emissionsPerSecond": "0.2314814814814815"
          }
        ],
        "vault": {
          "id": "0x24bf7840d179ea8b1b0543e496053727c98c0eb3e2c92d3c5b221c241c40125d",
          "category": "haedal",
          "display": true
        },
        "extensions": {
          "mining_display": true,
          "mining_rewarders_display": [true, true, true, true, true]
        }
      }
    ]
  }
}

响应字段说明

data 对象字段

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

list 数组项字段

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

coinA/coinB 对象字段

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

stats 数组项字段

字段名类型必填说明
dateTypestring时间段类型,如 "24H"(24 小时)、"7D"(7 天)、"30D"(30 天)
volstring交易量,字符串格式的数字
feestring手续费,字符串格式的数字
aprstring年化收益率,字符串格式的数字

miningRewarders 数组项字段

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

vault 对象字段

字段名类型必填说明
idstring金库 ID
categorystring金库类别,如 "haedal"
displayboolean是否显示

extensions 对象字段

字段名类型必填说明
mining_displayboolean是否显示挖矿信息
mining_rewarders_displayboolean[]挖矿奖励代币显示状态数组,对应 miningRewarders 数组的顺序

响应示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 599,
    "list": [
      {
        "pool": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "feeRate": 500,
        "showReverse": true,
        "coinA": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "coinB": {
          "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
          "symbol": "SUI",
          "decimals": 9,
          "isVerified": true,
          "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png"
        },
        "tvl": "2800340.18913129396075282",
        "totalApr": "0.4503930413374682",
        "stats": [
          {
            "dateType": "24H",
            "vol": "5796524.98260809771325342",
            "fee": "2898.262491304048856628",
            "apr": "0.3743557809980185"
          },
          {
            "dateType": "7D",
            "vol": "48131093.60452628836647983",
            "fee": "24065.546802263144183347",
            "apr": "0.4623911955072325"
          },
          {
            "dateType": "30D",
            "vol": "305029663.24252155690555337",
            "fee": "152514.831621260778453186",
            "apr": "0.594630401647667"
          }
        ],
        "miningRewarders": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "display": true,
            "apr": "0.0760372603394497",
            "emissionsPerSecond": "0.2314814814814815"
          }
        ],
        "vault": {
          "id": "0x24bf7840d179ea8b1b0543e496053727c98c0eb3e2c92d3c5b221c241c40125d",
          "category": "haedal",
          "display": true
        },
        "extensions": {
          "mining_display": true,
          "mining_rewarders_display": [true, true, true, true, true]
        }
      }
    ]
  }
}

注意事项

  1. 本接口使用 POST 方法,请求体为 JSON 格式
  2. 所有请求参数均为可选,可根据需要组合使用
  3. filter 参数目前支持 "verified" 值,用于筛选已验证的池子
  4. sortBy 参数支持多种排序字段,如 "vol"(交易量)、"tvl"(总锁定价值)、"apr"(年化收益率)等
  5. sortOrder 默认为 "desc"(降序),可设置为 "asc"(升序)
  6. limitoffset 用于分页,offset 从 0 开始
  7. keyword 用于关键字搜索,支持搜索代币符号或名称,如 "SUI"、"USDC" 等,会匹配池子中包含该代币的所有交易对
  8. walletAddress 用于查询指定钱包地址的仓位(我的仓位),传入钱包地址后,接口会返回该地址在池子中的持仓信息
  9. feeRate 单位为基点,1 基点 = 0.01%,如 500 表示 0.5%
  10. tvltotalAprvolfeeapr 等字段为字符串格式的数字,前端需要根据需要进行格式化显示
  11. stats 数组包含不同时间段的统计数据,前端可根据需要选择展示的时间段
  12. miningRewardersvault 字段可能为空或不存在,前端需要做兼容处理
  13. extensions.mining_rewarders_display 数组的长度和顺序对应 miningRewarders 数组
  14. total 字段表示符合条件的池子总数,可用于计算总页数
  15. 响应格式遵循 Cetus API 标准:code 为 0 表示成功,msg 为状态消息