Welcome to NSE’s documentation!

NSE is an unofficial lightweight Python client for the National Stock Exchange of India. Built for traders, analysts, and quant developers who need reliable programmatic access to NSE data without having to worry about cookie handling, rate limits, and retries under flaky network conditions.

Python version: >= 3.8

GitHub Source: BennyThadikaran/NseIndiaApi

Contents

• Installation & Basic Usage
  • Requirements
  • Installation
    • From PyPI
    • Optional: HTTP/2 Support
  • Basic Usage
    • Your First Client
    • Fetching a Live Quote
    • Looking Up a Symbol
    • Option Chain
      • Building a Readable Option Chain
      • Rendering a Table
      • Highlighting Extremes
    • Historical Data
    • Downloading Bhavcopies
    • Market Movers
    • Corporate Filings
• Configuration
  • When to Use MemoryCookieStore
  • Sharing the Rate Limit Across Workers
• Exception Handling
• API
  • NSE class
    • NSE
      • NSE.__init__()
    • General Methods
      • NSE.exit()
      • NSE.status()
      • NSE.lookup()
      • NSE.holidays()
      • NSE.block_deals()
      • NSE.bulk_deals()
    • Stocks Quotes and Market info
      • NSE.equity_meta_info()
      • NSE.shareholding()
      • NSE.quote()
      • NSE.equity_quote()
      • NSE.get_detailed_scrip_data()
      • NSE.live_volume_gainers()
      • NSE.gainers()
      • NSE.losers()
      • NSE.advance_decline()
      • 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.list_equity_stocks_by_index()
      • NSE.list_indices()
      • NSE.list_etf()
      • NSE.list_sme()
      • NSE.list_sgb()
    • List IPOs
      • NSE.list_current_ipo()
      • NSE.list_upcoming_ipo()
      • NSE.list_past_ipo()
    • NSE Circulars
      • NSE.circulars()
    • Download NSE reports
      • NSE.fetch_daily_reports_file_metadata()
      • NSE.equity_bhavcopy()
      • NSE.delivery_bhavcopy()
      • NSE.indices_bhavcopy()
      • NSE.pr_bhavcopy()
      • NSE.fno_bhavcopy()
      • NSE.priceband_report()
      • NSE.cm_mii_security_report()
      • NSE.download_document()
    • Corporate Announcements and Actions
      • NSE.actions()
      • NSE.announcements()
      • NSE.board_meetings()
      • NSE.annual_reports()
      • NSE.financial_results()
      • NSE.results_comparison()
    • Futures and Options (FnO)
      • NSE.get_futures_expiry()
      • NSE.fno_lots()
      • NSE.option_chain()
      • NSE.compile_option_chain()
      • NSE.max_pain()
  • Retry Configuration
    • RetryConfig
  • Type Reference
    • OHLCV
      • OHLCV
        • OHLCV.close
        • OHLCV.date
        • OHLCV.high
        • OHLCV.low
        • OHLCV.open
        • OHLCV.volume
    • CompiledOptionChain
      • CompiledOptionChain
        • CompiledOptionChain.atm
        • CompiledOptionChain.chain
        • CompiledOptionChain.coi_total
        • CompiledOptionChain.expiry
        • CompiledOptionChain.max_coi
        • CompiledOptionChain.max_pain
        • CompiledOptionChain.max_poi
        • CompiledOptionChain.pcr
        • CompiledOptionChain.poi_total
        • CompiledOptionChain.timestamp
        • CompiledOptionChain.underlying
    • StrikeRow
      • StrikeRow
        • StrikeRow.ce
        • StrikeRow.pcr
        • StrikeRow.pe
    • OptionLeg
      • OptionLeg
        • OptionLeg.chg
        • OptionLeg.iv
        • OptionLeg.last
        • OptionLeg.oi
        • OptionLeg.pct_chg
• Utilities
  • consume_archive()
  • prepare_path()
  • split_date_range()
• Running NSE in Server Environments
  • Coordinating Concurrent NSE Downloads
    • FileLock
    • once-kernel
  • Caching
    • DiskCache
    • dogpile.cache
• Migration Guide: 4.0.1 → 5.0.0
  • Before You Upgrade
  • Breaking Changes at a Glance
  • 1. Installation Changes
  • 2. Constructor Changes
  • 3. Public Method Renames
  • 4. Parameter Renames
  • 5. Option Chain Result Keys
  • 6. Exception Model
    • Missing Report Detection
  • 7. On-Disk State Changes
    • Cookie File
    • Option Expiry Cache
  • 8. Rate Limiting
  • 9. Existing Downloads Are No Longer Re-downloaded
  • 10. fno_lots Changes
  • 11. End-to-End Migration Example
  • 12. Migration Checklist
  • 13. Recommended Upgrade Procedure
  • Summary

Acceptable values

• nse.list_equity_stocks_by_index
• nse.fetch_historical_index_data
  • Indices Eligible In Derivatives
  • Broad Market Indices
  • Sectoral Indices
  • Thematic Indices
  • Strategy Indices