Get Trades by Order Tag

This API allows you to fetch the trades executed for orders placed with a specific order tag.

USE CASE

Review the fills of a single strategy, using its order tag.

Details

You can query for a particular orderTag by passing the orderTag in the get parameters.
Pass the tag in the GET parameters. The sample request uses order_tag=1:Ordertag, which includes the 1: prefix.
A tag you set when placing an order is stored with 1: in front; tags generated by FYERS get 2:. Trades without a tag show 1:Untagged.
Tag rules at order placement: letters and digits only (no spaces or special characters), 1 to 30 characters, and it cannot be your client ID or Untagged.
The response uses the same trade fields as Get Trades, such as tradePrice, tradedQty and orderNumber.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`symbol`	string	Trading symbol of the instrument, e.g. `NSE:SBIN-EQ`
`row`	int	Unique value used to sort the trades
`orderDateTime`	string	Time the trade occurred, in `DD-MMM-YYYY hh:mm:ss` format (IST)
`orderNumber`	string	The order ID for which the trade occurred
`exchangeOrderNo`	string	The order number provided by the exchange
`tradeNumber`	string	The trade number generated by the exchange
`tradePrice`	float	The traded price
`tradeValue`	float	The total traded value
`tradedQty`	int	The total traded quantity
`orderType`	int	The type of order that generated the trade (e.g. Limit, Market)
`side`	int	1 => Buy -1 => Sell
`productType`	string	The product type in which the order was placed, e.g. CNC or INTRADAY
`segment`	int	The segment in which the order was placed
`exchange`	int	The exchange in which the order was placed
`fyToken`	string	Fytoken — a unique identifier for the symbol
`clientId`	string	The FYERS client ID of the account the trade belongs to
`orderTag`	string	The order tag matched by the `order_tag` filter; a `1:` prefix denotes a user-supplied tag and a `2:` prefix denotes a tag generated internally by FYERS (default is `1:Untagged`)

Python is not available for this example. Showing cURL instead.

Request

Curl Request Method
curl -H "Authorization: app_id:access_token" https://api-t1.fyers.in/api/v3/tradebook?order_tag=1:Ordertag

{
  "s": "ok",
  "code": 200,
  "message": "",
  "tradeBook":
              [{
                "clientId":"FXXXXX",
                "orderDateTime":"07-Aug-2020 13:51:12",
                "orderNumber":"120080789075",
                "exchangeOrderNo": "1200000009204725",
                "exchange":10,
                "side":1,
                "segment":10,
                "orderType":2,
                "fyToken":"101000000010666",
                "productType":"CNC",
                "tradedQty":10,
                "tradePrice":32.7,
                "tradeValue":327.0,
                "tradeNumber":"52605023",
                "row":52605023,
                "symbol":"NSE:PNB-EQ",
                "orderTag": "1:Ordertag"
              },
              {
                "clientId":"FXXXXX",
                "orderDateTime":"07-Aug-2020 13:48:12",
                "orderNumber":"120080789139",
                "exchangeOrderNo": "1000000012031528",
                "exchange":10,
                "side":1,
                "segment":10,
                "orderType":2,
                "fyToken":"101000000010454",
                "productType":"CNC",
                "tradedQty":19,
                "tradePrice":14.1,
                "tradeValue":267.9,
                "tradeNumber":"3281523",
                "row":3281523,
                "symbol":"NSE:CENTRUM-EQ",
                "orderTag": "1:Ordertag"
              },
              {
                "clientId":"FXXXXX1",
                "orderDateTime":"07-Aug-2020 13:47:22",
                "orderNumber":"120080797993",
                "exchangeOrderNo": "1100000008047027",
                "exchange":10,
                "side":1,
                "segment":10,
                "orderType":2,
                "fyToken":"101000000018783",
                "productType":"CNC",
                "tradedQty":4,
                "tradePrice":115.5,
                "tradeValue":462.0,
                "tradeNumber":"27945307",
                "row":27945307,
                "symbol":"NSE:IDFNIFTYET-EQ",
                "orderTag": "1:Ordertag"
              }]
}

Get Trades by Order Tag

Response Attributes

Video learning