Amend an order

PUT🔒 Trading

⚡ Orders: 75 req/s per endpoint · 75 req/s per user

tip

Try It Out — test this endpoint in the API Explorer

Amends an existing order's price, size, or trigger price. The amendType field selects which field(s) are changed and which inputs are required.

Request Parameters

Name	Type	Required	Description
orderId	String	No	Server-assigned order id of the order to amend. Required if clOrderId is not provided.
clOrderId	String	No	Client-assigned order id of the order to amend. Required if orderId is not provided.
symbol	String	Yes	Trading pair symbol of the order to amend.
amendType	String	Yes	Which field to amend: PRICE, SIZE, TRIGGER_PRICE, or ALL.
orderSize	Double	No	New order size in number of contracts. Required when amendType is SIZE, or ALL when combined with orderPrice.
orderPrice	Double	No	New limit price. Required when amendType is PRICE (unless slide is true) or ALL when combined with orderSize.
triggerPrice	Double	No	New trigger price. Required when amendType is TRIGGER_PRICE.
slide	Boolean	No	If true and amendType is PRICE, the price is slid to the best available price instead of being taken from orderPrice.
totalAmountMode	Boolean	No	If true, orderSize is treated as the desired total original size rather than an incremental change.

Response Content

Name	Type	Description
orderId	String	Server-assigned order id of the amended order.
clOrderId	String	Client-assigned order id echoed from the request.
symbol	String	Trading pair symbol of the amended order.
orderSide	String	Order side: BUY or SELL.
type	Integer	Order type code.
orderPrice	Double	Limit price after the amendment.
orderSize	Double	Order size after the amendment, in number of contracts.
triggerPrice	Double	Trigger price after the amendment, if applicable.
status	Integer	Order status code after the amendment.
timestamp	Long	Server timestamp of the amendment, in milliseconds since epoch.

example

PUThttps://api.btse.com/futures/api/v3/trade/orders

Request (default)

{
  "symbol": "BTC-PERP",
  "orderId": "0251ea47-88b5-48c0-aeb3-b38774fd1f90",
  "amendType": "PRICE",
  "orderPrice": 56439.4
}

Response (default)

[
  {
    "orderId": "0251ea47-88b5-48c0-aeb3-b38774fd1f90",
    "clOrderId": "",
    "symbol": "BTC-PERP",
    "orderSide": "BUY",
    "type": 76,
    "orderPrice": 56439.4,
    "orderSize": 1,
    "triggerPrice": 0,
    "status": 123,
    "timestamp": 1784882344404
  }
]