Skip to main content

Order History

This call would fetch the entire state wise data for particular order.

🛣️Path Parameters 

FieldsTypeRequiredDescriptionExample/Enum
orderidstringyesPass order id to filter records based on order id. It must be URL encoded as it contains special characters.NXHVM000987

🔑Header Parameters

FieldsTypeRequiredDescriptionExample/Enum
AuthorizationstringyesBearer token for authenticationaccess_token
Content_typestringyesMIME Typeapplication/JSON
x-api-keystringYesAPI key provided by bearerx-api-key

🟢Success Response - 200 Ok

FieldsTypeDescriptionExample/Enum
statusstringRequest statusSucess
codestringResponse code200
messagestringMessage correspondingOrder history data fetched successfully
dataarrayList of orders with detailed infoSee below table
metadataobjectMetadata regarding total/completed/open ordersSee below table

📑Data object fields

FieldsTypeDescriptionExample/Enum
order_idstringSystem-generated inique order numberORD123456789
exchangestringExchange segmentsBSE
scrip_tokenintegerToken number of the scrip/instrument101234
exchange_order_nostringExchange order numberEXORD123456789
statusstringStatus of the orderCompleted
error_reasonstringError message if order is cancelle/ rejeted/not modifiedInsufficient funds
transaction_typestringOrder type: Buy or SellBUY
product_typestringProduct typeINTRADAY
order_typestringOrder TypesLIMIT
total_quantityintegerOriginal quantity of the order100
pending_quantityintegerQuantity still pending0
traded_quantityintegerTraded quantity100
disclosed_quantityintegerDisplay quantity in the market0
order_pricenumberPrice at which order was placed105.50
trigger_pricenumberTrigger price104.00
validitystringOrder ValidityDAY
validity_dayintegerValidity in days (for GTD orders)5
symbolstringSymbol code from exchangeRELIANCE
seriesstringSeries of the instrumentEQ
instrumentsnumberInstrument identifier123456
expiry_datestringExpiry date or contracts2025-06-02
strike pricestringStrike price in paise15000
option_typestringCE (call) or PE(put)CE
market_lotintegerLot size of the scrip1
order_timestampstringTime when OMS registered the order2025-06-01T10:20
exchange_timestampstringTime when exchange resgistered the order2025-06-01T10:20
inititated_bystringApplication ID that placed the orderAPP123
modified_bystringApplication ID that modified the orderAPP456
is_amo_orderstringWhether it is AMO (After Market Order)false
gateway_order_idstringInternal gateway orderIDGW123456
order_identifierstringOptional field for trackin the orderuser001
bracket_detailsobjectsPresent if order is BOSee below table

📑Bracket details object fields

FieldsTypeDescriptionExample/Enum
parent_order_IDstringOrder ID of main legORD123
leg_indicatorstringIdentifies leg (main, stoploss, profit)MAIN
stoploss_pricenumberStoploss price95.00
stoploss_trigger_pricenumberstoploss trigger price94.00
profit_pricenumberTarget profit price110.00
stoploss_jump_pricenumberStoploss trail jump price0.50
ltp_jump_pricenumberLTP trail jump price0.25
bo_order_idstringBracket order IDBO12345
bo_order_statusstringStatus of Bracket orderCOMPLETED
bo_modify_flagnumberLegs allowed to be modified (0-7)0- Modification is not allowed 1- Main leg 2- Stop loss leg 4- Profit leg 6- Both stop loss & profit leg 7- All legs6

📑Metadata object fields

FieldsTypeDescriptionExample/Enum
total_recordsnumberTotal order count55
get/transactional/v1/orders/{order_id}