> 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/kuai-su-kai-shi.md).

# 快速开始

JKiData 提供全球金融市场行情、历史数据、财务数据和新闻数据。开发者可以通过 REST API 或 WebSocket 接入服务。

本页介绍基本的接入流程，具体请求参数和代码示例请查看对应的接口文档。

### 第一步：获取 API Key

使用 JKiData 服务前，需要先获取 API Key。

API Key 用于：

* 验证用户身份
* 判断接口访问权限
* 管理请求配额
* 识别不同的应用

请妥善保管 API Key，不要将其写入前端代码、公开仓库或公开日志。

### 第二步：确定目标市场

调用数据接口前，需要先确定目标国家或市场。

不同接口可能使用以下参数：

| 参数         | 说明        |
| ---------- | --------- |
| `market`   | 市场代码      |
| `country`  | 国家或地区代码   |
| `language` | 返回文本使用的语言 |
| `symbol`   | 交易产品代码    |
| `key`      | API Key   |

具体支持的市场、国家和语言，请查看“市场、国家与语言参数说明”。

### 第三步：获取产品代码

行情请求需要使用有效的产品代码 `symbol`。

建议先获取目标市场的交易产品列表，然后从返回结果中取得产品代码。不要自行拼接或猜测 `symbol`，因为不同市场的代码格式可能不同。

产品信息通常包括：

* 市场代码
* 产品代码
* 产品名称
* 产品类型

### 第四步：选择接入方式

#### REST API

适用于按需查询数据的场景，例如：

* 获取交易产品列表
* 查询最新行情
* 获取历史 K 线
* 查询公司和财务数据
* 获取财经新闻

#### WebSocket

适用于持续接收实时数据的场景，例如：

* 实时行情展示
* 多产品价格监控
* 行情看板
* 量化交易系统
* 实时数据处理

连接、鉴权、订阅、心跳和重连方式，请查看 WebSocket 协议文档。

### 第五步：选择数据服务

JKiData 提供以下主要数据模块：

| 数据模块      | 主要用途         |
| --------- | ------------ |
| 交易产品      | 获取市场支持的产品和代码 |
| 实时行情      | 获取最新价格和交易数据  |
| 历史 K 线    | 获取不同周期的历史行情  |
| WebSocket | 接收实时行情推送     |
| 财务数据      | 获取公司资料和财务信息  |
| 新闻数据      | 获取财经新闻和市场事件  |

所有服务均正常运行。不同市场的数据范围和字段可能存在差异，具体内容以对应接口文档为准。

### 接入建议

* 首次使用时，先阅读参数说明
* 使用产品列表返回的 `symbol`
* 根据业务场景选择 REST API 或 WebSocket
* 在服务端安全保存 API Key
* 为请求设置合理的超时时间
* 同时检查网络状态和业务响应
* 对低频变化的数据进行适当缓存

### 下一步

建议按照以下顺序继续阅读：

1. 市场、国家与语言参数说明
2. 行情与财务数据说明
3. REST API 协议说明
4. WebSocket 协议说明
5. 财务数据
6. 新闻数据
7. 错误码说明