Skip to main content

GTD ORDER HISTORY

This API retrieves the history of GTD (Good Till Date) orders for authorized end users through a middleware-based integration.

The API provides detailed information about GTD orders, including order status changes, traded quantities, pending quantities, and exchange order details.

🔑 Header Parameters

FieldsTypeRequiredDescriptionExample
AuthorizationstringYesBearer token for authenticationaccess_token
x-api-keystringYesAPI key providedx-api-key

🔍 Query Parameters

FieldsTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC){{user_id}}
offsetintegerNoSpecifies the page number of the collection to be displayed1
limitintegerNoLimits the number of items returned per page1000
gtdOrderIdstringNoGTD Order ID used to filter records. Must be URL encoded if it contains special characters20230123NXVZO0000000

🟢 Success Response - 200 OK

FieldsTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"GTD Order History fetched successfully"
dataarray(object)GTD Order history recordsSee below table

📘 GTD Order History Object Fields

FieldsTypeDescriptionExample
order_datestringDate on which the GTD order was created or updated"2026-07-02"
gtd_order_idstringSystem-generated GTD Order ID"20230123NXVZO0000000"
exchange_order_nostringExchange order number"120000000123456"
client_order_nonumberClient order number1012456
exchangestringExchange segment"NSE_EQ"
symbolstringTrading symbol"INFY"
seriesstringSeries"EQ"
transaction_typestringBuy or Sell transaction"BUY"
total_quantitynumberOriginal order quantity100
order_pricestringOrder price"2500.50"
statusstringCurrent order status"OPEN"
pending_quantitynumberPending quantity50
traded_quantitynumberCumulative traded quantity50
previous_traded_quantitynumberPreviously traded quantity before the latest update25