Trade

Replace Order

PUThttps://openapi.longbridge.com/v1/trade/order

Authorization

Signed mode: every request is signed with your App Key/Secret. Header set:

NameTypeRequiredDescription
Authorizationstring · headerRequiredThe account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation.
X-Api-Keystring · headerRequiredYour App Key.
X-Timestampstring · headerRequiredRequest timestamp in seconds (Unix epoch).
X-Api-Signaturestring · headerRequiredHMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=.

This API is used to replace order, modify quantity or price.

>_ CLI
# Replace the order ID below with your actual order ID
longbridge order replace 693664675163312128 --qty 200 --price 255.00

Request

Request body

NameTypeRequiredDescription
order_idstringRequiredOrder ID
quantitystringRequiredReplaced quantity, example: `100`
pricestringOptionalReplaced price, example: `388.5`. `LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required
trigger_pricestringOptionalTrigger price, example: `388.5`. `LIT` / `MIT` Order Required
limit_offsetstringOptionalLimit offset amount. `TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0
trailing_amountstringOptionalTrailing amount. `TSLPAMT` Order Required
trailing_percentstringOptionalTrailing percent. `TSLPPCT` Order Required
remarkstringOptionalRemark (Maximum 64 characters)
limit_depth_levelintegerOptionalSpecifies the bid/ask depth level. `TSLPAMT` / `TSLPPCT` Order Required
monitor_pricestringOptionalMonitoring price. `TSLPAMT` / `TSLPPCT` Order Required
trigger_countintegerOptionalNumber of triggers. `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` Order Required
attached_paramsobjectOptionalAttached order parameters (take-profit / stop-loss)
attached_params.attached_order_typestringOptionalAttached order type. **Enum Value:**, `PROFIT_TAKER` - Take Profit, `STOP_LOSS` - Stop Loss, `BRACKET` - Bracket Order
attached_params.profit_taker_pricestringOptionalTake-profit trigger price
attached_params.stop_loss_pricestringOptionalStop-loss trigger price
attached_params.time_in_forcestringOptionalAttached 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_timeintegerOptionalExpire time (Unix timestamp, in seconds)
attached_params.profit_taker_idintegerOptionalTake-profit order ID, fill in when modifying an existing take-profit order
attached_params.stop_loss_idintegerOptionalStop-loss order ID, fill in when modifying an existing stop-loss order
attached_params.cancel_all_attachedbooleanOptionalWhether to cancel all attached orders
attached_params.main_idintegerOptionalMain order ID
attached_params.quantitystringOptionalAttached order quantity
attached_params.market_pricestringOptionalMarket price
attached_params.activate_order_typestringOptionalOrder type submitted after triggering, e.g. `LIT` (limit-if-touched) or `MIT` (market-if-touched)
attached_params.profit_taker_submit_pricestringOptionalTake-profit limit order submitted price, required when `activate_order_type` is `LIT`
attached_params.stop_loss_submit_pricestringOptionalStop-loss limit order submitted price, required when `activate_order_type` is `LIT`
attached_params.activate_rthstringOptionalWhether 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_levelintegerOptionalSpecifies 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_levelintegerOptionalSpecifies 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": {}
}

Error code

See the Error Codes page for the full list of error codes.