Skip to content

Latest commit

 

History

History
151 lines (117 loc) · 10.6 KB

File metadata and controls

151 lines (117 loc) · 10.6 KB

English | 中文

GET K-Line Query

GET /kline

Interface Description

This interface can be used to query historical K-line data, but it only allows querying one product at a time. It is recommended to cache the retrieved historical K-lines in a local database.
For clients using the HTTP interface to obtain K-lines, it is advisable to combine the /kline and /batch-kline interfaces as follows:
1、First, use the /kline interface to poll for historical data and store it in a local database. Subsequent historical data can be retrieved directly from the client's database without needing to make additional requests through the interface.
2、Then, continuously use the /batch-kline interface to request the latest two K-lines for multiple products in bulk and update the database with this data.
This method allows for quick updates of the latest K-lines while avoiding limitations on request frequency caused by frequent requests for historical K-lines.

Request Frequency

Text Text Text
Free Once every 10 seconds, only 1 request can be made 1、One request per second.
2、/batch-kline needs 10-second intervals.
3、Total of 10 requests per minute (every 6 seconds).
4、Max 1000 daily requests; excess resets at midnight.
Basic Only 1 request per second 1、One request per second.
2、/batch-kline: 1 request every 3 seconds.
3、Total of 60 requests per minute (1 request per second).
4、Max 86400 daily requests; excess resets at midnight.
Premium Up to 10 requests per second 1、Combined interfaces: 10 requests/second.
2、/batch-kline: 1 request/2 seconds.
3、Total: 600 requests/minute (10/second).
4、Daily limit: 864,000 requests; reset daily at midnight if exceeded.
Professional Up to 20 requests per second 1、Combined interfaces: 20 requests/second.
2、/batch-kline: 1 request/second interval.
3、Total: 1200 requests/minute (20/second).
4、Daily limit: 1,728,000 requests; reset daily at midnight if exceeded.
All HK Stocks Up to 20 requests per second 1、Combined interfaces: 20 requests/second.
2、/batch-kline: 1 request/second interval.
3、Total: 1200 requests/minute (20/second).
4、Daily limit: 1,728,000 requests; reset daily at midnight if exceeded.
All CN Stocks Up to 20 requests per second 1、Combined interfaces: 20 requests/second.
2、/batch-kline: 1 request/second interval.
3、Total: 1200 requests/minute (20/second).
4、Daily limit: 1,728,000 requests; reset daily at midnight if exceeded.

Interface Limitations

API Endpoints

1.US Stocks, Hong Kong Stocks, A Shares, Major Index Data API Endpoints:

  • Base Path: /quote-stock-b-api/kline
  • Full URL: https://quote.alltick.co/quote-stock-b-api/kline

2.Forex, Precious Metals, Cryptocurrencies, Commodities API Endpoints:

  • Base Path: /quote-b-api/kline

  • Full URL: https://quote.alltick.co/quote-b-api/kline

Request Examples

1.Request Example for US Stocks, Hong Kong Stocks, A Shares, Major Index Data:

When sending a query request, you must include the method name and token information. An example request is as follows: https://quote.alltick.co/quote-stock-b-api/kline?token=your_token&query=queryData

2.Request Example for Forex, Precious Metals, Cryptocurrencies, Commodities:

When sending a query request, you must include the method name and token information. An example request is as follows: https://quote.alltick.co/quote-b-api/kline?token=your_token&query=queryData

Request Parameters

Name Position Type Required Description
token query string No
query query string No See explanation for query request parameter below

Explanation for query request parameter

Encode the following JSON using URL encoding and assign it to the 'query' query string in the URL:

{
  "trace": "3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
  "data": {
    "code": "857.HK",
    "kline_type": 1,
    "kline_timestamp_end": 0,
    "query_kline_num": 2,
    "adjust_type": 0
  }
}

Query Request Parameters

Name Type Required Description
trace string Yes Trace code used for logging purposes, ensure uniqueness for each request
data object Yes
» code string Yes Refer to the code list and select the code you want to query:Click on the code list
Note: The case of the code value must be consistent with the code in the product list.
» kline_type integer Yes Type of K-line:
1、1 represents 1-minute K-line, 2 represents 5-minute K-line, 3 represents 15-minute K-line, 4 represents 30-minute K-line, 5 represents 1-hour K-line, 6 represents 2-hour K-line (not supported for stocks), 7 represents 4-hour K-line (not supported for stocks), 8 represents daily K-line, 9 represents weekly K-line, and 10 represents monthly K-line. (Note: Stocks do not support 2-hour and 4-hour K-lines.)
2、The shortest K-line supported is 1 minute
» kline_timestamp_end integer Yes Query K-lines from a specified time:
1、Send 0 to query from the latest trading day.
2、Send a timestamp to query from that time.
3、Only forex, precious metals, and cryptocurrencies support timestamps; stock codes do not
» query_kline_num integer Yes Number of K-lines to query, maximum of 500
» adjust_type integer Yes Adjustment type, effective only for stock codes, e.g., 0: ex-rights, 1: pre-adjustment, currently only supports 0

Response Example OK

{
  "ret": 200,
  "msg": "ok",
  "trace": "3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
  "data": {
    "code": "857.HK",
    "kline_type": 1,
    "kline_list": [
      {
        "timestamp": "1677829200",
        "open_price": "136.421",
        "close_price": "136.412",
        "high_price": "136.422",
        "low_price": "136.407",
        "volume": "0",
        "turnover": "0"
      },
      {
        "timestamp": "1677829260",
        "open_price": "136.412",
        "close_price": "136.401",
        "high_price": "136.415",
        "low_price": "136.397",
        "volume": "0",
        "turnover": "0"
      }
    ]
  }
}

Response Results

Status Code Status Code Meaning Description Data Model
200 OK OK Inline

Response Data Structure

Status Code 200

Name Type Required Constraints Chinese Name Description
» ret integer true
» msg string true
» trace string true
» data object true
»» code string true Code
»» kline_type integer true Type of K-line:
1、1 represents 1-minute K-line, 2 represents 5-minute K-line, 3 represents 15-minute K-line, 4 represents 30-minute K-line, 5 represents 1-hour K-line, 6 represents 2-hour K-line (not supported for stocks), 7 represents 4-hour K-line (not supported for stocks), 8 represents daily K-line, 9 represents weekly K-line, and 10 represents monthly K-line. (Note: Stocks do not support 2-hour and 4-hour K-lines.)
2、The shortest K-line supported is 1 minute
»» kline_list [object] true
»»» timestamp string true Timestamp of the K-line
»»» open_price string true Opening price of the K-line
»»» close_price string true Close price of the Kline:
1、During trading hours, for the latest Kline, this is also the last traded price.
2、During market closure, for the latest Kline, this is the official closing price.
»»» high_price string true Highest price of the K-line
»»» low_price string true Lowest price of the K-line
»»» volume string true Trading volume of the K-line
»»» turnover string true Trading turnover of the K-line