Unofficial Python Api for NSE India stock exchange

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbenny05 from gravatar.com tbenny05

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU General Public License v3 (GPLv3)
  • Author: Benny Thadikaran
  • Tags nse , nse-stock-data , stock-market-api , stock-news-api
  • Requires: Python >=3.8
  • Provides-Extra: dev , local , server
Classifiers
Report project as malware

Project description

💰 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 details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbenny05 from gravatar.com tbenny05

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU General Public License v3 (GPLv3)
  • Author: Benny Thadikaran
  • Tags nse , nse-stock-data , stock-market-api , stock-news-api
  • Requires: Python >=3.8
  • Provides-Extra: dev , local , server
Classifiers

Release history Release notifications | RSS feed

This version

2.1.1

2.1.0

2.0.0

1.3.1

1.3.0.post1

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.0

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5.post1

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.2.9

0.2.8

0.2.7.post2

0.2.6.post2

0.2.6.post1

0.2.6

0.2.5

0.2.4

0.2.0.post1

0.1.1.post1

0.1.1

0.0.1

Download files

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

Source Distribution

nse-2.1.1.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

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

nse-2.1.1-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nse-2.1.1.tar.gz
Algorithm Hash digest
SHA256 e10f8f272a04770312b247b56842181c9230d5b5e915e63818be4a6680b84688
MD5 30e022c0fe4d22f69a56894f02a4daf3
BLAKE2b-256 429be7370f05f333251454689ef9bfce18a4f9f007b059cd7fb0627f006f32d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for nse-2.1.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-2.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for nse-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 09a62a01f9fd721f1bd482f59eb0b4c9a287d2e8b964833362fc51f90a66d171
MD5 cb4b5e2f1bae8d278d2ec9a5f6a3b9b6
BLAKE2b-256 dbab77b857b883042a737ffa19e7e5c0a72e00d3405d3d1a4099a94e0d49e0b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for nse-2.1.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