Skip to main content

PLACE COVER ORDER

This API enables placement of Cover Orders for authorized end users through a middleware-based integration.

A Cover Order consists of a primary order (Market Order) along with a mandatory Stop Loss order for risk management.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📦Request Body Schema: application/json

FieldsTypeRequiredDescriptionExample/ENUM
Scrip_infoobjectYesExchange segmentsNSE_EQ
transactional_typestringYesWhether its a BUY or SELL orderBUY
main_legobjectYesDetails of the primary order.See below table
stoploss_legobjectYesDetails of the stop-loss (can include multiple legs)See below table
order_identifierstringNoOptional Identifier for users own tracking (max 10 Chars)"Myorder1"
part_codestringNoCustodian participant code  if any"P123"
algo_idstringNoAlgo ID for automated strategies"A001"
strategy_idstringNoStrategy ID"S001"
vendor_codestringNoIn-house vendor code"V123"

📝Scrip Info Object Fields

FieldsTypeRequiredDescriptionExample/ENUM
exchangestringYesExchange segmentNSE_EQ
scrip_tokenintegerNoUnique scrip token (required if symbol-based data is not give)10100001
symbolstringNoScrip symbolRELIANCE 
seriesstringNoSeries for equitiesEQ
expiry_datestringNoExpiry date for F&O (yyyy-mm-dd format)2025-06-27
strike_pricenumberNoStrike price for options (in paise)25000
option_typestringNoOption type- "CE" (Call) or "PE"(Put)CE

📝Main Leg Object Fields

FieldsTypeRequiredDescriptionExample/ENUM
order_typeStringYesOrder Types. Allowed values: RL (Regular Limit) or RL-MKT (Regular Market)RL/RL-MKT
quantityintegerYesQuantity to transact100
pricenumberYesPrice for the order. Must be 0 for RL-MKT type.0

📝Stoploss Leg Object Fields

FieldsTypeRequiredDescriptionExample/ENUM
LegsArrayYesArray of stop loss order legsSee below table

📝Array of objects fields

FieldsTypeRequiredDescriptionExample/Enum
quantityintegerNoQuantity of SL leg (currently ignored by system).100
pricenumberConditionalPrice at which SL should execute (used only for "SL" type)1478.00
trigger_pricenumberYesPrice at which stop-loss should trigger and place the order1480.50

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringOrder placement success message"Cover order placed successfully"
dataobjectOrder response detailsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
orderIdstringSystem-generated order identification number"25062900012345"

📝 Notes

  • A Cover Order consists of:
    • One primary market order.
    • One mandatory stop loss order.
  • trigger_price is mandatory for the stop loss leg.
  • Supports Equity, Derivatives, Currency, and Commodity segments where Cover Orders are permitted.
  • order_identifier can be used to map and track orders from external systems