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=. |
Submit a grid strategy order. The grid places buy orders as the price falls and sell orders as it rises, within the [lower_limit_price, upper_limit_price] band anchored to submitted_base_price.
Before using grid trading you must record the strategy risk-disclosure consent once — see Submit Strategy Questionnaire.
# Submit a percent-triggered grid on 700.HK
longbridge grid submit 700.HK --currency HKD --base-price 300 --upper-price 360 --lower-price 240 --trigger-type percent --trigger-up 2 --trigger-down 2 --quantity 100 --upper-quantity 200 --lower-quantity 100 --order-type GMO --tif gtc
# Validate the rule without submitting
longbridge grid submit 700.HK --currency HKD --base-price 300 --upper-price 360 --lower-price 240 --trigger-type percent --trigger-up 2 --trigger-down 2 --quantity 100 --upper-quantity 200 --lower-quantity 100 --order-type GMO --tif gtc --dry-run
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, `ticker.region` format, example: `700.HK` |
settlement_currency | string | Required | Settlement currency, example: `HKD` |
grid_trading_rule | object | Required | The grid rule. Fields below. |
grid_trading_rule.submitted_base_price | string | Required | Base price the grid is anchored to |
grid_trading_rule.upper_limit_price | string | Required | Upper price bound |
grid_trading_rule.lower_limit_price | string | Required | Lower price bound |
grid_trading_rule.trigger_price_type | integer | Required | How trigger thresholds are interpreted. **Enum Value:**, `1` - spread (absolute), `2` - percent |
grid_trading_rule.trigger_spread_up | string | Optional | Upward trigger spread, required when `trigger_price_type` is `1` |
grid_trading_rule.trigger_spread_down | string | Optional | Downward trigger spread, required when `trigger_price_type` is `1` |
grid_trading_rule.trigger_percent_up | string | Optional | Upward trigger percent, required when `trigger_price_type` is `2` |
grid_trading_rule.trigger_percent_down | string | Optional | Downward trigger percent, required when `trigger_price_type` is `2` |
grid_trading_rule.trigger_buy_quantity | string | Required | Buy quantity per trigger |
grid_trading_rule.trigger_sell_quantity | string | Required | Sell quantity per trigger |
grid_trading_rule.time_in_force | integer | Required | Time in force. **Enum Value:**, `0` - Day, `1` - GTC (Good-Til-Canceled), `6` - GTD (Good-Til-Date) |
grid_trading_rule.expire_time | integer | Optional | Expiry time (Unix timestamp, in seconds), required when `time_in_force` is `6` (GTD) |
grid_trading_rule.upper_limit_event | integer | Optional | Action when the upper bound is reached. **Enum Value:**, `1` - ignore (keep running), `2` - close position at last price |
grid_trading_rule.lower_limit_event | integer | Optional | Action when the lower bound is reached. **Enum Value:**, `1` - ignore (keep running), `2` - close position at last price |
grid_trading_rule.trigger_sell_depth | integer | Optional | Sell-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_up` instead of a depth level |
grid_trading_rule.trigger_buy_depth | integer | Optional | Buy-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_down` instead of a depth level |
grid_trading_rule.grid_order_type_up | string | Optional | Sell-side order type when `trigger_sell_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |
grid_trading_rule.grid_order_type_down | string | Optional | Buy-side order type when `trigger_buy_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |
grid_trading_rule.multiple_trigger | boolean | Optional | Whether a single grid level may trigger multiple times |
grid_trading_rule.support_shortsell | boolean | Optional | Whether short selling is allowed |
grid_trading_rule.rth | integer | Optional | Regular-trading-hours flag (`0` / `1` / `2`) |
Response
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"order_id": "764609681686573056"
}
}Error code
See the Error Codes page for the full list of error codes.