NumCat
...
快速开始

返回结构

这里统一说明数据中心平台列表型查询的标准返回结构。目标是让不同接口的返回数据有一致的阅读方式和消费方式。

当前公共标准只保留最小必要字段，不把业务扩展信息混进基础结构。

也就是说，这里只规范code、message、data以及列表数据里的fields / items / total / offset / limit。

标准示例

{
  "code": 200,
  "message": "success",
  "data": {
    "fields": [
      "tradeDate",
      "code",
      "stockName"
    ],
    "items": [
      ["20260316", "000001", "平安银行"],
      ["20260316", "600519", "贵州茅台"]
    ],
    "total": 125,
    "offset": 0,
    "limit": 50
  }
}

阅读规则

1.items[n][i]对应fields[i]。

2.total表示完整结果总数，不一定等于当前页items.length。

3. 分页协议统一使用offset / limit，不直接使用页码。

外层结构

字段
类型
说明
code
number
请求结果状态码。200 表示成功。
message
string
请求结果说明。成功时通常为 success。
data
object
业务数据主体。列表型查询统一放在这里。

列表数据结构

字段
类型
说明
fields
string[]
字段名定义，决定每一列的业务含义和顺序。
items
array[]
二维数组数据，每一行按 fields 顺序返回。
total
number
总条数，表示过滤排序后的完整结果总量。
offset
number
当前结果起始位置，对应请求里的 offset。
limit
number
当前结果条数上限，对应请求里的 limit。

不放入公共标准的字段

以下字段不作为公共返回结构的必选项：ok、timestamp、latestTradeDate、tradeDates、page、totalPages。

如果某个接口确实需要这些字段，应作为业务扩展字段单独说明，而不是写进平台公共标准。