Appearance
池子列表接口文档
接口信息
- 接口路径:
/api/v3/sui/clmm/stats_pools - 请求方法:
POST - 接口描述: 获取池子列表,支持按筛选条件、排序方式和关键字搜索查询
请求参数
Request Body 参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| filter | string | 否 | 筛选条件,如 "verified"(仅显示已验证的池子) |
| sortBy | string | 否 | 排序字段,如 "vol"(交易量)、"tvl"(总锁定价值)、"apr"(年化收益率)等 |
| sortOrder | string | 否 | 排序顺序,"asc"(升序)或 "desc"(降序),默认为 "desc" |
| limit | number | 否 | 每页数量,默认值根据接口实现而定 |
| offset | number | 否 | 偏移量,用于分页,从 0 开始 |
| keyword | string | 否 | 关键字搜索,用于搜索包含指定代币符号或名称的池子,如 "SUI"、"USDC" 等 |
| walletAddress | string | 否 | 钱包地址,用于查询指定钱包地址的仓位(我的仓位),如 "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 对象字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| total | number | 是 | 符合条件的池子总数 |
| list | array | 是 | 池子列表数据 |
list 数组项字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pool | string | 是 | 池子地址(Pool ID) |
| feeRate | number | 是 | 手续费率,单位为基点(1 基点 = 0.01%),如 500 表示 0.5% |
| showReverse | boolean | 是 | 是否显示反向交易对 |
| coinA | object | 是 | 代币 A 信息 |
| coinB | object | 是 | 代币 B 信息 |
| tvl | string | 是 | 总锁定价值(Total Value Locked),字符串格式的数字 |
| totalApr | string | 是 | 总年化收益率,字符串格式的数字 |
| stats | array | 是 | 统计数据数组,包含不同时间段的交易量、手续费和 APR |
| miningRewarders | array | 否 | 挖矿奖励代币列表 |
| vault | object | 否 | 金库信息 |
| extensions | object | 否 | 扩展信息 |
coinA/coinB 对象字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| coinType | string | 是 | 代币的 Coin Type,完整类型标识符 |
| symbol | string | 是 | 代币符号,如 "USDC"、"SUI" |
| decimals | number | 是 | 代币精度(小数位数) |
| isVerified | boolean | 是 | 是否已验证 |
| logoURL | string | 否 | 代币图标 URL |
stats 数组项字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dateType | string | 是 | 时间段类型,如 "24H"(24 小时)、"7D"(7 天)、"30D"(30 天) |
| vol | string | 是 | 交易量,字符串格式的数字 |
| fee | string | 是 | 手续费,字符串格式的数字 |
| apr | string | 是 | 年化收益率,字符串格式的数字 |
miningRewarders 数组项字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| coinType | string | 是 | 奖励代币的 Coin Type |
| symbol | string | 是 | 奖励代币符号 |
| decimals | number | 是 | 奖励代币精度(小数位数) |
| logoURL | string | 否 | 奖励代币图标 URL |
| display | boolean | 是 | 是否显示 |
| apr | string | 是 | 该奖励代币的年化收益率,字符串格式的数字 |
| emissionsPerSecond | string | 是 | 每秒释放量,字符串格式的数字 |
vault 对象字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 金库 ID |
| category | string | 是 | 金库类别,如 "haedal" |
| display | boolean | 是 | 是否显示 |
extensions 对象字段
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mining_display | boolean | 否 | 是否显示挖矿信息 |
| mining_rewarders_display | boolean[] | 否 | 挖矿奖励代币显示状态数组,对应 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]
}
}
]
}
}注意事项
- 本接口使用 POST 方法,请求体为 JSON 格式
- 所有请求参数均为可选,可根据需要组合使用
filter参数目前支持 "verified" 值,用于筛选已验证的池子sortBy参数支持多种排序字段,如 "vol"(交易量)、"tvl"(总锁定价值)、"apr"(年化收益率)等sortOrder默认为 "desc"(降序),可设置为 "asc"(升序)limit和offset用于分页,offset从 0 开始keyword用于关键字搜索,支持搜索代币符号或名称,如 "SUI"、"USDC" 等,会匹配池子中包含该代币的所有交易对walletAddress用于查询指定钱包地址的仓位(我的仓位),传入钱包地址后,接口会返回该地址在池子中的持仓信息feeRate单位为基点,1 基点 = 0.01%,如 500 表示 0.5%tvl、totalApr、vol、fee、apr等字段为字符串格式的数字,前端需要根据需要进行格式化显示stats数组包含不同时间段的统计数据,前端可根据需要选择展示的时间段miningRewarders和vault字段可能为空或不存在,前端需要做兼容处理extensions.mining_rewarders_display数组的长度和顺序对应miningRewarders数组total字段表示符合条件的池子总数,可用于计算总页数- 响应格式遵循 Cetus API 标准:
code为 0 表示成功,msg为状态消息