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

## 1. Overview

The AllTick REST API documentation covers K-lines, batch K-lines, latest order-book depth, latest trade prices, basic stock product information, and suspension and resumption queries.

## 2. Basic information

### 2.1 Base URL

| Product type                                                                      | Base URL                                     |
| --------------------------------------------------------------------------------- | -------------------------------------------- |
| US stocks, Hong Kong stocks, A-shares, and major indices                          | `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`       |

### 2.2 Authentication

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

### 2.3 Common request header

| Header      | Required | Description          |
| ----------- | -------- | -------------------- |
| `X-API-Key` | Yes      | Authentication token |

## 3. Resources and endpoints

```text theme={null}
/v1/kline                      # Single-product K-lines
/v1/batch-kline                # Batch K-lines
/v1/quote                      # Latest quote
/v1/depth                      # Latest order book
/v1/stock-info                 # Basic stock information
/v1/trading-status/sse         # SSE suspension and resumption
/v1/trading-status/nyse        # NYSE suspension and resumption
/v1/trading-status/nasdaq      # NASDAQ suspension and resumption
```

<CardGroup cols={2}>
  <Card title="4. Single-product K-lines" href="/apis/apis/en/rest-api/kline" />

  <Card title="5. Batch K-lines" href="/apis/apis/en/rest-api/batch-kline" />

  <Card title="6. Latest quote" href="/apis/apis/en/rest-api/trade-tick" />

  <Card title="7. Latest order book" href="/apis/apis/en/rest-api/depth-tick" />

  <Card title="8. Stock product information" href="/apis/apis/en/rest-api/static-info" />

  <Card title="9. Suspension and resumption" href="/apis/apis/en/rest-api/suspension" />
</CardGroup>