Skip to main content

MODIFY ORDER API

This API allows you to modify an existing pending order.

You can update order parameters such as quantity, price, validity, and order type before the order is executed.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
exchangestringYesExchange segment"NSE_EQ"
order_idstringYesUnique order identifier"NWSDJ00022N3"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the requestapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample / Enum
order_typestringYesType of orderRefer global constants
quantityintegerYesUpdated quantity10
traded_quantityintegerYesPreviously traded quantity (from order book)2
pricenumberNoUpdated price100.5
trigger_pricenumberNoTrigger price for SL orders99.5
disclosed_quantityintegerNoDisclosed quantity5
validitystringNoOrder validity"DAY"
validity_daysintegerNoValidity for GTD orders2

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"Order modified successfully"
dataobjectOrder response payloadRefer to Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
orderIdstringSystem-generated order identifier"NWSDJ00022N3"

📝 Notes

  • Only pending (open) orders can be modified.
  • For limit orders, ensure valid price is provided.
  • For stop-loss orders, trigger_price is mandatory.
  • Order modification may be rejected if the order is already executed or canceled.