Realised P&L Report

This API allows you to fetch the realised profit and loss on your closed positions for a date range.

USE CASE

Check the profit or loss locked in on closed positions, symbol by symbol, with gross P&L, charges and net P&L.

Details

Fetches all realised profit & loss for a specified date range. If no date range is provided, it defaults to the current financial year.
Filter symbol by ISIN for equities and mutual funds, for example INE000A01020, and by trading symbol for derivatives, for example BSE:SENSEX2640976500CE.
Only positions that are fully closed are counted in realized_pnl. For open positions use Get Positions.
Send from_date and to_date as YYYY-MM-DD. Results are paged: page_size defaults to 100 and page_no to 1.
segment_type is 0 all, 1 equity, 2 equity derivatives, 3 mutual funds, 4 currency derivatives and 5 commodity derivatives. exchange_type is 0 all, 1 NSE, 2 BSE and 3 MCX.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes - For each realised profit & loss

Attribute	Data Type	Description
`symbol`	string	For equities and mutual funds, the ISIN is required.Example : INE000A01020 For derivatives, the trading symbol is required. Example : BSE:SENSEX2640976500CE
`page_size`	string	Number of records to fetch on single response (default is 100)
`page_no`	string	The page number to fetch (default is 1)
`from_date`	string	The start date for fetching realised profit & loss history in “YYYY-MM-DD” format (default is the start of the current financial year)
`to_date`	string	The end date for fetching realised profit & loss history in “YYYY-MM-DD” format (default is the current date)
`segment_type`	string	0 → Includes all Segments [default] 1 → Includes only Equity 2 → Includes only Equity Derivatives 3 → Includes Mutal Funds 4 → Includes only Currency Derivatives 5 → Includes only Commodity Derivatives
`exchange_type`	string	0 → Includes all Exchanges [default] 1 → Includes only NSE 2 → Includes only BSE 3 → Includes only MCX

Response data attributes - For each realised profit & loss

Attribute	Data Type	Description
`exch_id`	int	The exchange ID
`seg_id`	int	The segment ID
`segment_name`	string	Market category where the security was traded or invested in.
`exchange_name`	string	The name of the exchange
`symbol_name`	string	Name of the stock, mutual fund, or F&O contract traded.
`realized_pnl`	float	Profit or loss from positions that are fully closed.
`buy_qty`	int	Total quantity or units bought.
`buy_rate`	float	Price per unit, share, or contract at which it was bought.
`sell_qty`	int	Total quantity or units sold.
`sell_rate`	float	Price per unit, share, or contract at which it was sold.
`is_symbol_active`	boolean	Whether the symbol is active or not

Response summary attributes - For the summary of the realised profit & loss

Attribute	Data Type	Description
`gross_pnl`	float	The gross profit & loss of the trade
`net_pnl`	float	The net profit & loss of the trade
`charges`	float	The charges of the trade

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="")

  data = {
        "symbol": "INF204KC1402",
        "page_size": 1,
    }
  response = fyers.realised_profit_history(data=data)
  print(response)

{
      "code": 200,
      "message": "Global PnL report data fetched successfully",
      "s": "ok",
      "data": [
        {
          "buy_qty": 10,
          "buy_rate": 252.5,
          "exch_id": 10,
          "exchange_name": "NSE",
          "is_symbol_active": true,
          "realized_pnl": 38.5,
          "symbol_name": "NSE:SILVERBEES-EQ",
          "seg_id": 10,
          "segment_name": "NSE_CASH",
          "sell_qty": 10,
          "sell_rate": 256.35
        }
      ],
      "summary_data": {
        "charges": 9.77,
        "gross_pnl": 38.5,
        "net_pnl": 28.73
      }
    }