Get Order by Order ID

This API allows you to fetch the details of a single order using its order ID.

USE CASE

Check the latest status of one order after you place, modify or cancel it.

Details

You can query for a particular order id by passing the id in the get parameters
Pass the order id as the id query parameter, for example GET /api/v3/orders?id=sample_order_id.
The value to pass is the order id assigned by FYERS (the id field of an order). exchOrdId is a different value, the id given by the exchange.
The response uses the same orderBook list and order fields as Get Orders, so one parser can handle both.
status values: 1 Cancelled, 2 Traded / Filled, 4 Transit, 5 Rejected, 6 Pending, 7 Expired. For partial fills compare filledQty with remainingQuantity.
When the order is rejected, message carries the error text.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`clientId`	string	The client id of the fyers user
`id`	string	The unique order id assigned for each order
`exchOrdId`	string	The order id provided by the exchange
`qty`	int	The original order qty
`remainingQuantity`	int	The remaining qty
`filledQty`	int	The filled qty after partial trades
`discloseQty`	int	Disclosed quantity
`limitPrice`	float	The limit price for the order
`stopPrice`	float	The stop price for the order
`tradedPrice`	float	The average traded price for the order
`type`	int	Order type — 1: Limit Order, 2: Market Order, 3: Stop Order (SL-M), 4: Stoplimit Order (SL-L)
`fyToken`	string	Fytoken is a unique identifier for every symbol
`exchange`	int	The exchange in which the order is placed
`segment`	int	The segment of the order — 10: Equity, 11: F&O, 12: Currency, 20: Commodity
`symbol`	string	The symbol for which the order is placed
`instrument`	int	Exchange instrument type
`message`	string	The error message, if any, for this order
`offlineOrder`	boolean	`false` when placed during market hours, `true` when placed as an AMO order
`orderDateTime`	string	The order time as DD-MMM-YYYY hh:mm:ss in IST
`orderValidity`	string	Order validity — `DAY` or `IOC`
`pan`	string	PAN of the client
`productType`	string	The product type of the order
`side`	int	Order side — `1`: Buy, `-1`: Sell
`status`	int	Order status code
`source`	string	Source from where the order was placed
`ex_sym`	string	The exchange symbol (trading symbol without the exchange/segment prefix)
`description`	string	The description of the traded symbol
`ch`	float	Change in LTP compared to the previous close
`chp`	float	Percentage change in LTP compared to the previous close
`lp`	float	Last traded price of the symbol
`slNo`	int	Used to sort the orders based on time
`dqQtyRem`	int	Remaining disclosed quantity
`orderNumStatus`	string	The order id concatenated with its status code
`disclosedQty`	int	Disclosed quantity
`orderTag`	string	Order tag provided when placing the order
`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="")

orderId = "23080444447604"
data = {"id":orderId}

response = fyers.orderbook(data=data)
print(response)

{
    "code":200,
    "message":"",
    "s":"ok",
    "orderBook": [{
              "clientId":"XXXXX86",
              "exchange":10,
              "fyToken":"101000000014366",
              "id":"23080444447604",
              "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 Order by Order ID

Response Attributes

Video learning