Get Orders

This API allows you to fetch all the orders placed in your account today.

USE CASE

Check the current status of every order placed today.

Note

Live Streaming — Receive real-time order updates through the General WebSocket instead of repeatedly polling the Order Book. View General WebSocket Overview documentation.

Details

Fetches all the orders placed by the user across all platforms and exchanges in the current trading day.
Orders placed from other FYERS platforms also appear, not only API orders. The source field tells you where each order was placed.
status values: 1 Cancelled, 2 Traded / Filled, 4 Transit, 5 Rejected, 6 Pending, 7 Expired. Value 3 is not used.
For a partly filled order, compare filledQty with remainingQuantity; tradedPrice is the average traded price.
When an order is rejected, message carries the error text.
orderDateTime is in IST (DD-MMM-YYYY hh:mm:ss), slNo sorts orders by time, and offlineOrder is true for AMO orders.
orderTag carries a 1: prefix for tags you set and 2: for tags generated by FYERS. Orders without a tag show 2:Untagged.
parentId is returned only for orders that have a parent order. Take profit and stop loss prices come in takeProfit and stopLoss.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes - For each order

Attribute	Data Type	Description
`id`	string	The unique order id assigned for each order
`exchOrdId`	string	The order id provided by the exchange
`id_fyers`	string	Fyers system-generated unique identifier for the order
`symbol`	string	The symbol for which order is placed
`qty`	int	The original order qty
`remainingQuantity`	int	The remaining qty
`filledQty`	int	The filled qty after partial trades
`status`	int	1 => Canceled 2 => Traded / Filled 3 => (Not used currently) 4 => Transit 5 => Rejected 6 => Pending 7 => Expired View Details
`slNo`	int	This is used to sort the orders based on the time
`message`	string	The error messages are shown here
`segment`	int	10 => E (Equity) 11 => D (F&O) 12 => C (Currency) 20 => M (Commodity) View Details
`limitPrice`	float	The limit price for the order
`stopPrice`	float	The limit price for the order
`productType`	string	The product type
`type`	int	1 => Limit Order 2 => Market Order 3 => Stop Order (SL-M) 4 => Stoplimit Order (SL-L)
`side`	int	1 => Buy -1 => Sell View Details
`disclosedQty`	int	Disclosed quantity
`orderValidity`	string	DAY IOC
`orderDateTime`	string	The order time as per DD-MMM-YYYY hh:mm:ss in IST
`parentId`	string	The parent order id will be provided only for applicable orders.
`tradedPrice`	float	The average traded price for the order
`source`	string	Source from where the order was placed. View Details
`fytoken`	string	Fytoken is a unique identifier for every symbol. View Details
`offlineOrder`	boolean	False => When market is open True => When placing AMO order
`pan`	string	PAN of the client
`clientId`	string	The client id of the fyers user
`exchange`	int	The exchange in which order is placed View Details
`instrument`	int	Exchange instrument type View Details
`discloseQty`	int	Disclosed quantity
`orderTag`	string	ordertag provided when placing the order Note: `1:` will be concatenated at the start of tag provided by user. `2:` will be concatenated at the start of tag generated internally by Fyers. Default value if tag not provided when order is placed is `2:Untagged`
`takeProfit`	float	Take profit price for the order.
`stopLoss`	float	Stop loss price for the order.

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.orderbook()
print(response)

{
    "code":200,
    "message":"",
    "s":"ok",
    "orderBook":[
        {
          "clientId":"XXXXX86",
          "exchange":10,
          "fyToken":"101000000014366",
          "id":"23080444447604",
          "id_fyers": "c6697c04-d9ab-4a7c-a6f4-b0cc4ca698f6",
          "offlineOrder":false,
          "source":"W",
          "status":2,
          "type":1,
          "pan":"",
          "limitPrice":8.1,
          "productType":"INTRADAY",
          "qty":1,
          "disclosedQty":0,
          "remainingQuantity":0,
          "segment":10,
          "symbol":"NSE:IDEA-EQ",
          "description":"VODAFONE IDEA LIMITED",
          "ex_sym":"IDEA",
          "orderDateTime":"02-Aug-2023 13:01:42",
          "side":1,
          "orderValidity":"DAY",
          "stopPrice":0,
          "tradedPrice":8.1,
          "filledQty":1,
          "exchOrdId":"1100000024706527",
          "message":"",
          "ch":-0.35,
          "chp":-4.24,
          "lp":7.9,
          "orderNumStatus":"23080444447604:2",
          "slNo":1,
          "orderTag": "1:Ordertag",
          "takeProfit":0,
          "stopLoss":0
        }
    ]
  }

Get Orders

Response Attributes - For each order

Video learning