Skip to content

奖励历史记录接口文档

接口信息

  • 接口路径: /api/earn/rewards-history
  • 请求方法: GET
  • 接口描述: 获取奖励历史记录列表,支持分页查询

请求参数

Query 参数

参数名类型必填说明
pageIndexnumber页码,从 1 开始,默认为 1
pageSizenumber每页数量,默认值根据接口实现而定
walletAddressstring钱包地址,用于查询指定用户的奖励历史

请求示例

bash
GET /api/earn/rewards-history?pageIndex=1&pageSize=20&walletAddress=0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38

响应数据结构

响应格式

json
{
  "code": 200,
  "message": "OK",
  "result": {
    "data": [
      {
        "amount": "420",
        "token": "WETH",
        "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
        "decimals": 9,
        "logoURL": "https://example.com/weth.png",
        "user": "0x1234...5678",
        "timestamp": 1764909625554
      }
    ],
    "nextPageIndex": 2,
    "total": 100
  }
}

响应字段说明

result 对象字段

字段名类型必填说明
dataarray奖励历史记录列表
nextPageIndexnumber下一页页码,无下一页为空
totalnumber总记录数

data 数组项字段

字段名类型必填说明
amountstring奖励数量,字符串格式的数字
tokenstring代币符号,如 "WETH"、"USDC"、"SUI"
coinTypestring代币的 Coin Type,完整类型标识符
decimalsnumber代币精度(小数位数)
logoURLstring代币图标 URL
userstring用户地址(可能为省略格式)
timestampnumber奖励时间戳(毫秒)

响应示例

json
{
  "code": 200,
  "message": "OK",
  "result": {
    "data": [
      {
        "amount": "420",
        "token": "WETH",
        "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
        "decimals": 9,
        "logoURL": "https://example.com/weth.png",
        "user": "0x1234...5678",
        "timestamp": 1764909625554
      },
      {
        "amount": "1250.5",
        "token": "USDC",
        "coinType": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
        "decimals": 6,
        "logoURL": "https://example.com/usdc.png",
        "user": "0xabcd...efgh",
        "timestamp": 1764822220000
      }
    ],
    "nextPageIndex": 2,
    "total": 100
  }
}

注意事项

  1. pageIndex 从 1 开始计数
  2. pageSize 为可选参数,默认值根据接口实现而定
  3. walletAddress 参数为可选,传入后可以查询指定用户的奖励历史
  4. nextPageIndex 不存在或为空时,表示没有下一页数据
  5. total 字段表示符合条件的总记录数,可用于计算总页数
  6. timestamp 为时间戳(毫秒),前端需要转换为可读的时间格式
  7. amount 为字符串格式的数字,前端需要根据代币的 decimals 进行格式化显示
  8. user 字段可能为省略格式(如 "0x1234...5678"),前端可直接使用
  9. logoURL 字段可能为空或不存在,前端需要做兼容处理
  10. 响应格式遵循 API 标准:code 为 200 表示成功,message 为状态消息