pynse

Library to extract publicly available real-time and historical data from NSE website.

Bhavcopy & Option Chain Analysis

pyNSE Tytorial

Installation

This module is installed via pip:

pip install --upgrade git+https://github.com/StreamAlpha/pynse.git

Prerequisites

Python 3.7 or above

Using the API

Overview

There is only one class in the whole library Nse. First run will create directories for storing the data and will download the index symbols.EOD data like bhavcopy and option chain are also saved to local directory.

Logging

The whole library is equipped with python's logging moduele for debugging. If more debug information is needed, enable logging using the following code.

import logging
logging.basicConfig(level=logging.DEBUG)

Initializing

from pynse import *


nse=Nse()

Get Market Status

nse.market_status()

Get Symbol Information

nse.info('SBIN')

Get Quote

Get realtime quote for EQ, FUT and OPT. If no expiry date is provided for derivatives, returns date for nearest expiry.

for cash

nse.get_quote('RELIANCE')

for futures

nse.get_quote('TCS', segment=Segment.FUT, expiry=dt.date( 2020, 6, 30 ))

for options

nse.get_quote('HDFC', segment=Segment.OPT, optionType=OptionType.PE, strike=1800.)

Bhavcopy for Cash

download bhavcopy from nse or read bhavcopy if already downloaded

nse.bhavcopy()

or

nse.bhavcopy(dt.date(2020,6,17))

Bhavcopy for F&O

download bhavcopy from nse or read bhavcopy if already downloaded

nse.bhavcopy_fno()

or

nse.bhavcopy_fno(dt.date(2020,6,17))

Pre Open data

get pre open data from nse

nse.pre_open()

Option Chain

Downloads the latest available option chain from nse website

nse.option_chain('INFY')

or

nse.option_chain('INFY',expiry=dt.date(2020,6,30))

FII and DII Data

get FII and DII data from nse

nse.fii_dii()

Historical Data

get historical data from nse symbol index or symbol

nse.get_hist('SBIN')

or

nse.get_hist('NIFTY 50', from_date=dt.date(2020,1,1),to_date=dt.date(2020,6,26))

Realtime Index

Get realtime index value

nse.get_indices(IndexSymbol.NiftyInfra)

or

nse.get_indices(IndexSymbol.Nifty50)

Top Gainers and Losers

presently works only for SECURITIES IN F&O

nse.top_gainers(index=IndexSymbol.FnO, length=10)

or

nse.top_losers(index=IndexSymbol.FnO, length=10)

Update Symbol Lists

Update list of symbols.No need to run frequently, its only required when constituent of an index is changed or list of securities in fno are updated

nse.update_symbol_list()

Clear Data

pynse stores data to .pynse folder in user home directry. Clear data If this folder is using high disk space

nse.clear_data()

License

© 2021 StreamAlpha

This repository is licensed under MIT license. See LICENSE for details.