Modify Multi Order

This API allows you to modify multiple orders in a single request.

USE CASE

Update up to 10 pending orders together, for example to move their prices at the same time.

Details

You can modify upto 10 orders simultaneously via the API.
While Modifying Multi orders you need to pass an ARRAY containing the orders request attributes
Modifying orders needs an app with the Order Placement permission.
Send an array with one object per order. Each object carries the order id, its type and the fields to change, as in Modify Single Order.
Only pending orders can be modified. Any field you leave out keeps its original value.
Prices must be multiples of the symbol tick size, and quantity must follow the lot-size rules.
Modify requests count towards the limit of 10 orders per second shared with placing and cancelling. Requests beyond it are rejected.
The response has one entry per order with its own statusCode, message and id. 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 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

Attribute	Data Type	Description
`id`*	string	Mandatory. Eg: 119031547242
`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
`s`	string	Overall status of the request: "ok" for success, "error" for failure.
`code`	int	Overall response code, e.g. `200` on success.
`message`	string	Overall message for the request (empty string on success).
`data`	array	List of per-order results, one entry for each order submitted in the request, in the same order they were sent.
`data[].statusCode`	int	HTTP-style status code for this specific order's modify request, e.g. `200`.
`data[].statusDescription`	string	Status description for this specific order's modify request, e.g. "HTTP OK".
`data[].body`	object	Result for this order. It has the same fields as the Modify Single Order response.
`data[].body.s`	string	ok / error
`data[].body.code`	int	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
`data[].body.message`	string	Message to clarify the request status. Eg: Successfully modified order
`data[].body.id`	string	The order number of the modified order Eg: 119031547242

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"
# Initialize the FyersModel instance with your client_id, access_token, and enable async mode
fyers = fyersModel.FyersModel(client_id=client_id, token=access_token,is_async=False, log_path="")


data = [{
  "id": 8102710298291,
  "type": 1,
  "limitPrice": 61049,
  "qty": 1
},
{
  "id": 8102710298292,
  "type": 1,
  "limitPrice": 61049,
  "qty": 1
}]

response = fyers.modify_basket_orders(data=data)
print(response)

{
  "s": "ok",
  "code": 200,
  "message": "",
  "data": [{"statusCode": 200,
            "body": {
                        "s": "ok",
                        "code": 200,
                        "message": "Successfully modified order",
                        "id": 8102710298291
                      },
                      "statusDescription": "HTTP OK"
              },
              {
                "statusCode": 200,
                "body": {
                          "s": "ok",
                          "code": 200,
                          "message": "Successfully modified order",
                          "id": 8102710298292
                        },
                        "statusDescription": "HTTP OK"
              }
            ]}

  }

Modify Multi Order

Request Attributes

Response Attributes

Video learning