Place GTT Order

GTT (Good Till Triggered) orders let you place buy or sell orders that remain active until a specified trigger price is hit, without an expiry tied to a single trading session.

note

Access to GTT orders requires specific criteria. For more details or to get this feature enabled, please get in touch with your SIPL Support representative.

This API allows you to place a fresh GTT buy or sell order.

🛣️ Endpoint

POST {{hosturl}}/transactional/v1/orders/regular

🔑 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
Content-Type	string	Yes	Must be application/json	application/json

📦 Request Body Schema

Fields	Type	Required	Description	Example/Enum
scrip_info	object	Yes	Instrument details	See below table
transaction_type	string	Yes	Direction of the trade	BUY / SELL
product_type	string	Yes	Product category	DELIVERY / INTRADAY
order_type	string	Yes	Order Types	RL / SL / RL-MKT
quantity	string	Yes	Number of units to trade	"1"
price	number	Yes	Limit price for the order	1721.75
trigger_price	number	Yes	Price that activates the GTT order	1724.75
disclosed_quantity	integer	No	Quantity to disclose publicly	0
validity	string	Yes	Order validity type. Must be GTT for GTT orders	GTT
validity_days	integer	No	Number of days the order stays valid	0
is_amo	boolean	No	Whether this is an After Market Order	false
order_identifier	string	No	Custom identifier for the order	""
freeze_quantity	integer	No	Freeze quantity limit	0

📘 Scrip Info Object Fields

Fields	Type	Required	Description	Example/Enum
exchange	string	Yes	Exchange segments	BSE_EQ
scrip_token	integer	Yes	Unique token for the instrument	500410
symbol	string	Yes	Ticker symbol of the instrument	ACC
series	string	Yes	Series of the instrument	A
expiry_date	string	No	Expiry date for derivatives.	""
strike_price	string	No	Strike price for options.	""
option_type	string	No	Option type (CE/PE).	""

📋 Sample Request Body

{
    "scrip_info": {
        "exchange": "BSE_EQ",
        "scrip_token": 500410,
        "symbol": "ACC",
        "series": "A",
        "expiry_date": "",
        "strike_price": "",
        "option_type": ""
    },
    "transaction_type": "BUY",
    "product_type": "DELIVERY",
    "order_type": "RL",
    "quantity": "1",
    "price": 1721.75,
    "trigger_price": 1724.75,
    "disclosed_quantity": 0,
    "validity": "GTT",
    "validity_days": 0,
    "is_amo": false,
    "order_identifier": "",
    "freeze_quantity": 0
}

🟢 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	Order Entry is acknowledged by the Server
data	object	Contains the placed order details	See below table

📘 Data Object Fields

Fields	Type	Description	Example/Enum
orderId	string	System-generated Order ID	"NYMKL00015;<"
resp_status	string	Internal OMS response status code for GTT acknowledgement	"237"

📋 Sample Response

{
    "status": "success",
    "code": "s-101",
    "message": "Order Entry is acknowledged by the Server",
    "data": {
        "orderId": "NYMKL00015;<",
        "resp_status": "237"
    }
}