💰 NseIndiaApi

An unofficial Python API for the NSE India stock exchange.

Python version: >= 3.8

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

👽 Documentation

https://bennythadikaran.github.io/NseIndiaApi

API limits

All requests through NSE are rate limited or throttled to 3 requests per second. This allows making large number of requests without overloading the server or getting blocked.

  • If downloading a large number of reports from NSE, please do so after-market hours (Preferably late evening).
  • Add an extra 0.5 - 1 sec sleep between requests. The extra run time likely wont make a difference to your script.
  • Save the file and reuse them instead of re-downloading.

Updates

v1.2.0 NSE package now works in server environments like AWS. See PR #10 for details.

🔥 Usage

To install on local machine or PC

pip install nse[local]

To install in a server environment like AWS (Works on local too)

pip install nse[server]

The class accepts two arguments (As of 1.2.0)

  • download_folder - a str filepath, or a pathlib object. The folder stores cookie and any downloaded files.
  • server - If False (default), use the requests module to make requests. Else uses the httpx module with http2 support for running on server.

Note: server=True works both locally and on servers. httpx[http2] module is required to be installed for this to work.

Simple example

from nse import NSE
from pathlib import Path

# Working directory
DIR = Path(__file__).parent

nse = NSE(download_folder=DIR, server=False)

status = nse.status()

advDec = nse.advanceDecline()

nse.exit() # close requests session

Using with statement

with NSE(download_folder=DIR, server=False) 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.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for tbenny05 from gravatar.com tbenny05

Credits

Author: Benny Thadikaran

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GNU General Public License v3 (GPLv3)

Requires

Python >=3.8

Provides Extra

dev local server

Tags

nse nse-stock-data stock-market-api stock-news-api

Classifiers

Report project as malware

Download files

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

Source Distribution

nse-3.2.1.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nse-3.2.1-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file nse-3.2.1.tar.gz.

File metadata

  • Download URL: nse-3.2.1.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for nse-3.2.1.tar.gz
Algorithm Hash digest
SHA256 771a63f128faf81bb892aa7fbee48c5a9196af37070310fadc33fc1cd5043224
MD5 6ca91812f4bd0e2ab746945603f801b4
BLAKE2b-256 302eb5ff6855c5de7ce73c83614dcf0a2d7a0ac74a5151ea1e21ce1d5cf9ee49

See more details on using hashes here.

Provenance

The following attestation bundles were made for nse-3.2.1.tar.gz:

Publisher: publish-to-pypi.yml on BennyThadikaran/NseIndiaApi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nse-3.2.1-py3-none-any.whl.

File metadata

  • Download URL: nse-3.2.1-py3-none-any.whl
  • Upload date:
  • Size: 31.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for nse-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 192e6ee28552d26524e219535a7091e55ed724f3ba6ea1908e64eeb97c303e81
MD5 67fa5bcc1b3a595a33b30d71fec280da
BLAKE2b-256 1d3bc258006d3db0928decaef5f953d1fc8e8ee183cf3bd32beaaef72452e7a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for nse-3.2.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on BennyThadikaran/NseIndiaApi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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