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=. |
This API is used to submit order for HK and US stocks, warrant and option.
longbridge order buy TSLA.US 100 --price 250.00
longbridge order sell TSLA.US 100 --price 260.00
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Stock symbol, use `ticker.region` format, example: `AAPL.US` |
order_type | string | Required | Order Type. One of: `LO`, `ELO`, `MO`, `AO`, `ALO`, `ODD`, `LIT`, `MIT`, `TSLPAMT`, `TSLPPCT`, `SLO`. |
submitted_price | string | Optional | Submitted price, example: `388.5`. `LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required |
submitted_quantity | string | Required | Submitted quantity, example: `100`. US stocks accept fractional quantities, such as `0.05`. Fractional US orders must set `outside_rth` to `RTH_ONLY`; otherwise the order is rejected with error code `603200`. |
trigger_price | string | Optional | Trigger price, example: `388.5`. `LIT` / `MIT` Order Required |
limit_offset | string | Optional | Limit offset amount. `TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 |
trailing_amount | string | Optional | Trailing amount. `TSLPAMT` Order Required |
trailing_percent | string | Optional | Trailing percent. `TSLPPCT` Order Required |
expire_date | string | Optional | Long term order expire date, format `YYYY-MM-DD`, example: `2022-12-05`. Required when `time_in_force` is `GTD` |
side | string | Required | Order Side. **Enum Value:**, `Buy`, `Sell` |
outside_rth | string | Optional | Enable or disable outside regular trading hours. **Enum Value:**, `RTH_ONLY` - regular trading hour only, `ANY_TIME` - any time, `OVERNIGHT` - Overnight, `OPTION_PRE_MARKET` - Overnight option |
time_in_force | string | Required | Time in force Type. **Enum Value:**, `Day` - Day Order, `GTC` - Good Til Canceled Order, `GTD` - Good Til Date Order |
remark | string | Optional | remark (Maximum 255 characters) |
limit_depth_level | integer | Optional | Specifies the bid/ask depth level. Value range is -5 ~ 0 ~ 5. Negative numbers indicate bid levels (e.g. -1 means best bid level 1), positive numbers indicate ask levels (e.g. 1 means best ask level 1). When set to 0, the `limit_offset` parameter takes effect. Valid for `TSLPAMT` / `TSLPPCT` orders |
monitor_price | string | Optional | Monitoring price. Monitoring starts only after reaching this price, updating the reference price. Valid for `TSLPAMT` / `TSLPPCT` orders |
trigger_count | integer | Optional | Number of triggers. Value range is 0 ~ 3. Specifies that within 1 minute, the order will only be placed after being triggered multiple times. Valid for `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` orders |
client_request_id | string | Optional | Idempotent request ID for preventing duplicate order submissions. The server caches this request ID for 10 minutes. If a request with the same ID is received within this period, it returns the same response without creating a duplicate order. Must be a unique identifier (e.g., UUID). |
attached_params | object | Optional | Attached order parameters (take-profit / stop-loss) |
attached_params.attached_order_type | string | Optional | Attached order type. **Enum Value:**, `PROFIT_TAKER` - Take Profit, `STOP_LOSS` - Stop Loss, `BRACKET` - Bracket Order |
attached_params.profit_taker_price | string | Optional | Take-profit trigger price |
attached_params.stop_loss_price | string | Optional | Stop-loss trigger price |
attached_params.time_in_force | string | Optional | Attached order time in force type. **Enum Value:**, `Day` - Day Order, `GTC` - Good Til Canceled Order, `GTD` - Good Til Date Order (inherits the main order's `expire_date` in this case) |
attached_params.expire_time | integer | Optional | Expire time (Unix timestamp, in seconds) |
attached_params.activate_order_type | string | Optional | Order type submitted after triggering, e.g. `LIT` (limit-if-touched) or `MIT` (market-if-touched) |
attached_params.profit_taker_submit_price | string | Optional | Take-profit limit order submitted price, required when `activate_order_type` is `LIT` |
attached_params.stop_loss_submit_price | string | Optional | Stop-loss limit order submitted price, required when `activate_order_type` is `LIT` |
attached_params.activate_rth | string | Optional | Whether the order submitted after triggering allows pre/post market trading. **Enum Value:**, `RTH_ONLY` - Regular trading hours only, `ANY_TIME` - Any time |
attached_params.profit_taker_depth_level | integer | Optional | Specifies the bid/ask depth level for the take-profit limit order submitted price, valid when `activate_order_type` is `LIT` |
attached_params.stop_loss_depth_level | integer | Optional | Specifies the bid/ask depth level for the stop-loss limit order submitted price, valid when `activate_order_type` is `LIT` |
Response
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"order_id": 683615454870679600
}
}Error code
See the Error Codes page for the full list of error codes.