Quote
Real-time candlestick (K-line) data push for subscribed securities. The callback fires whenever the current candlestick updates (Realtime mode) or when a candlestick period closes (Confirmed mode).
Tip
This page covers the push API (subscribe_candlesticks). To pull historical candlestick data on demand, see Candlestick - Pull.
message PushCandlestick {
string symbol = 1;
Period period = 2;
Candlestick candlestick = 3;
}
Quote Permission RequiredFree
- US stocks: US LV1 real-time quotes included free by default.
- HK stocks: LV1 real-time quotes included by default.
- Candlestick push requires the same permission as quote subscription.
Push fields
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Optional | Security code, for example: AAPL.US |
period | int32 | Optional | Candlestick period, see Period |
candlestick | object | Optional | Candlestick data |
└ close | string | Optional | Close price |
└ open | string | Optional | Open price |
└ high | string | Optional | High price |
└ low | string | Optional | Low price |
└ volume | int64 | Optional | Volume |
└ turnover | string | Optional | Turnover |
└ timestamp | int64 | Optional | Candlestick time (Unix timestamp) |
└ trade_session | int32 | Optional | Trade session, see TradeSession |
Response JSON example
{
"symbol": "700.HK",
"period": 1,
"candlestick": {
"close": "162.500",
"open": "160.000",
"high": "163.000",
"low": "159.800",
"volume": 123456,
"turnover": "19987654.000",
"timestamp": 1651103700,
"trade_session": 0
}
}