GTT Order Book

This API returns the list of all GTT orders associated with the client account.

🛣️ Endpoint

GET {{hosturl}}/transactional/v1/gttOrders

🔑 Header Parameters

Fields	Type	Required	Description	Example/Enum
Authorization	string	Yes	Bearer token for authentication	access_token
x-api-key	string	Yes	API key provided by broker	x-api-key

🔍 Query Parameters

Fields	Type	Required	Description	Example/Enum
offset	integer	Yes	Page number of the results to display	1
limit	integer	Yes	Maximum number of records per page	200
orderStatus	integer	Yes	Filter by order status. 1 = Pending, 2 = Completed, -1 = All	-1
reset	boolean	No	Whether to reset pagination	false
order_id	string	No	Filter results for a specific order ID	NYMKZ00005A3

🟢 Success Response – 200 OK

Fields	Type	Description	Example/Enum
status	string	API call status	success
code	string	Response code	s-101
message	string	Success message	Orders fetched successfully
data	array(object)	List of GTT order objects	See below table
metadata	object	Pagination and count summary	See below table

📘 Order Object Fields (inside data array)

Fields	Type	Description	Example/Enum
client_id	string	Client account ID	"SP"
order_id	string	System-generated Order ID	"NYMKL00015;<"
exchange	string	Exchange segment	"BSE_EQ"
scrip_token	integer	Unique token identifying the instrument	500410
exchange_order_no	string	Exchange-assigned order number	"0"
status	string	Current order status	ACTIVE / TRIGGERED / WITHDRAWN / COMPLETED
error_reason	string	Error message if order failed	""
transaction_type	string	Direction of the trade	BUY / SELL
product_type	string	Product category	DELIVERY / INTRADAY
order_type	string	Order type	RL / SL / RL-MKT
total_quantity	integer	Total order quantity	1
pending_quantity	integer	Quantity still pending execution	1
traded_quantity	integer	Quantity already traded	0
prev_traded_quantity	integer	Traded quantity before today	0
today_traded_quantity	integer	Traded quantity today	0
disclosed_quantity	integer	Disclosed quantity	0
order_price	string	Limit price of the order	"2269.00"
trigger_price	string	Trigger price of the order	"2270.00"
validity	string	Order validity type	GTT / DAY
validity_days	integer	Number of validity days	3
symbol	string	Ticker symbol	"ACC"
series	string	Instrument series	"A"
instrument	string	Instrument type	"FUTSTK" / ""
expiry_date	string	Expiry date for derivatives	"2025-03-27" / ""
strike_price	string	Strike price for options	"-1" / "0.00"
option_type	string	Option type	"XX" / "CE" / "PE"
market_lot	integer	Market lot size	1
order_timestamp	string	Timestamp when order was placed	"2024-12-11 17:51:53"
is_amo_order	boolean	Whether it is an After Market Order	false
initiated_by	string	Platform from which order was placed	"WAVE_MOBILE"
modified_by	string	Platform from which order was last modified	"WAVE_MOBILE"
gateway_order_id	string	Internal gateway reference ID	"20241211NYMKL000001A"
order_identifier	integer	Custom order identifier	0
target_price	string	Target profit price (for OCO orders)	"0.00"
target_trigger_price	string	Target trigger price (for OCO orders)	"0.00"

📘 Metadata Object Fields

Fields	Type	Description	Example/Enum
total_records	integer	Total number of orders returned	5
completed_records	integer	Count of completed/executed orders	0
open_records	integer	Count of currently open/active orders	2

📋 Sample Response

{
    "status": "success",
    "code": "s-101",
    "message": "Orders fetched successfully",
    "data": [
        {
            "client_id": "SP",
            "order_id": "NYMKL00015;<",
            "exchange": "BSE_EQ",
            "scrip_token": 500410,
            "exchange_order_no": "0",
            "status": "TRIGGERED",
            "error_reason": "",
            "transaction_type": "BUY",
            "product_type": "DELIVERY",
            "order_type": "RL",
            "total_quantity": 1,
            "pending_quantity": 1,
            "traded_quantity": 0,
            "prev_traded_quantity": 0,
            "today_traded_quantity": 0,
            "disclosed_quantity": 0,
            "order_price": "2269.00",
            "trigger_price": "2270.00",
            "validity": "GTT",
            "validity_days": 3,
            "symbol": "ACC",
            "series": "A",
            "instrument": "",
            "expiry_date": "",
            "strike_price": "0.00",
            "option_type": "",
            "market_lot": 1,
            "order_timestamp": "2024-12-11 17:51:53",
            "is_amo_order": false,
            "initiated_by": "WAVE_MOBILE",
            "modified_by": "WAVE_MOBILE",
            "gateway_order_id": "20241211NYMKL000001A",
            "order_identifier": 0,
            "target_price": "0.00",
            "target_trigger_price": "0.00"
        }
    ],
    "metadata": {
        "total_records": 5,
        "completed_records": 0,
        "open_records": 2
    }
}