> ## 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 Overview

> Learn REST API Overview for AllTick REST API, including HTTP request patterns, interface list, parameters, response fields and runnable debug modules for US stocks, Hong Kong stocks, A-shares, forex, crypto, and commodities market data.

## Overview

The AllTick REST API documentation includes two interface systems:

* **HTTP Interface API**: the legacy HTTP market-data interfaces organized according to the official API documentation.
* **REST API**: the newer `/v1/...` REST endpoints using the `X-API-Key` request header and independent debug pages.

The two systems have independent paths, authentication methods, and request parameters. Choose the documentation that matches your integration version.

> **[REST API Request Example](https://alltick.co/apis/apis/en/rest-api/rest-request-example.md)**
>
> View Go, Java, PHP, and Python examples using the REST API and X-API-Key authentication.

> **[REST API](https://alltick.co/apis/apis/en/rest-api)**
>
> View K-line, quote, depth, stock information, and trading-status REST API endpoints.

> **[HTTP Request Example](https://alltick.co/apis/apis/en/rest-api/http-request-example.md)**
>
> View REST API request examples for Go, Java, PHP, and Python.

> **[HTTP Interface API](https://alltick.co/apis/apis/en/rest-api/stock-http-interface-api.md)**
>
> View official-documentation-consistent HTTP interface descriptions and debuggable interface pages.

## REST API Basics

REST API requests use the following authentication header:

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

Key REST API resources include:

```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}
```

## Interface Addresses

| Product Type | Base URL |
| - | - |
| US stocks, Hong Kong stocks, A shares, and major index data | `https://quote.alltick.co/quote-stock-b-api` |
| Forex, precious metals, cryptocurrencies, crude oil, CFD indices, and commodities | `https://quote.alltick.co/quote-b-api` |


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