SSPARKDATAAPI
REFERENCEv1.5.0STABLE
← 首页中文 / EN

●OPENAPI 3.1 · CONTRACT FIRST

把每一次调用的
边界都讲清楚。

从认证、参数到流式响应，所有内容均由当前 OpenAPI 契约生成。页面适合快速查阅，YAML 仍是机器可读的唯一事实来源。

32个操作
20条路径
42个模型
●快速开始HTTPS

第一条可信行情请求

租户密钥使用 Bearer 认证。响应中的 meta 会同时说明数据来源、缓存状态与生成时间。

curl --request GET \
+  'https://test.spark-data.cn/v1/market-data/quotes/latest?symbols=XSHG%3A600570' \
+  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
下载 OpenAPI YAML↓

00 / 认证

两类密钥，清晰分权。

业务查询使用以 spk_ 开头的租户 API Key；租户、配额与密钥管理使用仅保存在服务端 Secret 中的管理员 Key。公开健康检查无需认证。

Authorization: Bearer YOUR_API_KEY
01

系统System

Kubernetes 存活检查与依赖就绪检查。

2 个接口
GET/health/live检查服务进程是否存活
操作 ID
getLiveness
认证
公开

参数

此操作没有参数。

响应

200

服务进程存活

application/json · Health
cURL
curl --request GET \
  'https://test.spark-data.cn/health/live'
GET/health/ready检查 MySQL 与 Redis 是否就绪
操作 ID
getReadiness
认证
公开

参数

此操作没有参数。

响应

200

依赖已就绪

application/json · Health
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/health/ready'
02

控制面Control Plane

仅供运维人员管理租户、配额与 API Key。

7 个接口
GET/v1/admin/tenants列出租户
操作 ID
listTenants
认证
管理员 API Key

参数

此操作没有参数。

响应

200

租户列表

application/json · TenantsResponse
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/admin/tenants' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/admin/tenants创建租户并设置服务限额
操作 ID
createTenant
认证
管理员 API Key

参数

此操作没有参数。

请求体

必填

application/json · CreateTenant

响应

201

租户已创建

application/json · TenantResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
409

资源当前状态不允许执行此操作

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/admin/tenants' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/admin/tenants/{tenant_id}获取租户
操作 ID
getTenant
认证
管理员 API Key

参数

tenant_idpath
string<uuid>必填

—

响应

200

已找到租户

application/json · TenantResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/admin/tenants/TENANT_ID' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
PATCH/v1/admin/tenants/{tenant_id}更新租户状态或限额
操作 ID
updateTenant
认证
管理员 API Key

参数

tenant_idpath
string<uuid>必填

—

请求体

必填

application/json · UpdateTenant

响应

200

租户已更新

application/json · TenantResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
409

资源当前状态不允许执行此操作

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request PATCH \
  'https://test.spark-data.cn/v1/admin/tenants/TENANT_ID' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/admin/tenants/{tenant_id}/api-keys列出 API Key 元数据，不返回密钥
操作 ID
listApiKeys
认证
管理员 API Key

参数

tenant_idpath
string<uuid>必填

—

响应

200

API Key 元数据列表

application/json · ApiKeysResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/admin/tenants/TENANT_ID/api-keys' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/admin/tenants/{tenant_id}/api-keys签发 API Key，明文仅返回一次
操作 ID
createApiKey
认证
管理员 API Key

参数

tenant_idpath
string<uuid>必填

—

请求体

必填

application/json · CreateApiKey

响应

201

API Key 已签发

application/json · IssuedApiKeyResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
409

资源当前状态不允许执行此操作

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/admin/tenants/TENANT_ID/api-keys' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
DELETE/v1/admin/tenants/{tenant_id}/api-keys/{api_key_id}立即吊销 API Key
操作 ID
revokeApiKey
认证
管理员 API Key

参数

tenant_idpath
string<uuid>必填

—

api_key_idpath
string<uuid>必填

—

响应

204

API Key 已吊销

400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request DELETE \
  'https://test.spark-data.cn/v1/admin/tenants/TENANT_ID/api-keys/API_KEY_ID' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
03

证券资料Instruments

规范化的股票、ETF 与指数主数据资源。

1 个接口
GET/v1/instruments/{instrument_id}获取规范化股票、ETF 或指数资料
操作 ID
getInstrument
认证
租户 API Key

参数

instrument_idpath
InstrumentId必填

—示例: XSHG:600570

响应

200

已找到证券

application/json · InstrumentResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/instruments/XSHG:600570' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
04

行情数据Market Data

带缓存的最新行情、K 线与尽力而为的行情流。

3 个接口
GET/v1/market-data/bars查询股票、ETF 或指数的完整周期 OHLCV K 线

start 为闭区间，end 为开区间，默认返回 JSON。发送 Accept: application/x-ndjson 时，每行返回一根 K 线，最后附带 stream_end 控制记录。日内 K 线由数据源累计行情快照采样生成并标记为 snapshot_derived；日线来自数据源 OHLCV，ETF 与指数长周期由真实日线聚合并标记为 daily_derived。

操作 ID
listBars
认证
租户 API Key

参数

symbolsquery
InstrumentId[]必填

逗号分隔的规范证券 ID，数量受租户限额约束。示例: ["XSHG:600570","XSHE:000001"]

startquery
string<date-time>必填

UTC 闭区间起始时间。

endquery
string<date-time>必填

UTC 开区间结束时间，范围受租户限额约束。

timeframequery
BarTimeframe可选

—

adjustmentquery
raw | forward | backward可选

ETF 与指数 K 线只接受 raw。示例: raw

feedquery
auto | realtime | delayed可选已弃用

兼容性路由提示；当前部署的数据源提供一个 feed。示例: auto

sortquery
asc | desc可选

—示例: asc

响应

200

K 线 JSON 或 NDJSON 数据流

application/json · BarsResponse / application/x-ndjson · BarStreamRecord
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/market-data/bars?symbols=XSHG%3A600570%2CXSHE%3A000001&start=2026-07-01T00%3A00%3A00Z&end=2026-08-01T00%3A00%3A00Z' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
GET/v1/market-data/quotes/latest获取多只股票、ETF 或指数的最新行情
操作 ID
getLatestQuotes
认证
租户 API Key

参数

symbolsquery
InstrumentId[]必填

逗号分隔的规范证券 ID，数量受租户限额约束。示例: ["XSHG:600570","XSHE:000001"]

feedquery
auto | realtime | delayed可选已弃用

兼容性路由提示；当前部署的数据源提供一个 feed。示例: auto

响应

200

最新行情

application/json · QuotesResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/market-data/quotes/latest?symbols=XSHG%3A600570%2CXSHE%3A000001' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
GET/v1/market-data/stream通过 SSE 推送尽力而为的最新行情

推送 quote、heartbeat 与 reconnect 事件。当前版本不提供持久化和回放，新连接从当前行情开始。常规 OpenAPI HTTP operation 已同时描述请求与单向 SSE 响应，因此无需单独维护 AsyncAPI 契约。

操作 ID
streamMarketData
认证
租户 API Key

参数

symbolsquery
InstrumentId[]必填

逗号分隔的规范证券 ID，数量受租户限额约束。示例: ["XSHG:600570","XSHE:000001"]

feedquery
auto | realtime | delayed可选已弃用

兼容性路由提示；当前部署的数据源提供一个 feed。示例: auto

heartbeat_secondsquery
integer可选

—示例: 20

响应

200

SSE 行情流

text/event-stream · MarketEvent
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/market-data/stream?symbols=XSHG%3A600570%2CXSHE%3A000001' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
05

Agent 上下文Agent Context

由可复用缓存资源组装的 Agent 复合视图。

1 个接口
GET/v1/agent/context/{instrument_id}获取单只股票、ETF 或指数的完整缓存上下文

在一个适合 Agent 使用的响应中组合证券身份、最新行情与指定 K 线。接口不会创建单体缓存，而是复用规范化的单证券行情缓存和按时间分片的 K 线缓存，因此不同用户的重叠请求可以共享命中。省略 start 与 end 时，返回最多最近 365 个自然日的数据，并受租户 K 线范围限制；覆盖默认范围时两个时间参数必须同时提供。规范字段旁会原样保留数据源字段。

操作 ID
getAgentContext
认证
租户 API Key

参数

instrument_idpath
InstrumentId必填

—示例: XSHG:600570

startquery
string<date-time>可选

UTC 闭区间起始时间，必须与 end 同时提供。

endquery
string<date-time>可选

UTC 开区间结束时间，必须与 start 同时提供。

timeframequery
BarTimeframe可选

—

adjustmentquery
raw | forward | backward可选

ETF 与指数 K 线只接受 raw。示例: raw

sortquery
asc | desc可选

—示例: asc

响应

200

由可复用缓存资源组装的 Agent 上下文

application/json · AgentContextResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
404

资源不存在

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/agent/context/XSHG:600570' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
06

聚合数据Aggregate Data

九个面向 Agent 的能力接口，覆盖公开目录中的全部 371 个 operation。

18 个接口
GET/v1/discovery列出发现与筛选 operation 的精确契约
操作 ID
describeDiscovery
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/discovery' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/discovery调用发现或筛选 operation
操作 ID
queryDiscovery
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/discovery' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/entities列出实体资料 operation 的精确契约
操作 ID
describeEntities
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/entities' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/entities调用实体或参考数据 operation
操作 ID
queryEntities
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/entities' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/market-data列出行情 operation 的精确契约
操作 ID
describeMarketData
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/market-data' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/market-data调用统一行情 operation
操作 ID
queryMarketData
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/market-data' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/fundamentals列出基本面 operation 的精确契约
操作 ID
describeFundamentals
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/fundamentals' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/fundamentals调用基本面或预测 operation
操作 ID
queryFundamentals
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/fundamentals' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/ownership列出股权与持仓 operation 的精确契约
操作 ID
describeOwnership
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/ownership' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/ownership调用股权或组合 operation
操作 ID
queryOwnership
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/ownership' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/events列出事件与风险 operation 的精确契约
操作 ID
describeEvents
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/events' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/events调用事件、公司行动或风险 operation
操作 ID
queryEvents
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/events' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/analytics列出分析 operation 的精确契约
操作 ID
describeAnalytics
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/analytics' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/analytics调用分析、估值或排行 operation
操作 ID
queryAnalytics
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/analytics' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/economy列出宏观经济 operation 的精确契约
操作 ID
describeEconomy
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/economy' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/economy调用宏观、区域或行业经济 operation
操作 ID
queryEconomy
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/economy' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
GET/v1/content列出内容 operation 的精确契约
操作 ID
describeContent
认证
租户 API Key

参数

operationquery
string可选

区分大小写的 operation 名称；省略时列出该能力下的全部 operation。

响应

200

所选能力下由工作簿生成的精确契约

application/json · OperationContractsResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request GET \
  'https://test.spark-data.cn/v1/content' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY'
POST/v1/content调用研报、公告、新闻或政策 operation
操作 ID
queryContent
认证
租户 API Key

参数

此操作没有参数。

请求体

operation 必须属于公开目录中分配给该能力的 operation；parameters 必须使用准确的契约字段名。枚举参数可传字典 code、caption、reference code 或 A 股规范 ID，SparkData 会解析并校验实际发送给上游的 code。

application/json · AggregateQuery

响应

200

完整上游响应、已解析枚举输入与缓存元数据

application/json · AggregateResponse
400

请求无效

application/problem+json · Problem
401

API Key 缺失、格式错误、过期、已吊销或无法识别

application/problem+json · Problem
403

API Key 缺少所需权限范围

application/problem+json · Problem
429

租户 API Key 已超过速率限制

application/problem+json · Problem
503

MySQL、Redis 或上游依赖不可用

application/problem+json · Problem
cURL
curl --request POST \
  'https://test.spark-data.cn/v1/content' \
  --header 'Authorization: Bearer $SPARKDATA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"operation_code","params":{}}'
07

数据模型

OpenAPI 契约中的可复用 Schema。展开即可查看字段、类型与必填性。

42 个模型
Healthobject
字段类型
statusstring必填
InstrumentIdstring

Canonical MIC-prefixed ID for a supported mainland equity, ETF, or index.

字段类型
Decimalstring
字段类型
BarTimeframe1m | 5m | 15m | 30m | 1h | 1d | 1w | 1mo | 1q | 1y
字段类型
CacheStatushit | miss | mixed | bypass
字段类型
ResponseMetaobject
字段类型
request_idstring<uuid>必填
schema_versionstring必填
cache_statusCacheStatus必填
sourcesparkdata-market-data | sparkdata-control-plane必填
generated_atstring<date-time>必填
Tenantobject
字段类型
idstring<uuid>必填
namestring必填
statusactive | suspended必填
requests_per_minuteinteger必填
max_symbols_per_requestinteger必填
max_bar_range_daysinteger必填
created_atstring<date-time>必填
updated_atstring<date-time>必填
CreateTenantobject
字段类型
namestring必填
requests_per_minuteinteger可选
max_symbols_per_requestinteger可选
max_bar_range_daysinteger可选
UpdateTenantobject
字段类型
namestring可选
statusactive | suspended可选
requests_per_minuteinteger可选
max_symbols_per_requestinteger可选
max_bar_range_daysinteger可选
ApiKeyobject
字段类型
idstring<uuid>必填
tenant_idstring<uuid>必填
namestring必填
key_prefixstring必填 · 用于识别密钥的非敏感前缀。
scopesmarket-data:read[]必填
statusactive | revoked必填
expires_atstring,null<date-time>必填
created_atstring<date-time>必填
revoked_atstring,null<date-time>必填
IssuedApiKeyobject
字段类型
CreateApiKeyobject
字段类型
namestring必填
scopesmarket-data:read[]可选
expires_atstring,null<date-time>可选
Instrumentobject
字段类型
instrument_idInstrumentId必填 · Canonical MIC-prefixed ID for a supported mainland equity, ETF, or index.
symbolstring必填
namestringnull必填
company_namestringnull必填
micXSHG | XSHE | XBSE必填
asset_classequity | etf | index必填
currencystring必填
timezonestring必填
statusstring必填
industrystringnull必填
conceptsstring[]必填
provider_dataProviderData必填
ProviderDataobject
字段类型
operationstring必填 · 公开数据源契约或字典服务中的准确 operation 名称。
rawobject必填 · 生成该记录时使用的完整上游 envelope、单行或多行数据，不做裁剪。
Capabilitydiscovery | entities | market_data | fundamentals | ownership | events | analytics | economy | content
字段类型
ContractDataTypestring | string_array | number | number_array | date | date_array
字段类型
InputContractobject
字段类型
namestring必填 · SparkData 接受的公开参数名。
upstream_namestring必填 · 发送给真实上游的准确字段名。
display_namestring必填
data_typeContractDataType必填
descriptionstring必填
requiredboolean必填
enum_groupstringnull必填 · 工作簿将输入标记为枚举时使用的实时字典组。
enum_declarationstringnull必填 · 工作簿中未经修改的枚举声明。
fixed_valuestringnull必填 · 工作簿标记为固定传、由 SparkData 自动补入的值。
OutputContractobject
字段类型
namestring必填
display_namestring必填
data_typeContractDataType必填
descriptionstring必填
OperationContractobject
字段类型
api_idinteger必填
sheet_namestring必填
display_namestring必填
operationstring必填
descriptionstring必填
methodstring必填
pathstring必填
capabilityCapability必填
last_modifiedstring必填
inputsInputContract[]必填
outputsOutputContract[]必填
OperationContractsResponseobject
字段类型
metaResponseMeta必填
dataOperationContract[]必填
AggregateQueryobject
字段类型
operationstring必填 · 区分大小写的 Excel operation 名称，例如 FinancialStatement。
parametersobject可选 · 准确的 Excel 输入字段名和值；未声明字段会被拒绝。
EnumResolutionobject
字段类型
fieldstring必填
group_namestring必填
inputobject必填
codestring必填
captionstringnull必填
provider_dataProviderData必填
AggregateDataobject
字段类型
api_idinteger必填
capabilityCapability必填
operationstring必填
resolved_parametersobject必填 · 补入固定值并完成枚举解析后实际发送给上游的请求。
enum_resolutionsEnumResolution[]必填
provider_dataProviderData必填
AggregateResponseobject
字段类型
metaResponseMeta必填
dataAggregateData必填
PriceLevelobject
字段类型
priceDecimal必填
sizeDecimal必填
Quoteobject
字段类型
instrument_idInstrumentId必填 · Canonical MIC-prefixed ID for a supported mainland equity, ETF, or index.
event_timestring<date-time>必填
last_priceDecimal必填
previous_closeDecimal必填
openDecimal必填
highDecimal必填
lowDecimal必填
changeDecimal | null必填
change_percentDecimal | null必填
volumeDecimal必填
turnoverDecimal必填
trade_statusstring必填
bid_levelsPriceLevel[]必填
ask_levelsPriceLevel[]必填
provider_dataProviderData必填
Barobject
字段类型
instrument_idInstrumentId必填 · Canonical MIC-prefixed ID for a supported mainland equity, ETF, or index.
event_timestring<date-time>必填 · 区间的 UTC 起始时间。
trading_datestring,null<date>必填 · 上游交易日或周期结束日；派生日内 K 线为 null。
timeframeBarTimeframe必填
openDecimal必填
highDecimal必填
lowDecimal必填
closeDecimal必填
previous_closeDecimal | null必填
volumeDecimal必填
turnoverDecimal | null必填
trade_countintegernull必填
suspendedboolean必填
adjustmentraw | forward | backward必填 · ETF 与指数 K 线只接受 raw。
aggregation_sourceprovider | snapshot_derived | daily_derived必填
provider_dataProviderData必填
StreamControlobject
字段类型
control_typestream_end | heartbeat | reconnect必填
request_idstring<uuid>必填
event_timestring<date-time>必填
records_sentinteger可选
MarketEventQuote | StreamControl
字段类型
BarStreamRecordBar | StreamControl
字段类型
AgentContextobject
字段类型
instrument_idInstrumentId必填 · Canonical MIC-prefixed ID for a supported mainland equity, ETF, or index.
instrumentInstrument必填
latest_quoteQuote | null必填
barsBar[]必填
upstream_operationsstring[]必填
AgentContextResponseobject
字段类型
metaResponseMeta必填
dataAgentContext必填
InstrumentResponseobject
字段类型
metaResponseMeta必填
dataInstrument必填
InstrumentResponseObjectobject
字段类型
metaResponseMeta必填
dataInstrument必填
BarsResponseobject
字段类型
metaResponseMeta必填
dataBar[]必填
QuotesResponseobject
字段类型
metaResponseMeta必填
dataQuote[]必填
TenantResponseobject
字段类型
metaResponseMeta必填
dataTenant必填
TenantsResponseobject
字段类型
metaResponseMeta必填
dataTenant[]必填
ApiKeysResponseobject
字段类型
metaResponseMeta必填
dataApiKey[]必填
IssuedApiKeyResponseobject
字段类型
metaResponseMeta必填
dataIssuedApiKey必填
InvalidParameterobject
字段类型
namestring必填
reasonstring必填
Problemobject
字段类型
typestring<uri-reference>必填
titlestring必填
statusinteger必填
detailstring必填
request_idstring<uuid>必填
codestring必填
invalid_parametersInvalidParameter[]必填