跳到主要内容

REST 列表分页契约

适用于读侧 REST 的 GET 列表端点(历史 / 审计 / 行情列表等)。所有列表响应统一为 Paged{ "data": [...], "page": {...} }。契约变更历史见 接口变更清单 §4.2


1. 通用分页参数(query string)

参数默认说明
offset0起始位置;深分页上限 MAX_OFFSET = 1000(超过返回 400,改用 cursor
limit见 §3 各端点上限见 §3;超过会被截断到上限
include_totalfalsetrue 时才计算并返回 page.total(精确计数,低频场景用)
cursor上一页返回的 page.next_cursor,原样传回;传了 cursoroffset 被忽略

2. 响应 page 结构

{
"data": [],
"page": {
"offset": 0,
"limit": 50,
"total": 1234,
"next_cursor": "123:45",
"has_more": true
}
}
字段语义
offset / limit实际生效的分页位置与页大小
totalinclude_total=true 时出现;默认省略
next_cursor游标模式下存在下一页时返回;offset 模式为 null
has_more游标模式下返回 true/false;offset 模式为 null

3. 列表端点与游标格式

端点默认/上限 limit游标格式备注
GET /api/v1/blocks50 / 200height
GET /api/v1/envelopes25 / 200height:idx
GET /api/v1/fills50 / 200height:seq:is_taker
GET /api/v1/orders50 / 200closed_at_ms:order_idstatus=open 列表不支持游标,走 offset 分页
GET /api/v1/fund-flows50 / 200height:seq
GET /api/v1/bridge-flows50 / 200height:seq
GET /api/v1/positions50 / 200height:seq
GET /api/v1/account/events50 / 200height:seq
GET /api/v1/referral/events50 / 200height:seq
GET /api/v1/rebate/events50 / 200height:seq
GET /api/v1/blocks/{id}/events500 / 2000无(offset 分页)单块事件,天然有界
GET /api/v1/referral/referees50 / 200无(offset 分页)
GET /api/v1/referral/leaderboard50 / 200无(offset 分页)
GET /api/v1/leaderboard100 / 500无(offset 分页)排名上限 500,见 §5

游标字符串是 opaque 的:客户端必须把上一页的 next_cursor 原样传回,不要自行拼接。

4. 排行榜(GET /api/v1/leaderboard

  • 排名上限 LEADERBOARD_MAX_RANK = 500totaloffset 都被截断到 500 以内。
  • 排行数据由物化快照服务(每小时刷新):meta.as_of_timestamp_ms = 快照刷新时间;meta.as_of_height = 统计水位。
  • 例外:metric=equity & period=all 走节点内存热缓存,meta.source = "node"as_of 为热缓存刷新时间;其余 source = "local"