> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tickflow.org/llms.txt
> Use this file to discover all available pages before exploring further.

# API 概述

> TickFlow API 认证与使用说明

## 认证方式

所有 API 接口需要通过 `x-api-key` 请求头传递 API Key 进行认证：

```bash theme={null}
curl -H "x-api-key: your-api-key" https://api.tickflow.org/v1/klines?symbol=600000.SH
```

<Warning>
  请妥善保管您的 API Key，不要在客户端代码中暴露。
</Warning>

## 速率限制

根据 API Key 配置，可能会有请求频率限制。超出限制时返回 `429 Too Many Requests`。

## 批量查询

部分接口同时支持 GET 和 POST 方法：

* **GET**: 通过 URL 参数传递，适合少量数据
* **POST**: 通过 JSON Body 传递，适合大批量查询，不受 URL 长度限制

## API 版本

当前 API 版本为 `v1`，所有接口路径以 `/v1` 开头。

例如：`https://api.tickflow.org/v1/klines`

## OpenAPI 规范

完整的 OpenAPI 规范文件可通过以下地址获取：

```
https://api.tickflow.org/openapi.json
```

<Tip>
  你可以在接下来的页面中交互式地查看和测试每一个 API。
</Tip>