Skip to main content

GTD Order History

This API retrieves the history of GTD (Good Till Date) orders, with optional filters for pagination and specific gtdOrderId.

🔍Query Parameters 

FieldsTypeRequiredDescriptionExample/Enum
offsetintegerNoPage Number for pagination1
limitsintegerNoMaximum number of records per page1000
gtdOrderIdstringNoGTD order ID to filter records. Must be URL-encoded if it contains symbols2022049NXWAD0000000

🔑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
StatusStringResponse of the API statussuccess
CodestringResponse code to the user request"s-101"
MessagestringSuccess message"Orders fetched successfully"
Dataarray of objectsList of GTD order history recordsSee table below

📦Data object fields

FieldsTypeDescriptionExample/Enum
order_idstringSystem-generated unique order numberGTDORD001
exchangestringExchange segmentsBSE
scrip_tokenintegerToken number of the scrip/instrument101234
exchange_order_nostringExchange order numberEXORD123456789
statusstringStatus of the orderCompleted
error_reasonstringError message if order is cancelled/ rejected/not modifiedInsufficient funds
transaction_typestringOrder type: Buy or SellBUY
product_typestringProduct typeDeivery
order_typestringOrder TypesLIMIT
total_quantityintegerTotal quantity in the order10
pending_quantityintegerRemainin quantity that is yet to be executed100
traded_quantityintegerQuantity that has been executed0
disclosed_quantityintegerQuantity visisble to market out of the total quantity0
order_pricenumberPrice at which order was placed152.35
trigger_pricenumberTriger price for stop-loss or trigger based orders150.00
validitystringValidity of the orderGTD
validity_daysintegerNumber of days the order is valid (for GTD orders)7
symbolstringTrading symbol of the scripTCS
seriesstringSeries of the stock (EQ,BE,BL)EQ
instrumentnumberInstrument name code12
expiry_datestringContract expiry date (for derivatives )2025-10-31
strike_pricestringStrike price of the option0
option_typestringOption type: CE (Call), PE (PUT)PE
market_lotintegerLot size of the scrip1
order_timestampstringTime when he order was registered by OMS2025-06-11T10:10Z
initiated_bystringApp ID or user ID from where order was placedMOBILE_APP_01
modified_bystringApp ID or user ID from where order was modifiedWEB_PORTAL_02
gateaway_order_idstringInternal gateaway order IDGTW123456
order_identifierstringOptional user-defined identifier for tracking the orderGTD_TCS1
get/transactional/v1/gtdOrdersHistory