GTT Order Book

This API allows you to fetch your GTT orders along with their trigger prices, quantities and current status.

USE CASE

Check whether your GTT orders are pending, traded, cancelled or rejected.

Details

You can fetch all pending GTT Orders.
Orders come back in the orderBook array. Use each order's id to modify or cancel it.
ord_status shows the state: 1 cancelled, 2 traded or filled, 4 in transit, 5 rejected, 6 pending. oms_msg carries the OMS message.
gtt_oco_ind tells the type: 1 for a GTT order and 2 for an OCO order.
The second-leg fields price2_limit, price2_trigger and qty2 apply only to OCO orders.
Each order also includes the current ltp, ltp_ch and ltp_chp of the symbol.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes - For each order

Attribute	Data Type	Description
`code`	int	Status code of the API response: 200: Request successful. Other codes represent specific error conditions.
`message`	string	Optional message about the API request (can be empty for successful requests).
`s`	string	Status of the request: "ok" for success, "error" for failure.
`orderBook`	array	List of order details.
`orderBook[].client_id`	string	Client identifier associated with the order.
`orderBook[].exchange`	int	Exchange code where the order is placed, e.g., 10 for NSE.
`orderBook[].fy_token`	string	Unique token for the instrument in the order.
`orderBook[].id_fyers`	string	Fyers system-generated unique identifier for the order.
`orderBook[].id`	string	Order ID provided by the system.
`orderBook[].instrument`	int	Instrument type, e.g., 0 for equity.
`orderBook[].lot_size`	int	Lot size of the instrument in the order.
`orderBook[].multiplier`	int	Multiplier for the instrument (e.g., for derivatives).
`orderBook[].ord_status`	int	Order status code: 1: Cancelled 2: Traded / Filled 3: For future use 4: Transit 5: Rejected 6: Pending
`orderBook[].precision`	int	Decimal precision for the instrument's price.
`orderBook[].price_limit`	float	Limit price for the first leg of the order.
`orderBook[].price2_limit`	float	Limit price for the second leg (if OCO).
`orderBook[].price_trigger`	float	Trigger price for the first leg of the order.
`orderBook[].price2_trigger`	float	Trigger price for the second leg (if OCO).
`orderBook[].product_type`	string	Product type, e.g., "CNC", "MARGIN", "MTF".
`orderBook[].qty`	int	Quantity for the first leg of the order.
`orderBook[].qty2`	int	Quantity for the second leg (if OCO).
`orderBook[].report_type`	string	Status of the order, e.g., "CANCELLED", "PLACED".
`orderBook[].segment`	int	Segment code, e.g., 10 for equity.
`orderBook[].symbol`	string	Symbol of the instrument, e.g., "NSE:CHOLAFIN-EQ".
`orderBook[].symbol_desc`	string	Full description of the symbol, e.g., "CHOLAMANDALAM IN & FIN CO".
`orderBook[].symbol_exch`	string	Symbol short code on the exchange, e.g., "CHOLAFIN".
`orderBook[].tick_size`	float	Minimum price increment for the instrument.
`orderBook[].tran_side`	int	Transaction side: 1 for buy, -1 for sell.
`orderBook[].gtt_oco_ind`	int	Indicator for the order type: 1: GTT order. 2: OCO order.
`orderBook[].create_time`	string	Creation timestamp of the order in human-readable format.
`orderBook[].create_time_epoch`	int	Creation timestamp of the order in epoch seconds.
`orderBook[].oms_msg`	string	Message from the Order Management System (OMS) about the order's status.
`orderBook[].ltp_ch`	float	Last traded price change.
`orderBook[].ltp_chp`	float	Last traded price change percentage.
`orderBook[].ltp`	float	Last traded price of the instrument.

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"

# Initialize the FyersModel instance with your client_id, access_token, and enable async mode
fyers = fyersModel.FyersModel(client_id=client_id, token=access_token,is_async=False, log_path="")

response = fyers.gtt_orderbook()
print(response)

Response structure:
{
  "s": "ok",
  "code": 200,
  "message": "",
  "orderBook": [
    {
      "clientId": "X******",
      "exchange": 10,
      "fy_token": "10100000003045",
      "id_fyers": "c6697c04-d9ab-4a7c-a6f4-b0cc4ca698f6",
      "id": "25012400002074",
      "instrument": 0,
      "lot_size": 1,
      "multiplier": 0,
      "ord_status": 1,
      "precision": 2,
      "price_limit": 1020,
      "price2_limit": 620,
      "price_trigger": 1020,
      "price2_trigger": 620,
      "product_type": "CNC",
      "qty": 5,
      "qty2": 5,
      "report_type": "CANCELLED",
      "segment": 10,
      "symbol": "NSE:SBIN-EQ",
      "symbol_desc": "STATE BANK OF INDIA",
      "symbol_exch": "SBIN",
      "tick_size": 0.05,
      "tran_side": 1,
      "gtt_oco_ind": 2,
      "create_time": "24-Jan-2025 16:13:31",
      "create_time_epoch": 1737715411,
      "oms_msg": "GTT/OCO order cancelled successfully.",
      "ltp_ch": 0,
      "ltp_chp": 0,
      "ltp": 0
    },
    {
      "clientId": "X******",
      "exchange": 10,
      "fy_token": "10100000003045",
      "id_fyers": "142849a0-d32b-44b5-9108-b7db5ee5e59b",
      "id": "25012400002099",
      "instrument": 0,
      "lot_size": 1,
      "multiplier": 0,
      "ord_status": 1,
      "precision": 2,
      "price_limit": 1000,
      "price2_limit": 600,
      "price_trigger": 1000,
      "price2_trigger": 600,
      "product_type": "MTF",
      "qty": 3,
      "qty2": 3,
      "report_type": "CANCELLED",
      "segment": 10,
      "symbol": "NSE:SBIN-EQ",
      "symbol_desc": "STATE BANK OF INDIA",
      "symbol_exch": "SBIN",
      "tick_size": 0.05,
      "tran_side": -1,
      "gtt_oco_ind": 2,
      "create_time": "24-Jan-2025 16:10:27",
      "create_time_epoch": 1737715227,
      "oms_msg": "GTT/OCO order cancelled successfully.",
      "ltp_ch": 0,
      "ltp_chp": 0,
      "ltp": 0
    }
  ]
}