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

# REST API 概述

> AllTick REST API 文档包含 HTTP 接口 API、REST API 及其请求示例，覆盖 K 线、最新报价、盘口、股票产品信息和停复牌信息等行情数据接口。

## 概述

AllTick REST API 文档包含两套接口体系：

* **HTTP接口API**：按照官网 HTTP 接口文档组织，提供传统 HTTP 行情接口说明。
* **REST API**：基于 `/v1/...` 路径提供新版 REST 行情接口，使用 `X-API-Key` 请求头认证，并支持独立的接口调试页面。

HTTP接口API 和 REST API 的接口路径、认证方式及请求参数相互独立，请根据接入版本选择对应文档。

<CardGroup cols={2}>
  <Card title="REST API 请求示例" href="/apis/apis/zh/rest-api/rest-request-example">
    查看使用 X-API-Key 调用 REST API 的 Go、Java、PHP、Python 请求示例。
  </Card>

  <Card title="REST API" href="/apis/apis/zh/rest-api">
    查看新版 REST API 的单产品 K 线、批量 K 线、最新报价、盘口、股票信息和停复牌接口。
  </Card>

  <Card title="HTTP 请求示例" href="/apis/apis/zh/rest-api/http-request-example">
    查看 Go、Java、PHP、Python 的 REST API 请求示例。
  </Card>

  <Card title="HTTP接口API" href="/apis/apis/zh/rest-api/stock-http-interface-api">
    查看官网一致的 HTTP 接口说明和可调试接口页面。
  </Card>
</CardGroup>

## REST API 基础信息

REST API 使用以下请求头进行认证：

```http theme={null}
X-API-Key: YOUR_API_KEY
```

REST API 主要资源包括：

```text theme={null}
/v1/kline/{queryData}
/v1/batch-kline
/v1/quote                   # POST，JSON body
/v1/depth                   # POST，JSON body
/v1/stock-info
/v1/trading-status/{exchange}/{page}/{size}
```

## 接口地址

| 产品类型 | Base URL |
| - | - |
| 美股、港股、A股、大盘数据 | `https://quote.alltick.co/quote-stock-b-api` |
| 外汇、贵金属、加密货币、原油、CFD指数、商品 | `https://quote.alltick.co/quote-b-api` |

<script src="/apis/seo-keywords.js" />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.