Create GTT Order

Create GTT Rule

This API is used to place the gtt order. Good Till Triggered is active until the trigger condition is met. The trigger is valid for the given expiry date. Whenever the price condition within this period is met, the order will be placed and executed, provided there are enough funds in the trading account, and the limit price order is filled on the exchange.

Endpoint: api/v1/event/gtt
Method-Type: POST

Request Packet

{
"action_type": "single_order",
"expiry_time": "2024-12-12",
"order":{
"client_id": "YG1234",
"disclosed_quantity": 0,
"exchange": "NSE",
"instrument_token": "14366",
"market_protection_percentage": 0,
"order_side": "BUY",
"order_type": "LIMIT",
"price": 11.3,
"product": "CNC",
"quantity": 1,
"sl_order_price": 0,
"sl_order_quantity": 0,
"sl_trigger_price": 0,
"trigger_price": 13.6,
"user_order_id": 122321
    }
}

Body Params

Field Name	Data Type	Description
action_type	String	Type of action single_order
expiry_time	String	Represents a particular date of expiry
client_id	String	Represents the unique ID of a user.
device	String	Device type: Web, Mobile.
disclosed_quantity	Integer	quantity hidden from market
exchange	String	Exchange: NSE, BSE, NFO, MCX
instrument_token	String	Represents the unique ID of an instrument.
market_protection_percentage	String	sets limit on the price deviation
order_side	String	Side of the order BUY or SELL
order_type	String	Type of order LIMIT, MARKET, SL, SLM
price	Float	the price at which order needs to be placed
product	String	Product type: CNC, MIS, NRML
quantity	Integer	Quantity of the order.
sl_order_price	Float	Stop-loss order price.
sl_order_quantity	Integer	Stop-loss order quantity.
sl_trigger_price	Float	Stop-loss trigger price.
trigger_price	Float	Trigger price.
user_order_id	Integer	Represents the unique ID of the order.

Example Code

data = pocket.gttCreateRule(
{
"action_type": "single_order",
"expiry_time": "2024-12-12",
"order":{
"client_id": "YG1234",
"disclosed_quantity": 0,
"exchange": "NSE",
"instrument_token": "14366",
"market_protection_percentage": 0,
"order_side": "BUY",
"order_type": "LIMIT",
"price": 11.3,
"product": "CNC",
"quantity": 1,
"sl_order_price": 0,
"sl_order_quantity": 0,
"sl_trigger_price": 0,
"trigger_price": 13.6,
"user_order_id": 122321
    }
})

Response

{
    "data":
     {
        "id": "ea036a20-2073-4bfb-a852-34662c4bd770"
        },
        "message": "GTT created successfully",
        "status": "success"
    }

Parameter	Description
basket_id	Identifier for the basket order
message	Confirmation message for the order
status	Status of the order modification

Error response

{
    "data": {},
    "error_code": 44000,
    "message": "`order` `product` is invalid",
    "status": "error"
}