Welcome to NSE’s documentation!

NSE is an Unofficial Python Api for NSE India stock exchange

Python version: >= 3.8

All network 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.

GitHub Source: BennyThadikaran/NseIndiaApi

To install on local machine or PC:

$ pip install nse[local]

This will additionally install the requests library.

# server parameter set to False
nse = NSE(download_folder='', server=False)

To install on server like AWS or other cloud services.

$ pip install nse[server]

This will additionally install httpx library with http2 support.

# Make sure to set server parameter to True.
nse = NSE(download_folder='', server=True)

Contents

• Usage
  • Installation
  • Example
• API
  • NSE
  • General Methods
    • NSE.exit()
    • NSE.status()
    • NSE.lookup()
    • NSE.holidays()
    • NSE.blockDeals()
    • NSE.bulkdeals()
  • Stocks Quotes and Market info
    • NSE.equityMetaInfo()
    • NSE.shareholding()
    • NSE.quote()
    • NSE.equityQuote()
    • NSE.getDetailedScripData()
    • NSE.gainers()
    • NSE.losers()
    • NSE.advanceDecline()
    • NSE.fetch_index_names()
    • NSE.fetch_equity_historical_data()
    • NSE.fetch_historical_vix_data()
    • NSE.fetch_historical_fno_data()
    • NSE.fetch_historical_index_data()
    • NSE.fetch_fno_underlying()
  • List Stocks
    • NSE.listFnoStocks()
    • NSE.listEquityStocksByIndex()
    • NSE.listIndices()
    • NSE.listIndexStocks()
    • NSE.listEtf()
    • NSE.listSme()
    • NSE.listSgb()
  • List IPOs
    • NSE.listCurrentIPO()
    • NSE.listUpcomingIPO()
    • NSE.listPastIPO()
  • NSE Circulars
    • NSE.circulars()
  • Download NSE reports
    • NSE.fetch_daily_reports_file_metadata()
    • NSE.equityBhavcopy()
    • NSE.deliveryBhavcopy()
    • NSE.indicesBhavcopy()
    • NSE.pr_bhavcopy()
    • NSE.fnoBhavcopy()
    • NSE.priceband_report()
    • NSE.cm_mii_security_report()
    • NSE.download_document()
  • Corporate Announcements and Actions
    • NSE.actions()
    • NSE.announcements()
    • NSE.boardMeetings()
    • NSE.annual_reports()
  • Futures and Options (FnO)
    • NSE.getFuturesExpiry()
    • NSE.fnoLots()
    • NSE.optionChain()
    • NSE.compileOptionChain()
    • NSE.maxpain()
• Acceptable values for nse.listEquityStocksByIndex
• Acceptable values for nse.fetch_historical_index_data
  • Indices Eligible In Derivatives
  • Broad Market Indices
  • Sectoral Indices
  • Thematic Indices
  • Strategy Indices