💰 NseIndiaApi

An unofficial Python API for the NSE India stock exchange.

Python version: >= 3.8

If you ❤️ my work so far, please 🌟 this repo.

IMPORTANT: Starting 8th July 2024, NSE will replace the current equity Bhavcopy with new UDiFF format.

Run pip install -U nse to update this package. Update your existing scripts to avoid breakage.

👽 Documentation

https://bennythadikaran.github.io/NseIndiaApi

Updates

v1.0.2 Added new method to download daily Priceband report.

v1.0.1 FNO bhavcopy will download the new UDiFF bhavcopy format.

v1.0.0 Breaking Change equityBhavcopy will download the new UDiFF bhavcopy format.

v0.2.9 Added new method to get NSE circulars. See Docs

v0.2.8: Add methods for listing upcoming, current and past IPOs. See Docs

🔥 Usage

Install with Pip

pip install -U nse

The class accepts a single argument download_folder, a str filepath, or a pathlib object. The folder stores cookie and any downloaded files.

Simple example

from nse import NSE
from pathlib import Path

# Working directory
DIR = Path(__file__).parent

nse = NSE(download_folder=DIR)

status = nse.status()

advDec = nse.advanceDecline()

nse.exit() # close requests session

Using with statement

with NSE(download_folder=DIR) as nse:
    status = nse.status()

    advDec = nse.advanceDecline()

Catching errors

from nse import NSE
from datetime import datetime

with NSE('./') as nse:
    try:
        bhavFile = nse.equityBhavcopy(date=datetime.now())
        dlvFile = nse.deliveryBhavcopy(date=datetime.now())
        raise RuntimeError('Some error')  # force an exception
    except RuntimeError as e:
        # continue execution or exit the script
        print(repr(e))

    # execution continues if handled without exit
    actions = nse.actions()

# NSE request session closed - continue processing

Samples folder

The src/samples folder contains sample outputs of various methods. The filenames match the method names. The output has been truncated in some places but demonstrates the overall structure of responses.