Amend 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

Amend the price, size, or trigger price of a pending order. Does not apply to algo orders. For trigger orders, the trigger price cannot be amended after the order has been triggered.

Request Parameters

Name	Type	Required	Description
symbol	String	Yes	Market symbol
orderID	String	No	Internal order ID. Required if clOrderID is not provided. Takes precedence over clOrderID if both are provided
clOrderID	String	No	Custom order ID. Required if orderID is not provided
type	String	Yes	Amendment type: PRICE (amend price, use value) · SIZE (amend size, use value) · TRIGGERPRICE (amend trigger price, use value) · ALL (amend multiple fields, use orderPrice/orderSize/triggerPrice)
value	Double	No	New value. Required for PRICE, SIZE, or TRIGGERPRICE amendment types
orderPrice	Double	No	New order price. Used when type is ALL
orderSize	Double	No	New order size. Used when type is ALL
triggerPrice	Double	No	New trigger price (trigger orders only). Used when type is ALL

Response Content

Name	Type	Description
symbol	String	Market symbol
orderID	String	Internal order ID
clOrderID	String	Custom order ID
side	String	BUY or SELL
price	Double	Order price
orderType	Integer	76: Limit · 77: Market · 80: Peg/Algo
status	Integer	Order status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED)
averageFillPrice	Double	Average fill price
originalOrderBaseSize	Double	Original order quantity expressed in base currency
originalOrderQuoteSize	Double	Original order quantity expressed in quote currency
currentOrderBaseSize	Double	Latest order quantity in base currency (after amendments / partial fills)
currentOrderQuoteSize	Double	Latest order quantity in quote currency
remainingOrderBaseSize	Double	Unfilled quantity in base currency
remainingOrderQuoteSize	Double	Unfilled quantity in quote currency
filledBaseSize	Double	Most recent fill quantity in base currency
totalFilledBaseSize	Double	Cumulative filled quantity in base currency
orderCurrency	String	Currency the order size is denominated in: base or quote
size	Double	Deprecated in v3.3. Use originalOrderBaseSize / originalOrderQuoteSize
fillSize	Double	Deprecated in v3.3. Use filledBaseSize / totalFilledBaseSize
remainingSize	Double	Deprecated in v3.3. Use remainingOrderBaseSize / remainingOrderQuoteSize
originalSize	Double	Deprecated in v3.3. Use originalOrderBaseSize / originalOrderQuoteSize
triggerPrice	Double	Trigger price (0 if not a trigger order)
stopPrice	Double	Stop price
time_in_force	String	Time in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH
timestamp	Long	Order timestamp
trigger	Boolean	Whether the order is a trigger order
postOnly	Boolean	Whether post-only
stealth	Double	Stealth value
deviation	Double	Deviation value

example

PUThttps://api.btse.com/spot/api/v3.3/order

Request (Amend price)

{
  "symbol": "BTC-USD",
  "orderID": "25248336-66d8-41ff-99fd-83489c4e6029",
  "type": "PRICE",
  "value": 35000
}

Request (Amend size)

{
  "symbol": "BTC-USD",
  "orderID": "689bf733-4879-4e32-8d1f-cb81f63d24d4",
  "type": "SIZE",
  "value": 1.05
}

Request (Amend multiple fields)

{
  "symbol": "BTC-USD",
  "orderID": "cb2785b0-558e-4b30-bf1f-8a8c56174d0c",
  "type": "ALL",
  "orderPrice": 40010,
  "orderSize": 1.05,
  "triggerPrice": 40000
}