> 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/cai-wu-shu-ju.md).

# 财务数据

以下内容可直接复制到 GitBook 的「财务数据」首页：

## 财务数据

JKiData 财务数据 API 提供公司资料、公司详细信息、行业与板块表现以及 IPO 上市信息。开发者可以通过统一的 REST API，按国家、交易所、产品代码和语言获取相关数据。

### API 基础地址

```
http://jk:6600/api
```

> 当前使用 IP 地址提供服务，后续更换域名时，只需修改本页维护的基础地址。下面的接口页面仅展示相对路径。

### 功能列表

| 功能      | 接口路径                            | 说明                         |
| ------- | ------------------------------- | -------------------------- |
| 公司信息    | `/symbol_international_details` | 获取公司名称、简介、行业、板块、官方网站和总部等资料 |
| 公司详细信息  | `/symbol_details`               | 获取公司 Logo 等扩展资料            |
| 行业与板块表现 | `/performance_list`             | 获取指定国家的行业或板块表现数据           |
| IPO 列表  | `/ipo_listing`                  | 获取指定国家的 IPO 与上市信息          |

### 身份验证

所有请求都必须通过 `key` 参数传入有效的 API Key。

```
key=YOUR_API_KEY
```

请妥善保管 API Key，不要将真实密钥写入公开代码、前端页面或公共代码仓库。

### 通用请求方式

财务数据接口统一使用 HTTP `GET` 方法，请求参数通过 URL 查询字符串传递。

```
{BASE_URL}/{接口路径}?参数名称=参数值&key=YOUR_API_KEY
```

其中：

```
BASE_URL=http://jk:6600/api
```

### 常用参数

不同接口支持的参数有所不同，具体要求以对应接口页面为准。

| 参数         | 是否通用 | 说明                                |
| ---------- | ---- | --------------------------------- |
| `country`  | 是    | 国家代码，例如 `america`、`india`、`japan` |
| `exchange` | 部分接口 | 交易所代码，例如 `NASDAQ`、`NSE`           |
| `market`   | 部分接口 | 市场或交易所代码，是否使用请以接口页面为准             |
| `symbol`   | 部分接口 | 产品代码，例如 `AAPL`、`360ONE`           |
| `language` | 部分接口 | 返回内容的语言，例如 `en`、`hi`              |
| `type`     | 部分接口 | 数据类型，例如 `industry` 或 `sector`     |
| `fields`   | 可选   | 指定需要返回的扩展字段                       |
| `key`      | 是    | API 访问密钥                          |

> `country`、`exchange` 和 `language` 的可用值，请参考「市场 / 国家 / 语言参数说明」页面。

### 返回格式

接口返回 JSON 数据。通用响应结构如下：

```
{
  "status": 0,
  "message": "SUCCESS",
  "data": {},
  "total": 0,
  "page": 0,
  "market": "NASDAQ",
  "symbol": "AAPL",
  "code": "AAPL",
  "interval": null
}
```

部分列表接口的 `data` 为数组：

```
{
  "status": 0,
  "message": "SUCCESS",
  "data": []
}
```

#### 通用字段说明

| 字段         | 说明                  |
| ---------- | ------------------- |
| `status`   | 业务状态码，`0` 表示请求成功    |
| `message`  | 请求结果说明              |
| `data`     | 返回的业务数据，可能是对象或数组    |
| `total`    | 数据总数；部分接口可能返回 `0`   |
| `page`     | 当前页码；不分页的接口可能返回 `0` |
| `market`   | 返回数据对应的市场或交易所       |
| `symbol`   | 产品代码                |
| `code`     | 产品代码或内部标识           |
| `interval` | 数据周期；不适用时通常为 `null` |

### 使用说明

* 参数名称区分大小写，建议严格按照接口文档填写。
* 国家、交易所与产品代码必须正确对应。
* 不同国家和市场返回的字段可能存在差异，客户端应允许字段缺失或值为 `null`。
* `data` 的类型由接口决定，解析前应区分对象与数组。
* 请求失败时，应同时检查 HTTP 状态码、`status` 和 `message`。
* 生产环境建议设置连接超时、读取超时以及有限次数的失败重试。