Skip to main content

Cancel order

Cancel a single open order identified by orderId or clOrderId on the given trading pair.

Request Parameters​

NameTypeRequiredDescription
symbolStringYesTrading pair
orderIdStringNoOrder ID to cancel; at least one of orderId or clOrderId is required
clOrderIdStringNoClient-supplied order ID to cancel; at least one of orderId or clOrderId is required

Response Content​

NameTypeDescription
orderIdStringServer-assigned order identifier
clOrderIdStringEcho of the client-supplied order identifier if one was provided
statusIntegerNumeric status code reflecting the current state of the order (e.g. filled, cancelled, rejected)
marketStringTrading pair, e.g. BTC-USDT
typeIntegerNumeric code identifying the order type (e.g. LIMIT, MARKET, TWAP, PEG)
orderSideStringBUY or SELL
orderPriceDoubleOrder price
postOnlyBooleanWhether the order was submitted as post-only
timestampLongServer-side event timestamp in epoch milliseconds
orderDetailTypeStringDetailed order sub-type when applicable (e.g. TWAP for algo TWAP orders)
messageStringOptional diagnostic message; present only when one is returned (e.g. rejection reason)
userQuoteCurrencyStringQuote currency configured for the user
orderCurrencyString'quote' or 'base'; indicates whether the quote-size or base-size fields below are populated
originalOrderBaseSizeDoubleOriginal size in base currency; populated when orderCurrency is 'base'
originalOrderQuoteSizeDoubleOriginal size in quote currency; populated when orderCurrency is 'quote'
currentOrderBaseSizeDoubleCurrently active size in base currency; populated when orderCurrency is 'base'
currentOrderQuoteSizeDoubleCurrently active size in quote currency; populated when orderCurrency is 'quote'
remainingOrderBaseSizeDoubleRemaining unfilled size in base currency; populated when orderCurrency is 'base'
remainingOrderQuoteSizeDoubleRemaining unfilled size in quote currency; populated when orderCurrency is 'quote'
filledBaseSizeDoubleSize filled by the most recent match, in base currency
totalFilledBaseSizeDoubleCumulative filled size across all matches, in base currency
avgFilledPriceDoubleVolume-weighted average fill price
time_in_forceStringTime-in-force policy (GTC, IOC, FOK); null when not applicable to the order type
example
DELETEhttps://api.btse.com/spot/api/v4/trade/orders

Response (default)

[
{
"orderId": "4eca2eb4-e6ad-4355-ae12-5ce757b105b3",
"clOrderId": "",
"status": 6,
"market": "BTC-USD",
"type": 76,
"orderSide": "BUY",
"orderPrice": 0,
"postOnly": false,
"timestamp": 1784891308981,
"orderDetailType": null,
"message": null,
"userQuoteCurrency": "USD",
"orderCurrency": "base",
"originalOrderBaseSize": 0.00001,
"originalOrderQuoteSize": null,
"currentOrderBaseSize": 0.00001,
"currentOrderQuoteSize": null,
"remainingOrderBaseSize": 0.00001,
"remainingOrderQuoteSize": null,
"filledBaseSize": 0,
"totalFilledBaseSize": 0,
"avgFilledPrice": 0,
"time_in_force": "GTC"
}
]