Skip to main content

Modify Cover Order

This API allows you to modify an existing Cover Order that is pending in the order book.

🛣️Path parameters

FieldsTypeRequiredDescriptionExample/Enum
ExchangestringyesExchange segmentsNSE_EQ
order_idstringyesOrder ID (URL encoded format)NWSYF00006>3

🔑Header Parameters

FieldsTypeRequiredDescriptionExample/Enum
AuthorizationstringyesBearer token for authenticationaccess_token
x-api-keystringyesAPI key provided by brokerx-api-key

📦Request Body Schema

FieldsTypeRequiredDescriptionExample/Enum
main_legobjectyesMain order detailsSee below table
stoploss_legobjectyesStop loss order detailsSee below table
leg_indicatorstringyesIndicates which leg is being modified. "2" refers to the stoploss leg"2"

📘Main Leg Object Fields

FieldsTypeRequiredDescriptionExample/Enum
order_typestringyesOrder Types Allowed values: RL (Regular Limit) or RL-MKT (Regular Market)RL` / `RL-MKT
quantityintegeryesTotal quantity to transact100
traded_quantityintegeryesQuantity already traded (get from order book)40
pricenumberYesPrice must be 0 for RL-MKT type orders0

📘Stoploss Leg Fields

FieldsTypeRequiredDescriptionExample/Enum
legsarray(object)yesArray of stop-loss leg orders.See below table

📘Inside Stop-loss legs array:

FieldsTypeRequiredDescriptionExample/Enum
order_typestringYesOrder type for the SL leg. After SL is triggered, must be RL-MKT.RL-MKT
trigger_price_validationbooleanYesEnable trigger price validation. Must be true after SL is triggered.true
quantityintegerNoQuantity present. Currently ignored by the system.2625
pricenumberConditionalPrice at which SL should execute. Required for SL type only. Must be 0 after SL is triggered.0
trigger_pricenumberYesTrigger price that activates the stop-loss leg. Must be 0 after SL is triggered.0

⚠️ Important: After SL is triggered, price and trigger_price in the stoploss leg must always be 0.

🟢Success Response - 200 OK

FieldsTypeDescriptionExample/Enum
StatusStringAPI call statussuccess
CodestringResponse codes-101
messagestringsuccess messageOrder Modification sent to OMS
dataobjectContains the modified order IDSee below table

📘Data Object Field

FieldsTypeDescriptionExample/Enum
orderIdstringModified system generated Order-ID"NWSYF00008>3"