Cancel Multi Order
This API allows you to cancel multiple orders in a single request.
USE CASE
Cancel up to 10 pending orders at once, for example when your strategy needs to pull all its working orders.
Details
- You can cancel upto 10 orders simultaneously via the API.
- While cancelling Multi orders you need to pass an ARRAY containing the orders request attributes
- Cancelling orders needs an app with the Order Placement permission.
- Send an array with one object per order, each carrying the order
id. - Only pending orders can be cancelled.
- Cancel requests count towards the limit of 10 orders per second shared with placing and modifying. Requests beyond it are rejected.
- The response has one entry per order with its own
statusCode,messageandid. Check every entry. - 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 secondsX-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
| Attribute | Data Type | Description |
|---|---|---|
id* | string |
|
Response Attributes
| Attribute | Data Type | Description |
|---|---|---|
s | string | ok / error |
code | int | This is the code to identify specific responses |
message | string | Message to clarify the request status |
data | array | Array of individual cancellation results, one entry per order submitted in the request, in the same order |
data[].statusCode | int | HTTP status code for that individual order's cancellation. Eg: 200 |
data[].statusDescription | string | HTTP status description for that individual order's cancellation. Eg: HTTP OK |
data[].body | object | Result for this order. It has the same fields as the Cancel Single Order response. |
data[].body.s | string | ok / error |
data[].body.code | int |
|
data[].body.message | string |
|
data[].body.id | string |
|
Last updated on