Coinfair 技术文档

Appearance

池子统计信息接口文档 ​

接口信息 ​

  • 接口路径: /api/v3/sui/histogram
  • 请求方法: GET
  • 接口描述: 获取池子的统计信息直方图数据，支持按不同数据类型和时间粒度查询

请求参数 ​

Query 参数 ​

参数名类型必填说明
dataTypestring是数据类型，如 "vol"（交易量）、"tvl"（总锁定价值）等
dateTypestring是时间粒度，如 "day"（按天）、"hour"（按小时）、"week"（按周）、"month"（按月）
beginTimestampnumber是开始时间戳（秒），用于指定查询的起始时间

请求示例 ​

bash
GET /api/v3/sui/histogram?dataType=vol&dateType=day&beginTimestamp=1762233664

响应数据结构 ​

响应格式 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "timestamp": 1764892800,
        "value": "21037436.575988"
      },
      {
        "timestamp": 1764806400,
        "value": "108356985.97334"
      },
      {
        "timestamp": 1764720000,
        "value": "113645248.717746"
      },
      {
        "timestamp": 1764633600,
        "value": "127451081.455791"
      },
      {
        "timestamp": 1764547200,
        "value": "159032404.704768"
      }
    ]
  }
}

响应字段说明 ​

data 对象字段 ​

字段名类型必填说明
listarray是统计数据列表

list 数组项字段 ​

字段名类型必填说明
timestampnumber是时间戳（秒），表示该数据点对应的时间
valuestring是统计值，字符串格式的数字，根据 dataType 不同表示不同的统计指标

参数说明 ​

dataType 参数说明 ​

dataType 用于指定要查询的统计数据类型，常见取值包括：

  • "vol": 交易量（Volume）
  • "tvl": 总锁定价值（Total Value Locked）
  • 其他类型根据实际接口实现而定

dateType 参数说明 ​

dateType 用于指定数据的时间粒度，常见取值包括：

  • "hour": 按小时统计
  • "day": 按天统计
  • "week": 按周统计
  • "month": 按月统计

beginTimestamp 参数说明 ​

beginTimestamp 为开始时间戳（秒），用于指定查询的起始时间点。接口会返回从该时间点开始到当前时间（或指定结束时间）的统计数据。

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "timestamp": 1764892800,
        "value": "21037436.575988"
      },
      {
        "timestamp": 1764806400,
        "value": "108356985.97334"
      },
      {
        "timestamp": 1764720000,
        "value": "113645248.717746"
      },
      {
        "timestamp": 1764633600,
        "value": "127451081.455791"
      },
      {
        "timestamp": 1764547200,
        "value": "159032404.704768"
      },
      {
        "timestamp": 1764460800,
        "value": "93874174.452891"
      },
      {
        "timestamp": 1764374400,
        "value": "62347100.211089"
      },
      {
        "timestamp": 1764288000,
        "value": "121570218.467925"
      },
      {
        "timestamp": 1764201600,
        "value": "91438377.401579"
      },
      {
        "timestamp": 1764115200,
        "value": "125263386.372897"
      }
    ]
  }
}

注意事项 ​

  1. dataType、dateType 和 beginTimestamp 参数均为必填项
  2. timestamp 为时间戳（秒），前端需要转换为可读的时间格式
  3. value 为字符串格式的数字，前端需要根据需要进行格式化显示
  4. list 数组中的数据按时间倒序排列（最新的数据在前）
  5. 数据点的时间间隔由 dateType 参数决定，例如 dateType=day 时，每个数据点代表一天的数据
  6. beginTimestamp 为秒级时间戳，注意与毫秒级时间戳的区别
  7. 返回的数据点数量取决于查询的时间范围和 dateType 的设置
  8. value 的具体含义取决于 dataType 的值，前端需要根据不同的 dataType 进行相应的展示和处理
  9. 响应格式遵循 Cetus API 标准：code 为 0 表示成功，msg 为状态消息
  10. 当查询的时间范围内没有数据时，list 可能为空数组