> For the complete documentation index, see [llms.txt](https://docscn.jkidata.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docscn.jkidata.com/jkidata.md).

# ✔JKidata

### JKiData 是什么

JKiData 是面向开发者、数据团队和金融应用的全球金融市场数据服务平台。

平台通过统一的 REST API 和 WebSocket 接口，提供交易产品、实时行情、历史 K 线、财务数据和财经新闻等服务，帮助开发者快速构建行情展示、数据分析、市场监控和量化研究应用。

> JKiData 各项数据服务均正常运行。接口文档、字段说明和多语言 Demo 将持续更新。

### 核心能力

#### 统一的数据接口

不同市场采用统一的接入方式和参数规范，减少开发者对接多个数据源的成本。

#### 全球市场覆盖

平台覆盖多个国家和地区的金融市场，包括：

* 亚洲：中国、香港、日本、韩国、印度、越南、印度尼西亚、马来西亚等
* 美洲：美国、巴西等
* 欧洲：德国及其他欧洲市场
* 中东与非洲：沙特、土耳其、南非、尼日利亚等

具体市场代码、产品代码和数据覆盖范围，请参阅“市场与参数说明”。

#### 实时与历史数据

平台同时提供实时数据和历史数据，适用于行情展示、策略研究、数据分析和市场监控等场景。

#### 多种接入方式

开发者可以根据业务需求选择 REST API 或 WebSocket。

### 接入方式

#### REST API

REST API 通过 HTTP 请求获取数据，适合按需查询和定时同步。

典型用途包括：

* 获取市场交易产品列表
* 查询一个或多个标的的实时行情
* 获取历史 K 线
* 获取公司和财务数据
* 查询市场新闻

当前行情接口包括：

| 功能     | 接口         | 响应格式 |
| ------ | ---------- | ---- |
| 交易产品列表 | `/product` | CSV  |
| 实时行情   | `/quote`   | JSON |
| 历史 K 线 | `/bars`    | CSV  |

API 基础地址只在文档首页维护，详细接口页仅展示相对路径，方便后续统一更新域名。

#### WebSocket API

WebSocket API 用于持续接收实时数据推送，适合需要低延迟更新的应用。

典型用途包括：

* 实时行情展示
* 价格变化监控
* 多标的行情订阅
* 量化策略数据接入
* 实时市场看板

连接、鉴权、订阅、取消订阅、心跳和重连方式，请参阅独立的 WebSocket 协议文档。

### 不同市场的数据字段和覆盖范围可能存在差异，具体内容以对应接口的实际响应为准。

### 推荐接入流程

1. 获取 API Key。
2. 阅读“快速开始”和参数说明。
3. 调用产品列表接口获取有效的 `market` 和 `symbol`。
4. 使用返回的产品代码请求实时行情或历史 K 线。
5. 实时更新场景使用 WebSocket 订阅。
6. 根据业务需要接入财务数据和新闻数据。

### 鉴权与安全

所有需要鉴权的接口均应携带有效的 API Key。

请遵循以下安全建议：

* API Key 仅保存在服务端环境变量中
* 不要将 API Key 写入前端代码
* 不要将 API Key提交到公开代码仓库
* 日志中应对 API Key 进行脱敏
* 为 HTTP 请求设置合理的超时时间
* 对临时网络错误实施有限次数的退避重试

### 响应处理

JKiData 接口可能返回 JSON 或 CSV。

客户端应根据对应接口文档解析响应体，不要只依赖 HTTP `Content-Type`。部分业务错误可能仍使用 HTTP `200` 返回，因此还需要检查响应体中的业务状态和错误信息。

详细处理方式请参阅“错误处理”页面。

### 使用说明

JKiData 提供的是金融市场数据服务，数据仅供开发、研究和信息展示使用，不构成任何投资建议。

使用者应自行评估数据是否符合具体业务需求，并遵守所在国家或地区的法律法规、交易所规则和数据使用要求。

### 下一步

首次接入建议按以下顺序阅读：

1. 快速开始
2. 市场与参数说明
3. REST API
4. WebSocket 协议
5. 错误处理
6. 技术支持