Skip to content

我的持仓列表接口文档

接口信息

  • 接口路径: /clmm/my_positions
  • 请求方法: POST
  • 接口描述: 获取指定钱包地址的流动性持仓列表,包含持仓基本信息、价格区间、未领取手续费等数据

请求参数

Request Body 参数

参数名类型必填说明
walletAddressstring钱包地址,用于查询指定钱包地址的持仓

请求示例

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

{
  "walletAddress": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38"
}

响应数据结构

响应格式

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "pool": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "feeRate": 500,
        "coinA": {
          "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
          "symbol": "SUI",
          "decimals": 9,
          "isVerified": true,
          "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png"
        },
        "coinB": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "liquidity": "1234.56",
        "priceRange": [0.95, 1.05],
        "inRange": true,
        "unclaimedFees": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "amount": "0.000972802",
            "usdValue": "0.00002271"
          },
          {
            "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
            "symbol": "SUI",
            "decimals": 9,
            "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png",
            "amount": "0.000010902",
            "usdValue": "0.00001538"
          },
          {
            "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
            "symbol": "USDC",
            "decimals": 6,
            "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h",
            "amount": "0.000006",
            "usdValue": "0.000005999"
          }
        ]
      },
      {
        "id": "0x24bf7840d179ea8b1b0543e496053727c98c0eb3e2c92d3c5b221c241c40125d",
        "pool": "0x24bf7840d179ea8b1b0543e496053727c98c0eb3e2c92d3c5b221c241c40125d",
        "feeRate": 2500,
        "coinA": {
          "coinType": "0x35551234567890abcdef1234567890abcdfcaf::weth::WETH",
          "symbol": "WETH",
          "decimals": 8,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/WETH_LOGO_URL"
        },
        "coinB": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "liquidity": "5678.90",
        "priceRange": [2800, 3200],
        "inRange": false,
        "unclaimedFees": [
          {
            "coinType": "0x35551234567890abcdef1234567890abcdfcaf::weth::WETH",
            "symbol": "WETH",
            "decimals": 8,
            "logoURL": "https://gateway.irys.xyz/WETH_LOGO_URL",
            "amount": "0.001234",
            "usdValue": "4.10"
          },
          {
            "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
            "symbol": "USDC",
            "decimals": 6,
            "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h",
            "amount": "0.000045",
            "usdValue": "0.000045"
          }
        ]
      }
    ]
  }
}

响应字段说明

data 对象字段

字段名类型必填说明
listarray持仓列表数据

list 数组项字段

字段名类型必填说明
idstring持仓唯一标识符(Position ID)
poolstring池子地址(Pool ID)
feeRatenumber手续费率,单位为基点(1 基点 = 0.01%),如 500 表示 0.5%
coinAobject代币 A 信息
coinBobject代币 B 信息
liquiditystring流动性价值,字符串格式的数字(USD)
priceRangenumber[]价格区间,数组格式,如 [0.95, 1.05] 表示 0.95 到 1.05
inRangeboolean当前价格是否在持仓的价格区间内
unclaimedFeesarray未领取的手续费列表

coinA/coinB 对象字段

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

priceRange 数组说明

priceRange 为包含两个数字的数组:

  • priceRange[0]: 价格区间下限
  • priceRange[1]: 价格区间上限
  • 价格表示方式为:coinA 相对于 coinB 的价格(即 1 个 coinA 等于多少个 coinB

unclaimedFees 数组项字段

字段名类型必填说明
coinTypestring手续费代币的 Coin Type
symbolstring手续费代币符号
decimalsnumber手续费代币精度(小数位数)
logoURLstring手续费代币图标 URL
amountstring未领取的手续费数量,字符串格式的数字
usdValuestring未领取的手续费对应的 USD 价值,字符串格式的数字

响应示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "pool": "0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab",
        "feeRate": 500,
        "coinA": {
          "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
          "symbol": "SUI",
          "decimals": 9,
          "isVerified": true,
          "logoURL": "https://archive.cetus.zone/assets/image/sui/sui.png"
        },
        "coinB": {
          "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
          "symbol": "USDC",
          "decimals": 6,
          "isVerified": true,
          "logoURL": "https://gateway.irys.xyz/EGpc2cG886CrWwLMneF2RyVpZ7D33a6znz6XE8n8nU7h"
        },
        "liquidity": "1234.56",
        "priceRange": [0.95, 1.05],
        "inRange": true,
        "unclaimedFees": [
          {
            "coinType": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
            "symbol": "CETUS",
            "decimals": 9,
            "logoURL": "https://gateway.irys.xyz/CCnXM1RwkcXE9n2wgc8umkp3VABnxmyHxMyUdytcrD5v",
            "amount": "0.000972802",
            "usdValue": "0.00002271"
          }
        ]
      }
    ]
  }
}

注意事项

  1. 本接口使用 POST 方法,请求体为 JSON 格式
  2. walletAddress 为必填参数,用于查询指定钱包地址的持仓
  3. 本接口不分页,直接返回该钱包地址的所有持仓数据
  4. feeRate 单位为基点,1 基点 = 0.01%,如 500 表示 0.5%
  5. liquidityamountusdValue 等字段为字符串格式的数字,前端需要根据需要进行格式化显示
  6. priceRange 为数组格式,包含两个数字,分别表示价格区间的下限和上限
    • 价格表示方式为:coinA 相对于 coinB 的价格(即 1 个 coinA 等于多少个 coinB
    • 例如:[0.95, 1.05] 表示 1 个 SUI 的价格在 0.95 到 1.05 个 USDC 之间
  7. inRange 字段表示当前市场价格是否在该持仓的价格区间内
    • true: 当前价格在价格区间内,持仓处于活跃状态
    • false: 当前价格超出价格区间,持仓处于非活跃状态
  8. unclaimedFees 数组可能为空,表示该持仓没有未领取的手续费
  9. unclaimedFees 中的代币可能包括交易对中的代币(coinAcoinB)以及其他奖励代币(如挖矿奖励代币)
  10. coinAcoinB 的顺序与池子中的代币顺序一致
  11. 响应格式遵循标准 API 格式:code 为 0 表示成功,msg 为状态消息
  12. 当钱包地址没有持仓时,list 为空数组