Skip to main content

Modify Order

The Modify Order API allows users to update an existing pending order on the exchange. This can include changes to the order’s quantity, price, order type, disclosed quantity, or validity. It is typically used when a trader wants to adjust an order that has not yet been fully executed.

🛣️Path Parameters

ParametersTypeRequiredDescriptionExample/ENUM
exchangestringyesExchange segmentsNSE_FO
order_idstringyesOrder ID is given in URL encode formNWSYF00005>3

📦Request Body Schema:

FieldsTypeRequiredDescriptionExample
order_typeStringyesSpecifies the Order Types of the order.."RL"
quantityintegeryesThis specifies the number of quantity users wants to modify.5
traded_quantityintegeryesSpecifies the total quantity traded for the order up to the current point. This data can be obtained from the order book response.50
pricenumberyesThe price at which the order will be placed, specified in rupees.Default: 0250.75
trigger_pricenumberyesThe price set by the user for stop loss or stop loss market order types. When this price is reached, the order is triggered and subsequently placed at the specified limit price.245.00
disclosed_quantityintegeryesA portion of disclosed order quantity that the user chooses to display in the market. The remaining quantity stays hidden until the disclosed quantity is fully executed20
validitystringyesDefault: "DAY"The order Validity value will be dependant on exchange segments in which the order is being placed."DAY"
validity_daysintegeryesNumber of days for which the GTD order needs to be carried forward.5

🟢Success Response - 200 Ok

FieldsTypeDescriptionExample/Enum
statusstringIndicates the result of API Call"success"
codestringResponse code corresponding to the request"s-101"
messagestringDescriptive message for the response"Success Message"

🔴 Error Response - 400 Bad Request

FieldTypeDescriptionExample
statusstringStatus of the API call Default Error"error"
codestringError code indicating the failure"e-101"
messagestringSpecific message explaining the reason for failed request."Error Message"
put/transactional/v1/orders/regular/{exchange}/{order_id}