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
| 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 | Integer | No | New order size in contract units. 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 | Order ID |
| clOrderID | String | Custom order ID |
| orderType | Integer | 76: Limit · 77: Market · 80: Algo |
| side | String | Trade side |
| price | Double | Order price |
| status | Integer | Order status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED) |
| time_in_force | String | Time in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH |
| timestamp | Long | Order timestamp |
| trigger | Boolean | Whether order is a trigger order |
| triggerPrice | Double | Trigger price (0 if not a trigger order) |
| avgFilledPrice | Double | Average filled price |
| message | String | Trade message |
| stealth | Double | Algo orders only |
| deviation | Double | Algo orders only |
| remainingSize | Integer | Current order size minus filled size |
| originalOrderSize | Integer | Original quantity — unchanged after amendments |
| currentOrderSize | Integer | Latest quantity (filled + remaining) |
| filledSize | Integer | Quantity filled in this update |
| totalFilledSize | Integer | Cumulative filled quantity |
| postOnly | Boolean | Whether order is post-only |
| positionMode | String | ONE_WAY · HEDGE · ISOLATED |
| positionDirection | String | Position direction: LONG · SHORT (only present in HEDGE/ISOLATED mode) |
| positionId | String | Position ID |
example
PUT
https://api.btse.com/futures/api/v2.3/orderRequest (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
}