GTD Order Book

This API retrieves GTD (Good Till Date) order book records, with optional filters for pagination and order status.

🔍Query Parameters

Fields	Type	Required	Description	Example/Enum
offset	integer	no	Page number of the collection to be displayed	offset=1
limit	integer	no	Limits number of items per page	limit=20
orderStatus	string	no	1=Pending, 2=Completed, -1=All orders	orderstatus=1

🔑Header Parameters

Fields	Type	Required	Description	Example/ ---
Authorization	string	yes	Bearer token for authentication	access_token
Content_type	string	yes	MIME Type	application/JSON
x-api-key	string	yes	API key provided by bearer	x-api-key

🟢Success Response - 200 OK

Fields	Type	Description	Example/Enum
Status	String	Response of the API status	success
Code	string	Response code to the user request	"s-101"
Message	string	Success message	"Orders Fetched successfully"
Data	array of objects	List of GTD order objects	See below table

📘Data object fields

Fields	Type	Description	Example/Enum
order_id	string	System-generated unique order number	ORD123456789
exchange	string	Exchange segment	BSE
scrip_token	integer	Token number of the scrip/instrument	101234
exchange_order_no	string	Exchange order number	EXORD123456789
status	string	Status of the order	Completed
error_reason	string	Error message if order is cancelle/ rejeted/not modified	Insufficient funds
transaction_type	string	Order type: Buy or Sell	BUY
product_type	string	Product type	Delivery
order_type	string	Order Types	LIMIT
total_quantity	integer	Total quantity in the order	10
pending_quantity	integer	Remainin quantity that is yet to be executed	100
traded_quantity	integer	Quantity that has been executed	0
disclosed_quantity	integer	Quantity visisble to market out of the total quantity	0
order_price	number	Price at which order was placed	152.35
trigger_price	number	Triger price for stop-loss or trigger based orders	150.00
validity	string	Validity of the order	GTD
validity_days	integer	Number of days the order is valid (for GTD orders)	7
symbol	string	Trading symbol of the scrip	TCS
series	string	Series of the stock (EQ,BE,BL)	EQ
instrument	number	Instrument name code	12
expiry_date	string	Contract expiry date (for derivatives )	"2025-101-31"
strike_price	string	Strike price of the option	0
option_type	string	Option type: CE (Call), PE (PUT)	PE
market_lot	integer	Lot size of the scrip	1
order_timestamp	string	Time when he order was registered by OMS	2025-06-11T10:10Z
initiated_by	string	App ID or user ID from where order was placed	MOBILE_APP_01
modified_by	string	App ID or user ID from where order was modified	WEB_PORTAL_02
gateaway_order_id	string	Internal gateaway order ID	GTW123456
order_identifier	string	Optional user-defined identifier for tracking the order	GTD_TCS1

💬Notes

• Use this API to retrieve GTD orders with support for pagination and status filters.
• Each order contains detailed information including pricing, quantities, and instrument metadata.
• Optional fields like initiated_by, trigger_price, and order_identifier are useful for deeper tracking and reporting.

get/transactional/v1/gtdOrders