Skip to main content

GET /depth-tick

Interface Description

The following is the maximum order book depth for each product type:
  1. For inactive products, the available depth may be smaller than the maximum listed below. This is normal.
  2. 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.
ItemForex, Precious Metals, Crude OilCryptocurrenciesHong Kong StocksUS StocksA Shares
Depth DescriptionUp to 1 levelUp to 5 levelsUp to 10 levelsUp to 1 levelUp to 5 levels

Request Frequency

PlanIndividual RequestMultiple HTTP Interfaces Requested Together
FreeOne request every 10 seconds1. 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.
BasicOne request per second1. 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.
PremiumUp to 10 requests per second1. 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.
ProfessionalUp to 20 requests per second1. 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 StocksUp to 20 requests per second1. 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 SharesUp to 20 requests per second1. 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 StocksUp to 20 requests per second1. 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

  1. Be sure to read: HTTP Interface Restrictions
  2. Be sure to read: Error Code Description

API Endpoints

1. US Stocks, Hong Kong Stocks, A Shares, and Major Index Data: 2. Forex, Precious Metals, Cryptocurrencies, Crude Oil, CFD Indices, and Commodities:

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=queryData

Request Parameters

NamePositionTypeRequiredDescription
tokenquerystringNo
queryquerystringNoSee the query request parameter description.

Query Request Parameters

URL-encode the following JSON and assign it to the query query string in the URL.
{
  "trace": "edd5df80-df7f-4acf-8f67-68fd2f096426",
  "data": {
    "symbol_list": [
      {
        "code": "857.HK"
      },
      {
        "code": "UNH.US"
      }
    ]
  }
}
NameTypeRequiredDescription
tracestringYes
dataobjectYes
» symbol_list[object]Yes
»» codestringNoCode. 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

{
  "ret": 200,
  "msg": "ok",
  "trace": "edd5df80-df7f-4acf-8f67-68fd2f096426",
  "data": {
    "tick_list": [
      {
        "code": "857.HK",
        "seq": "30686349",
        "tick_time": "1677830357227",
        "bids": [
          {
            "price": "136.424",
            "volume": "100000.00"
          }
        ],
        "asks": [
          {
            "price": "136.427",
            "volume": "400000.00"
          }
        ]
      }
    ]
  }
}

Response Result

Status CodeStatus MeaningDescriptionData Model
200OKOKInline
NameTypeRequiredDescription
» retintegertrueReturn code
» msgstringtrueMessage corresponding to the return code
» tracestringtrueRequest trace
» dataobjecttrue
»» tick_list[object]true
»»» codestringfalseCode
»»» seqstringfalseQuote sequence number
»»» tick_timestringfalseQuote timestamp
»»» bids[object]falseBid list
»»»» pricestringfalsePrice
»»»» volumestringfalseVolume
»»» asks[object]falseAsk list
»»»» pricestringfalsePrice
»»»» volumestringfalseVolume.
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.