Skip to main content

Amend Order

info

You can only modify unfilled or partially filled orders.

HTTP Request

POST /v5/spread/order/amend

Request Parameters

ParameterRequiredTypeComments
symboltruestringSpread combination symbol name
orderIdfalsestringSpread combination order ID. Either orderId or orderLinkId is required
orderLinkIdfalsestringUser customised order ID. Either orderId or orderLinkId is required
qtyfalsestringOrder quantity after modification. Either qty or price is required
pricefalsestringOrder price after modification
  • Either qty or price is required
  • price="" means the price remains unchanged, while price="0" updates the price to 0.
info

The acknowledgement of an amend order request indicates that the request was sucessfully accepted. This request is asynchronous so please use the websocket to confirm the order status.

Response Parameters

ParameterTypeComments
orderIdstringOrder ID
orderLinkIdstringUser customised order ID

Request Example

POST /v5/spread/order/amend HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: XXXXXX
X-BAPI-TIMESTAMP: 1744083949347
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json
Content-Length: 115

{
"symbol": "SOLUSDT_SOL/USDT",
"orderLinkId": "1744072052193428475",
"price": "14",
"qty": "0.2"
}

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"orderId": "b0e6c938-9731-4122-8552-01e6dc06b303",
"orderLinkId": "1744072052193428475"
},
"retExtInfo": {},
"time": 1744083952599
}