Modify Multi Order
This API allows you to modify multiple orders in a single request without waiting for the exchange response.
USE CASE
Adjust many working orders at once and follow each change on the General WebSocket or order book.
Details
- Body is an array of modify payloads (each includes
idand fields to change).PATCHto/api/v3/multi-order/async. - Modifying orders needs an app with the Order Placement permission.
- Send an array with one object per order, each carrying the order
idand the fields to change. - An HTTP 200 response only means the requests were queued. It does not confirm that the orders were modified.
- The queue sends requests on at most 10 orders per second.
- The response returns
id_fyers. Use it with the General WebSocket updates and the order book to find the final status of each order. - Rate limits differ between the Standard and Prime plans. See Plans & rate limits.
Request Attributes
| Attribute | Data Type | Description |
|---|---|---|
id* | string |
|
type* | int | Mandatory. |
limitPrice | float | Mandatory. Only incase of Limit/ Stoplimit orders |
stopPrice | float | Mandatory. Only incase of Stop/ Stoplimit orders |
qty | int | Mandatory. Incase you want to modify the quantity |
disclosedQty | int | Disclosed quantity (Optional) |
Response Attributes
| Attribute | Data Type | Description |
|---|---|---|
id_fyers | string / array | Fyers queue/async id(s) for the batch modify request, returned per item or as an envelope depending on implementation. The final exchange id and terminal status for each leg are obtained separately via the order WebSocket or the GET order-book APIs, not in this immediate response. |
Last updated on