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 detaisSee below table

📘Main Leg Object Fields

FieldsTypeRequiredDescriptionExample/Enum
order_typestringyesOrder Types (only RL-MKT allowed)RL-MKT 
quantityobjectyesTotal quantity to transact100
traded quantityobjectyesQuantity 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
quantityintegerNoQuantity presetnt (current ignored in the system)100
pricenumberConditionalPrice at which SL should execute. Required for "SL" type only1478.00
trigger_pricenumberYesTrigger price that activates the stop-loss leg1480.00

🟢Success Response - 200 OK

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

📘Data Object Field

FieldsTypeDescriptionExample/Enum
orderIdstringModified system generated Order-ID"NWSYF00008>3"
put/transactional/v1/orders/cover/{exchange}/{order_id}