Skip to Content

Cancel Single Order

This API allows you to cancel an existing order.

USE CASE

Cancel an order that is still pending or open.

Note

To cancel only the linked Take Profit or Stop Loss without cancelling the parent order, use the Modify Order API and pass null for the applicable takeProfit or stopLoss parameter. Pass both parameters as null to cancel both.

Details

  • Cancel pending orders via DELETE /api/v3/orders/sync with a JSON body containing id. You may alternatively use DELETE /api/v3/orders/{orderId}/sync with the order id in the path instead of the body.
  • Cancelling orders needs an app with the Order Placement permission.
  • Only pending orders can be cancelled.
  • Cancelling a pending parent order also cancels its linked Take Profit and Stop Loss orders automatically.
  • Cancel requests count towards the limit of 10 orders per second shared with placing and modifying. Requests beyond it are rejected.
  • If the response code is 201, the request was made but not acknowledged. Check the order book before sending it again.
  • For order types, product types, validations and sync vs async behaviour, refer to the Order Placement Guide.
  • When order rate limiting is triggered, the API returns 429 Too Many Requests.
  • Retry timing is provided through response headers, not in the response body.
  • Retry-After — Wait time before retrying, in seconds
  • X-Retry-After-Ms — Wait time before retrying, in milliseconds
  • Use the retry interval returned in the response headers before sending another order request.
  • Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

AttributeData TypeDescription
id*string
  • Mandatory for DELETE /api/v3/orders/sync (JSON body).
  • Eg: 119031547242

Response Attributes

AttributeData TypeDescription
sstringok / error
codeint
  • This is the code to identify specific responses
  • If 201 comes in code it implies that order request has been made but no acknowledgement has been received in this case check orderbook before placing order
messagestring
  • Message to clarify the request status.
  • Eg: Successfully canceled order
idstring
  • The order number of the canceled order.
  • Eg: 119031547242
Last updated on