Ledger Report

This API allows you to fetch the ledger entries of your account.

USE CASE

Check money movements such as funds added, funds withdrawn and trading entries, with the running balance after each.

Details

Fetches all ledger for a specified date range. If no date range is provided, it defaults to the current financial year.
Filter with transaction_type: 0 all, 1 BR (funds added), 2 BP (funds withdrawn), 3 SJ (trading), 4 JV (non trading) and 5 MTF.
The request attributes list no date fields, although the description says the default period is the current financial year.
Results are paged: page_size defaults to 100 and page_no to 1. The sample response also returns total_count and a summary_data block with opening and closing balance.
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 fetching ledger history

Attribute	Data Type	Description
`page_size`	string	The number of records to be fetched in one page (default is 100)
`page_no`	string	The page number to fetch (default is 1)
`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
`transaction_type`	string	0 → Includes all transaction types [default] 1 → BR(Funds added) 2 → BP(Funds withdrawn) 3 → SJ(Trading) 4 → JV(Non trading) 5 → MTF(Margin Trading Facility)

Response data attributes - For each ledger

Attribute	Data Type	Description
`date`	int	Date on which the transaction occurred.
`transaction_type`	int	Type of transaction such as fund transfer or charges.
`description`	string	Details of the transaction performed on that day.
`credit_amount`	string	Amount credited to your account.
`debit_amount`	string	Amount debited from your account.
`running_balance`	string	Your current account balance.

Response summary attributes - For the summary of the ledger

Attribute	Data Type	Description
`funds_withdrawn`	float	Total amount withdrawn by you from your trading account.
`funds_added`	float	Total amount added by you to your trading account.
`opening_balance`	float	Account balance at the beginning of the selected period.
`closing_balance`	float	Account balance at the end of the selected period.

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 = {
        "page_size": 1,
    }
  response = fyers.ledger_history(data=data)
  print(response)

{
    "code": 200,
    "message": "Ledger report data fetched successfully",
    "data": [
      {
        "credit_amount": 0,
        "date": 1779840000000,
        "debit_amount": 0.06,
        "description": "Executed trades for the day in equity cash segment",
        "running_balance": 177.61000000000053,
        "transaction_type": "Trading"
      }
    ],
    "s": "ok",
    "summary_data": {
      "closing_balance": 177.61000000000053,
      "funds_added": 650,
      "funds_withdrawn": 2952.9399999999996,
      "opening_balance": 146.74
    }
  }