Quote
This API is used to obtain the trades data of security.
message SecurityTradeRequest {
string symbol = 1;
int32 count = 2;
}
message SecurityTradeResponse {
string symbol = 1;
repeated Trade trades = 2;
}
Quote Permission RequiredFree
- US stocks: US LV1 included free by default (last ~1,000 ticks across pre-market, regular, after-hours, and overnight sessions).
- HK stocks: LV1 included by default (last ~1,000 ticks).
- 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 |
count | int32 | Required | Count of trades; max 1000 per request |
Response fields
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Optional | Security code |
trades | object[] | Optional | Trades data |
└ price | string | Optional | Price |
└ volume | int64 | Optional | Volume |
└ timestamp | int64 | Optional | Time of trading |
└ trade_type | string | Optional | Trade type |
└ direction | int32 | Optional | Trade direction (0-neutral, 1-down, 2-up) |
└ trade_session | int32 | Optional | Trade session |
Response JSON example
{
"symbol": "AAPL.US",
"trades": [
{
"price": "158.760",
"volume": 1,
"timestamp": 1651103979,
"trade_type": "I",
"direction": 0,
"trade_session": 2
}
]
}