Submit Grid Order
grid_submitSubmit a grid trading order by first dry-running to get a preview and confirmation code, then re-calling with that code to place the live order after user confirmation.
Instructions
Submit a grid trading order. DRY RUN unless execute is the confirmation_code from its own dry run: call once without execute, show the preview, then re-call quoting the code only after the user confirms.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rth | No | Regular-trading-hours flag: 0 / 1 / 2. | |
| symbol | Yes | Security symbol, e.g. "700.HK". | |
| execute | No | The `confirmation_code` from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit `confirmation_code`, and nothing reaches the exchange. Required protocol: call once without `execute`, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative. | |
| expire_time | No | Expiry time in unix seconds (use with GTD). | |
| time_in_force | No | Time in force: 0 = Day, 1 = GTC, 6 = GTD. | |
| multiple_trigger | No | Whether one grid level may trigger multiple times. | |
| trigger_quantity | No | Quantity per trigger (decimal string). | |
| lower_limit_event | No | Action at lower bound: 1 = ignore (keep running), 2 = close at last price. | |
| lower_limit_price | No | Lower price bound (decimal string). | |
| support_shortsell | No | Whether short selling is allowed. | |
| trigger_buy_depth | No | Buy-side order-book depth (-5..5; 0 = use grid_order_type_down). | |
| trigger_spread_up | No | Upward trigger spread, absolute (decimal string; use with type 1). | |
| upper_limit_event | No | Action at upper bound: 1 = ignore (keep running), 2 = close at last price. | |
| upper_limit_price | No | Upper price bound (decimal string). | |
| grid_order_type_up | No | Sell-side order type when depth is 0: GMO / GLO / GTG. | |
| trigger_percent_up | No | Upward trigger percent (decimal string; use with type 2). | |
| trigger_price_type | No | Trigger price type: 1 = spread (absolute), 2 = percent. | |
| trigger_sell_depth | No | Sell-side order-book depth (-5..5; 0 = use grid_order_type_up). | |
| settlement_currency | Yes | Settlement currency, e.g. "HKD". | |
| trigger_spread_down | No | Downward trigger spread, absolute (decimal string; use with type 1). | |
| grid_order_type_down | No | Buy-side order type when depth is 0: GMO / GLO / GTG. | |
| lower_limit_quantity | No | Quantity handled when the lower bound is reached (decimal string). | |
| submitted_base_price | No | Base price the grid is anchored to (decimal string). | |
| trigger_percent_down | No | Downward trigger percent (decimal string; use with type 2). | |
| upper_limit_quantity | No | Quantity handled when the upper bound is reached (decimal string). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | Yes | ||
| preview | No | ||
| order_id | No | ||
| next_step | No |