📊 NSE India Market Data API

Python • Selenium • REST APIs

A Python-based REST API service that uses Selenium automation to fetch live market data from NSE India and expose it as HTTP APIs.

This project is designed for personal, research, and internal trading tools, where NSE data is required programmatically.

---

🚀 Features

• Live NSE data using Selenium
• REST APIs using Python http.server
• Centralized browser management
• Supports Index & Equity data
• JSON-based responses
• Clean modular architecture

---

📁 Project Structure

NseIndia/
│
├── .venv/                     # Virtual environment
│
├── utils/                     # Selenium scraping logic
│   ├── browser_manager.py
│   ├── get_option_chain.py
│   ├── get_option_chain_v1.py
│   ├── get_option_chain_v2.py
│   ├── get_oi_spurts.py
│   ├── get_MACEquityTable.py
│   ├── get_top_20_gainers_losers.py
│   ├── get_index_performance.py
│   ├── get_volume_gainers.py
│   ├── get_52_week_high_low.py
│   ├── get_advances_or_declines.py
│   ├── get_large_deals.py
│   └── ...
│
├── main.py                    # API Server Entry Point
├── test.py
├── setup.txt
└── Readme.md

---

⚙️ Requirements

• Python 3.9+
• Google Chrome (latest)
• ChromeDriver (matching Chrome version)

---

📦 Python Dependencies

pip install selenium beautifulsoup4

(Optional – Recommended)

pip install webdriver-manager

---

🔧 ChromeDriver Setup

Option 1: Manual

1. Download ChromeDriver https://chromedriver.chromium.org/downloads

2. Add to system PATH or place in:

   C:\Windows\System32
   

Option 2: Auto (Recommended)

Use webdriver-manager inside browser_manager.py.

---

▶️ How to Run the Project

1️⃣ Activate Virtual Environment

D:\TMSS\Project\StockPredict\Python\src\NseIndia> venv\Scripts\activate

2️⃣ Start the API Server

python main.py

Server starts at:

http://localhost:8000

---

🌐 API Base URL

http://localhost:8000

---

📚 API Endpoints

🔹 API Documentation

GET /

---

📈 Top 20 Gainers & Losers

GET /top-20-gainers-losers?index=NIFTY

index values

NIFTY, BANKNIFTY, NIFTYNEXT50, SecGtr20, SecLwr20, FOSec, all

---

📊 Option Chain (Index)

GET /option-chain?index=NIFTY

📊 Option Chain (Stock)

GET /option-chain?stock=RELIANCE

Optional

expiry-date-index=0

---

📉 Index Performance

GET /index-performance?page=broadMarket

Values:

broadMarket | sectoralIndices | otherIndices | fixedIncomeIndices | all

---

📦 Volume Gainers

GET /volume-gainers

---

📈 Open Interest Spurts

GET /oi-spurts

---

📊 Most Active Contracts

GET /most-active-contracts

---

📅 52 Week High / Low

GET /52-week-high-low

---

📉 Advances / Declines

GET /advances-or-declines?page_type=advance

---

💼 Large Deals

GET /large-deals

---

🔢 Version

GET /version

---

❌ Error Handling

• Missing parameters → 400
• Invalid values → 400
• Unknown endpoint → 404

Example:

{
  "detail": "Wrong parameter. Available values are NIFTY, BANKNIFTY"
}

---

🧠 Architecture Overview

• Selenium → Live NSE data
• BrowserManager → Single shared Chrome instance
• Utils Modules → One module per NSE page
• main.py → Lightweight REST server

---

📄 Utility Module Highlight (20%)

get_option_chain.py – Option Chain Scraper

Path

utils/get_option_chain.py

Purpose

Fetches NSE Option Chain data for indices or stocks, parses CALL / STRIKE / PUT data, and returns structured JSON-ready output.

---

Function Signature

def get_option_chain(
    dropdown_id,
    index_name,
    dropdown_id_expiry_date,
    expiry_date_idx=0
)

---

Parameters

Name	Description
dropdown_id	Dropdown ID for index/stock
index_name	Index or equity symbol
dropdown_id_expiry_date	Expiry dropdown ID
expiry_date_idx	Expiry index (0 = nearest)

---

Example Usage

get_option_chain(
    "equity_optionchain_select",
    "NIFTY",
    "expirySelect",
    0
)

---

Returned Data Format

{
  "STRIKE": 22000,
  "CALLS": [...],
  "PUTS": [...]
}

• "-" values converted to 0.0
• Data aligned exactly with NSE table layout

---

NSE Page Used

https://www.nseindia.com/option-chain

---

Error Handling

• Invalid expiry index → returns empty list
• NSE layout change → safe exit

---

⚠️ Important Notes

• NSE blocks aggressive scraping
• Avoid high-frequency API calls
• Intended for educational / personal use
• Not affiliated with NSE India

---

🚀 Future Improvements

• FastAPI migration
• Async scraping
• Redis caching
• Docker support
• Swagger / OpenAPI docs

---

👨‍💻 Author

NSE India Selenium API Project Built with Python & Selenium ❤️

---

If you want next:

• 📦 Dockerfile
• 🚀 FastAPI version
• 📘 Swagger UI
• 🧪 Unit tests

Just say the word 👍