GET /depth-tick
Interface Description
The following is the maximum order book depth for each product type:- For inactive products, the available depth may be smaller than the maximum listed below. This is normal.
- One side of the order book may be empty. For example, when a stock reaches its limit up or limit down price, one side of the order book may be empty.
| Item | Forex, Precious Metals, Crude Oil | Cryptocurrencies | Hong Kong Stocks | US Stocks | A Shares |
|---|---|---|---|---|---|
| Depth Description | Up to 1 level | Up to 5 levels | Up to 10 levels | Up to 1 level | Up to 5 levels |
Request Frequency
| Plan | Individual Request | Multiple HTTP Interfaces Requested Together |
|---|---|---|
| Free | One request every 10 seconds | 1. Only one interface request every 10 seconds. 2. When requesting multiple interfaces, note that /batch-kline requires a 10-second interval. 3. All interfaces combined: maximum 10 requests per minute (one every 6 seconds). 4. Maximum 1,000 requests per day; usage resumes after midnight the next day if exceeded. |
| Basic | One request per second | 1. Only one interface request in the same second. 2. When requesting multiple interfaces, note that /batch-kline requires a 3-second interval. 3. All interfaces combined: maximum 60 requests per minute (one per second). 4. Maximum 86,400 requests per day; usage resumes after midnight the next day if exceeded. |
| Premium | Up to 10 requests per second | 1. All interfaces combined: up to 10 requests per second. 2. When requesting multiple interfaces, note that /batch-kline requires a 2-second interval. 3. All interfaces combined: maximum 600 requests per minute (10 per second). 4. Maximum 864,000 requests per day; usage resumes after midnight the next day if exceeded. |
| Professional | Up to 20 requests per second | 1. All interfaces combined: up to 20 requests per second. 2. When requesting multiple interfaces, note that /batch-kline requires a 1-second interval. 3. All interfaces combined: maximum 1,200 requests per minute (20 per second). 4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded. |
| All Hong Kong Stocks | Up to 20 requests per second | 1. All interfaces combined: up to 20 requests per second. 2. When requesting multiple interfaces, note that /batch-kline requires a 1-second interval. 3. All interfaces combined: maximum 1,200 requests per minute (20 per second). 4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded. |
| All A Shares | Up to 20 requests per second | 1. All interfaces combined: up to 20 requests per second. 2. When requesting multiple interfaces, note that /batch-kline requires a 1-second interval. 3. All interfaces combined: maximum 1,200 requests per minute (20 per second). 4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded. |
| All US Stocks | Up to 20 requests per second | 1. All interfaces combined: up to 20 requests per second. 2. When requesting multiple interfaces, note that /batch-kline requires a 1-second interval. 3. All interfaces combined: maximum 1,200 requests per minute (20 per second). 4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded. |
Interface Limitations
- Be sure to read: HTTP Interface Restrictions
- Be sure to read: Error Code Description
API Endpoints
1. US Stocks, Hong Kong Stocks, A Shares, and Major Index Data:- Base Path:
/quote-stock-b-api/depth-tick - Full URL: https://quote.alltick.co/quote-stock-b-api/depth-tick
- Base Path:
/quote-b-api/depth-tick - Full URL: https://quote.alltick.co/quote-b-api/depth-tick
Request Examples
1. US Stocks, Hong Kong Stocks, A Shares, and Major Index Data: When sending a query request, include the method name and token information. Example: https://quote.alltick.co/quote-stock-b-api/depth-tick?token=your_token&query=queryData 2. Forex, Precious Metals, Cryptocurrencies, Crude Oil, CFD Indices, and Commodities: When sending a query request, include the method name and token information. Example: https://quote.alltick.co/quote-b-api/depth-tick?token=your_token&query=queryDataRequest Parameters
| Name | Position | Type | Required | Description |
|---|---|---|---|---|
| token | query | string | No | |
| query | query | string | No | See the query request parameter description. |
Query Request Parameters
URL-encode the following JSON and assign it to thequery query string in the URL.
| Name | Type | Required | Description |
|---|---|---|---|
| trace | string | Yes | |
| data | object | Yes | |
| » symbol_list | [object] | Yes | |
| »» code | string | No | Code. Select the code you want to query from the code list. Note: The code value is case-sensitive and must match the code in the product list. |
Response Example
Response Result
| Status Code | Status Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | OK | Inline |
| Name | Type | Required | Description |
|---|---|---|---|
| » ret | integer | true | Return code |
| » msg | string | true | Message corresponding to the return code |
| » trace | string | true | Request trace |
| » data | object | true | |
| »» tick_list | [object] | true | |
| »»» code | string | false | Code |
| »»» seq | string | false | Quote sequence number |
| »»» tick_time | string | false | Quote timestamp |
| »»» bids | [object] | false | Bid list |
| »»»» price | string | false | Price |
| »»»» volume | string | false | Volume |
| »»» asks | [object] | false | Ask list |
| »»»» price | string | false | Price |
| »»»» volume | string | false | Volume. 1. Some CFD indices do not provide volume. 2. Forex, precious metals, energy, stocks, and cryptocurrencies all provide volume. |
AllTick Website
Official website: https://alltick.co/
Interface Debug
Open GET /depth-tick Debug Module
Use the debuggable module to fill in parameters and send requests.