Smart Order Book

This API allows you to fetch your smart orders along with their current status and filled quantity.

USE CASE

Check the status of your smart orders and find the flow ID needed to modify, pause or cancel one.

Details

Retrieve the list of all smart orders (active, completed, and cancelled).
Optional query parameters (all optional; repeatable parameters may be passed more than once):
Results are paged. page_no defaults to 1 and page_size to 15. The default sort is UpdatedTime, newest first.
sort_by accepts CreatedTime, UpdatedTime or Alphabet. ord_by is 1 for ascending and -1 for descending.
Filters flowtype, messageType, side, exchange (NSE, BSE, MCX) and product can each be repeated in the query. search matches the symbol name.
flowtype values are 3 (Step), 4 (Limit), 6 (Trail) and 7 (SIP). The filter also lists 5 (Peg).
count is the total number of smart orders before filters, and filterCount is the number after filters.
Each item has flowId, qty, filledQty, status, createdTime and updatedTime.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Attribute	Data Type	Default	Description
`flowtype`	integer[]	(all types)	Filter by order type (repeatable query param): `3` = Step, `4` = Limit, `5` = Peg, `6` = Trail, `7` = SIP
`messageType`	integer[]	(all)	Filter by order status/message type (repeatable query param)
`page_no`	int	`1`	Page number for pagination
`page_size`	int	15	Number of records per page
`sort_by`	string	`"UpdatedTime"`	Sort by field: "CreatedTime", "UpdatedTime", "Alphabet"
`ord_by`	int	`-1`	Sort order: `1` for ascending, `-1` for descending
`side`	integer[]	(all)	Filter by side (repeatable query param): `1` for buy, `-1` for sell
`exchange`	string[]	(all)	Filter by exchange (repeatable query param): "NSE", "BSE", "MCX"
`product`	string[]	(all)	Filter by product type (repeatable query param): "CNC", "MARGIN", "INTRADAY", "MTF"
`search`	string	(none)	Search by symbol name

Response Attributes

Attribute	Data Type	Description
`code`	int	Status code: `200` indicates success
`s`	string	"ok" indicates success
`orderBook`	array	List of smart orders retrieved
`count`	int	Total number of smart orders (before filters)
`filterCount`	int	Number of smart orders after applying filters

Order Book Item Attributes

Attribute	Data Type	Description
`flowId`	string	Unique order identifier
`flowtype`	int	Order type (`3`=Step, `4`=Limit, `6`=Trail, `7`=SIP)
`symbol`	string	Symbol ticker
`side`	int	`1`=Buy, `-1`=Sell
`qty`	int	Total quantity
`filledQty`	int	Executed quantity
`status`	int	Order status
`productType`	string	Product type
`createdTime`	int	Creation timestamp (epoch)
`updatedTime`	int	Last update timestamp (epoch)

Request

from fyers_apiv3 import fyersModel

client_id = "AAAAAAAA-100"
access_token = ""

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

response = fyers.smart_orderbook_with_filter()
print(response)

Response structure:
{
  "code": 200,
  "s": "ok",
  "orderBook": [
    {
      "flowId": "9076cfa3-af4d-4c73-84f5-0e0371ca1a4a",
      "flowtype": 6,
      "fyId": "FAB24810",
      "timestamp": 1769063695,
      "usertag": "untag",
      "messageType": 13,
      "message": "Cancelled",
      "symbol": "NSE:BSE-EQ",
      "description": "BSE LIMITED",
      "fytoken": "101000000019585",
      "ordtype": 2,
      "price": 0,
      "product": "CNC",
      "side": 1,
      "totqty": 1,
      "mpp": -1,
      "mpp_type": 0,
      "remqty": 1,
      "totplcqty": 0,
      "tradedQty": 0,
      "trigprice": 2821.3,
      "avgPrice": 0,
      "rejQty": 0,
      "canQty": 0,
      "validity": "DAY",
      "created_at": 1769063237,
      "updated_at": 1769063695,
      "ch": 78.1,
      "chp": 2.970937309799148,
      "ltp": 2706.9,
      "openQty": 0,
      "jump_diff": 10,
      "target_price": 0
  }
  ],
  "count": 1,
  "filterCount": 1
}