Quote
This API is used to obtain the candlestick data of security.
message SecurityCandlestickRequest {
string symbol = 1;
Period period = 2;
int32 count = 3;
AdjustType adjust_type = 4;
int32 trade_session = 5;
}
message SecurityCandlestickResponse {
string symbol = 1;
repeated Candlestick candlesticks = 2;
}
Quote Permission RequiredFree
- Quota-based access: 100–3,000 unique symbols per calendar month depending on account tier (resets monthly; see quota table in the docs).
- US stocks: US LV1 included free by default (pre-market, regular, after-hours, and overnight sessions).
- HK stocks: LV1 included by default.
- US options: no permission by default — purchase "OPRA US Options Quotes (OpenAPI)".
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security code, in ticker.region format, e.g. 700.HK |
period | int32 | Required | Candlestick period |
count | int32 | Required | Count of candlestick; max 1000 |
adjust_type | int32 | Required | Adjustment type |
trade_session | int32 | Optional | Trading session, 0: intraday, 100: All (pre, intraday, post, overnight) |
Response fields
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Optional | Security code, e.g. AAPL.US |
candlesticks | object[] | Optional | Candlestick data |
└ close | string | Optional | Close price |
└ open | string | Optional | Open price |
└ low | string | Optional | Low price |
└ high | string | Optional | High price |
└ volume | int64 | Optional | Volume |
└ turnover | string | Optional | Turnover |
└ timestamp | int64 | Optional | Timestamp |
└ trade_session | int32 | Optional | Trade session |
Response JSON example
{
"symbol": "700.HK",
"candlesticks": [
{
"close": "362.000",
"open": "364.600",
"low": "361.600",
"high": "368.800",
"volume": 10853604,
"turnover": "3954556819.000",
"timestamp": 1650384000
}
]
}