API 接口文档
Signal Feed 提供完整的金融数据 API,支持 A 股、ETF、宏观、市场、资讯等维度。各域文档已按功能分组拆页,每页给出路径、入参说明与响应 JSON 示例(字段以线上为准)。
基础信息
- Base URL:
http://localhost:4000/api/v1(生产环境以实际部署为准) - 认证:需携带 API Key。可通过请求头
x-api-key、Authorization: Bearer加令牌,或查询参数x-api-key传递 - 数据格式:除另有说明外为
application/json - OpenAPI:本地运行
trade-signal-feed时可访问服务根路径重定向后的/docs查看交互式文档与 Schema
接口分类
- 股票接口 - A股 — 列表、详情、K 线、选股、财务、股东、监管与诊断等
- 基金接口 - ETF — 列表、选股、K 线、持仓与资产配置等
- 宏观接口 — PMI、CPI、GDP、货币供应量等分页与序列
- 市场接口 — 大盘指数、板块资金流、热力图、交易日历等
- 资讯接口 — 市场概览、题材库、要闻、快讯、专题流等
通用说明
部分列表接口支持 page、pageSize 等分页参数,具体以各接口页为准;并非所有列表均支持 sortBy、sortOrder 或 fields[]。
统一响应体
业务控制器返回值会经全局拦截器包装为:
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
data | object / array / null | 业务数据;结构见各接口页的响应示例 |
message | string | 可选;失败或非预期时的人类可读说明 |
失败时仍可能返回 HTTP 200 且 success: false;流式接口(如 text/event-stream)不经过上述 JSON 包装,以对应接口页说明为准。
认证与请求示例
详见 快速开始 中的认证与调用示例。
错误处理
除统一外壳外,HTTP 4xx/5xx 与业务错误信息以实际响应与 OpenAPI 描述为准。
Last updated on