Skip to main content

Downloading and analyzing financial data, including indices, stocks, and mutual funds, from India, that is Bharat.

Project description

BharatFinTrack

BharatFinTrack is a Python package designed to simplify the process of downloading and analyzing financial data from India. Conceptualized on September 1, 2024, and launched on September 8, 2024, this package is tailored for long-term investors seeking to streamline their financial data workflows. It focuses on open-source financial data and currently provides functionality for analyzing NSE equity indices. However, it is important to note that the package does not include features for technical indicators or real-time trading at this time. Active development is ongoing, with exciting new features planned for future releases. The goal of BharatFinTrack is to empower users by offering easy access to open-source data, enabling them to make informed financial decisions. Currently, the package offers the following features:

  • Nifty Indices

    • Provides access to the characteristics of NSE equity indices.
    • Calculates the CAGR(%) of all NSE equity indices (excluding dividend reinvestment) from launch.
    • Facilitates downloading Total Return Index, including both price and dividend reinvestment, data for all NSE equity indices.

Roadmap

  • Add support for downloading equity index price data without dividend reinvestment.
  • Provide a summary of daily updated values of equity index price data.
  • Include NAV (Net Asset Value) data for mutual funds.
  • Include NAV data for the National Pension System (NPS).

Easy Installation

To install, use pip:

pip install BharatFinTrack

Quickstart

A brief example of how to start:

>>> import BharatFinTrack
>>> nse_product = BharatFinTrack.NSEProduct()
>>> nse_product.equity_index_category
['broad', 'sector', 'thematic', 'strategy', 'variant']

# get the list of all NSE equity indices
>>> nse_product.all_equity_indices
['NIFTY 100',
 'NIFTY 200',
 'NIFTY 50',
 'NIFTY 50 ARBITRAGE',
 ...]

# download TRI data for a specified NSE equity index
>>> nse_tri = BharatFinTrack.NSETRI()
>>> nse_tri.download_historical_daily_data(
        index='NIFTY 50',
        start_date='23-Sep-2024',
        end_date='27-Sep-2024'
    )
	      Date	   Close
0	2024-09-23	38505.51
1	2024-09-24	38507.55
2	2024-09-25	38602.21
3	2024-09-26	38916.76
4	2024-09-27	38861.64

Documentation

For detailed information, see the documentation.

Toolkit

Status Description
PyPI PyPI - Version PyPI - Status PyPI - Python Version PyPI - Wheel
GitHub GitHub last commit flake8 mypy pytest GitHub repo size
Codecov codecov
Read the Docs Documentation Status
PePy Pepy Total Downloads
License PyPI - License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bharatfintrack-0.1.2.tar.gz (27.6 kB view hashes)

Uploaded Source

Built Distribution

BharatFinTrack-0.1.2-py3-none-any.whl (27.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page