# 查找和理解接口

## 按数据类别查找

[数据接口目录](../data/index.rst) 按股票、基金、债券、期货、指数、宏观等类别组织。也可使用页面搜索框输入关键词或完整接口名。

每条接口说明主要包含：

| 项目 | 调用时如何使用 |
| --- | --- |
| 接口 | HTTP 路径中的 `{item_id}`，例如 `stock_zh_a_hist` |
| 描述、限量 | 数据范围、来源和单次查询能力 |
| 输入参数 | 查询参数名称、取值和含义 |
| 输出参数 | 响应字段名称、类型和单位 |
| 接口示例、数据示例 | 常用参数组合与返回数据的形式 |

目录中的部分示例使用 Python SDK 表达调用方式。通过 HTTP 调用时，将“接口”填入 `/api/public/{item_id}`，并将函数的命名参数转为 URL 查询参数即可，无需安装 SDK。

例如，说明中的 `stock_zh_a_hist(symbol="000001", period="daily")` 对应：

```text
GET https://quantsource.cc/api/public/stock_zh_a_hist?symbol=000001&period=daily
```

使用客户端的参数编码功能传递中文、空格与特殊字符，完整规则见 [HTTP API 调用说明](../reference/http-api.md)。

## 确认 HTTP 接口可用性

在 [Swagger](https://quantsource.cc/api/docs) 中搜索接口名，找到对应的 `GET /api/public/接口名`，查看参数类型、默认值和必填项，再使用 **Try it out** 试调。

数据目录反映数据函数的说明，实际 HTTP 接口列表以 Swagger / OpenAPI 为准。某个接口出现在 Swagger 中表示已经注册，不保证在所有参数或所有时间都能获取数据；返回结果仍取决于数据源和网络状态。

## 选择正确的字段和单位

不同来源即使使用相近字段名，也可能使用不同的日期格式、价格复权方式和成交量单位。组合多个接口的数据前，先对照各自的“输出参数”和数据示例。

不确定参数是否正确时，先使用文档中的参数组合请求较小范围，再扩大日期范围或调整选项。常见异常的排查方法见 [调用常见问题](faq.md)。