Trade
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Query the full detail of a single grid order, including its rule, paged executed sub-orders (grid_sub_orders), and paged lifecycle history (grid_order_history).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Required | Grid order ID, example: `764609681686573056` |
history_id | string | Optional | Cursor for paging the lifecycle history. Pass the last `history_id` of a page to fetch older entries. |
limit | integer | Optional | Page size for `grid_sub_orders` and `grid_order_history` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Required | Grid order ID |
symbol | string | Required | Security symbol, `ticker.region` format |
stock_name | string | Required | Security name |
status | string | Required | Grid order status, example: `Performing` / `Suspended` |
grid_status | string | Required | Detailed grid running status |
suspend_reason | string | Required | Reason the grid is suspended, empty when running |
sleeping_reason | string | Required | Reason the grid is dormant, empty when active |
submitted_base_price | string | Required | Base price the grid was anchored to at submission |
current_base_price | string | Required | Current base price after triggers |
upper_limit_price | string | Required | Upper price bound |
lower_limit_price | string | Required | Lower price bound |
trigger_price_type | int32 | Required | How trigger thresholds are interpreted. **Enum Value:**, `1` - spread (absolute), `2` - percent |
trigger_spread_up | string | Required | Upward trigger spread (when `trigger_price_type` is `1`) |
trigger_spread_down | string | Required | Downward trigger spread (when `trigger_price_type` is `1`) |
trigger_percent_up | string | Required | Upward trigger percent (when `trigger_price_type` is `2`) |
trigger_percent_down | string | Required | Downward trigger percent (when `trigger_price_type` is `2`) |
pullback_percent | string | Required | Pullback percent |
pullback_spread | string | Required | Pullback spread |
rebound_percent | string | Required | Rebound percent |
rebound_spread | string | Required | Rebound spread |
multiple_trigger | boolean | Required | Whether a single grid level may trigger multiple times |
time_in_force | int32 | Required | Time in force. **Enum Value:**, `0` - Day, `1` - GTC, `6` - GTD |
trigger_quantity | string | Required | Quantity per trigger |
trigger_sell_quantity | string | Required | Cumulative quantity triggered on the sell side |
trigger_buy_quantity | string | Required | Cumulative quantity triggered on the buy side |
upper_limit_quantity | string | Required | Quantity handled when the upper bound is reached |
lower_limit_quantity | string | Required | Quantity handled when the lower bound is reached |
upper_limit_event | int32 | Required | Action at the upper bound. **Enum Value:**, `1` - ignore, `2` - close position at last price |
lower_limit_event | int32 | Required | Action at the lower bound. **Enum Value:**, `1` - ignore, `2` - close position at last price |
trigger_sell_depth | int32 | Required | Sell-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_up` |
trigger_buy_depth | int32 | Required | Buy-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_down` |
created_at | string | Required | Creation time, RFC3339 format |
updated_at | string | Required | Last update time, RFC3339 format |
settlement_currency | string | Required | Settlement currency, example: `HKD` |
expire_time | string | Required | Expiry time, RFC3339 format (when `time_in_force` is GTD) |
gtd | string | Required | Good-Til-Date, `YYYY-MM-DD` format |
grid_sub_orders | object[] | Optional | Executed sub-orders for this grid |
└ id | string | Required | Sub-order ID |
└ price | string | Required | Order price |
└ order_type | string | Required | Order type |
└ quantity | string | Required | Order quantity |
└ executed_qty | string | Required | Executed quantity |
└ action | int32 | Required | Buy/sell direction |
└ status | string | Required | Sub-order status |
└ submitted_at | string | Required | Submission time, RFC3339 format |
└ rth | int32 | Required | Regular-trading-hours flag (`0` / `1` / `2`) |
sub_has_more | boolean | Required | Whether more sub-orders can be paged |
grid_order_history | object[] | Optional | Lifecycle history entries |
└ history_id | string | Required | History entry ID, also used as the paging cursor |
└ created_at | string | Required | Event time, RFC3339 format |
└ suspend_reason | string | Required | Suspend reason, when applicable |
└ reason | string | Required | Human-readable description of the event |
history_has_more | boolean | Required | Whether more history entries can be paged via `history_id` |
support_shortsell | boolean | Required | Whether short selling is allowed |
rth | int32 | Required | Regular-trading-hours flag (`0` / `1` / `2`) |
grid_order_type_up | string | Required | Sell-side order type when `trigger_sell_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |
grid_order_type_down | string | Required | Buy-side order type when `trigger_buy_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"order_id": "764609681686573056",
"symbol": "700.HK",
"stock_name": "TENCENT",
"status": "Performing",
"grid_status": "Performing",
"suspend_reason": "",
"sleeping_reason": "",
"submitted_base_price": "300",
"current_base_price": "300",
"upper_limit_price": "360",
"lower_limit_price": "240",
"trigger_price_type": 2,
"trigger_spread_up": "",
"trigger_spread_down": "",
"trigger_percent_up": "2",
"trigger_percent_down": "2",
"pullback_percent": "",
"pullback_spread": "",
"rebound_percent": "",
"rebound_spread": "",
"multiple_trigger": false,
"time_in_force": 1,
"trigger_quantity": "100",
"trigger_sell_quantity": "0",
"trigger_buy_quantity": "0",
"upper_limit_quantity": "200",
"lower_limit_quantity": "100",
"upper_limit_event": 1,
"lower_limit_event": 1,
"trigger_sell_depth": 0,
"trigger_buy_depth": 0,
"created_at": "2024-08-12T10:30:00+08:00",
"updated_at": "2024-08-12T10:30:00+08:00",
"settlement_currency": "HKD",
"expire_time": "",
"gtd": "",
"grid_sub_orders": [],
"sub_has_more": false,
"grid_order_history": [
{
"history_id": "764609681686573100",
"created_at": "2024-08-12T10:30:00+08:00",
"status": "Performing",
"suspend_reason": "",
"reason": "Grid order started"
}
],
"history_has_more": false,
"support_shortsell": false,
"rth": 0,
"grid_order_type_up": "GMO",
"grid_order_type_down": "GMO"
}
}Error code
See the Error Codes page for the full list of error codes.