Skip to main content

Amend Order

Amends an existing order's price, size, or trigger price. Does not apply to algo orders. Already-triggered trigger orders cannot have their trigger price amended.

Request Parameters

NameTypeRequiredDescription
symbolStringYesMarket symbol
orderIDStringNoInternal order ID. Required if clOrderID is not provided. Takes precedence over clOrderID if both are provided
clOrderIDStringNoCustom order ID. Required if orderID is not provided
typeStringYesAmendment 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)
valueDoubleNoNew value. Required for PRICE, SIZE, or TRIGGERPRICE amendment types
orderPriceDoubleNoNew order price. Used when type is ALL
orderSizeIntegerNoNew order size in contract units. Used when type is ALL
triggerPriceDoubleNoNew trigger price (trigger orders only). Used when type is ALL

Response Content

NameTypeDescription
symbolStringMarket symbol
orderIDStringOrder ID
clOrderIDStringCustom order ID
orderTypeInteger76: Limit · 77: Market · 80: Algo
sideStringTrade side
priceDoubleOrder price
statusIntegerOrder status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED)
time_in_forceStringTime in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH
timestampLongOrder timestamp
triggerBooleanWhether order is a trigger order
triggerPriceDoubleTrigger price (0 if not a trigger order)
avgFilledPriceDoubleAverage filled price
messageStringTrade message
stealthDoubleAlgo orders only
deviationDoubleAlgo orders only
remainingSizeIntegerCurrent order size minus filled size
originalOrderSizeIntegerOriginal quantity — unchanged after amendments
currentOrderSizeIntegerLatest quantity (filled + remaining)
filledSizeIntegerQuantity filled in this update
totalFilledSizeIntegerCumulative filled quantity
postOnlyBooleanWhether order is post-only
positionModeStringONE_WAY · HEDGE · ISOLATED
positionDirectionStringPosition direction: LONG · SHORT (only present in HEDGE/ISOLATED mode)
positionIdStringPosition ID
example
PUThttps://api.btse.com/futures/api/v2.3/order

Request (Amend price)

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

Request (Amend size)

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

Request (Amend multiple fields)

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