List of all indices
\n\nGet circulars
\nList of circulars
\n\nGet clearing holidays
\nList of clearing holidays
\n\nOptional range: DateRangeGet equity master
\nEquity master data with categorized indices
\n\nGet index names
\nList of index names
\n\nOptional expiry: stringOptional expiry date in DD-MMM-YYYY format (e.g., "23-Dec-2025").\n If not provided, will fetch nearest upcoming expiry
\nGet option chain contract information (expiry dates and strike prices) for an index
\nGet latest circulars
\nList of latest circulars
\n\nGet market status
\nCurrent market status
\n\nGet market turnover
\nMarket turnover data
\n\nGet merged daily reports for capital market
\nDaily reports for capital market
\n\nGet merged daily reports for debt market
\nDaily reports for debt market
\n\nGet merged daily reports for derivatives
\nDaily reports for derivatives
\n\nGet pre-open market data
\nPre-open market data
\n\nGet technical indicators for a specific equity symbol
\nThe equity symbol (e.g., 'RELIANCE', 'TCS')
\nNumber of days for historical data (default: 200)
\nOptional configuration for indicators
\nOptional adxOptional atrOptional bbOptional bbOptional cciOptional emaOptional macdOptional macdOptional macdOptional mfiOptional momentumOptional rocOptional rsiOptional smaOptional stochD?: numberOptional stochK?: numberOptional williamsRPeriod?: numberPromise
Get trading holidays
\nList of trading holidays
\n\nGenerated using TypeDoc
Generated using TypeDoc
![\"NPM\"](\"https://nodei.co/npm/stock-nse-india.png\")
![\"\"](\"https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg\"){kind=icon}
![\"npm\"](\"https://img.shields.io/npm/dt/stock-nse-india\")
![\"NPM\"](\"https://img.shields.io/npm/l/stock-nse-india\")
![\"GitHub](\"https://img.shields.io/npm/v/stock-nse-india\")
A comprehensive package and API server for accessing equity/index details and historical data from the National Stock Exchange of India. This project provides both an NPM package for direct integration and a full-featured GraphQL/REST API server.
\n๐ Documentation | ๐ Examples
\nโ ๏ธ Prerequisites: Node.js 18+ required
\n![\"GitHub](\"https://img.shields.io/github/languages/top/hi-imcodeman/stock-nse-india\")
npm install stock-nse-india\nimport { NseIndia } from "stock-nse-india";
const nseIndia = new NseIndia();
// Get all stock symbols
const symbols = await nseIndia.getAllStockSymbols();
console.log(symbols);
// Get equity details
const details = await nseIndia.getEquityDetails('IRCTC');
console.log(details);
// Get historical data
const range = {
start: new Date("2020-01-01"),
end: new Date("2023-12-31")
};
const historicalData = await nseIndia.getEquityHistoricalData('IRCTC', range);
console.log(historicalData);\n# Clone and setup
git clone https://github.com/hi-imcodeman/stock-nse-india.git
cd stock-nse-india
npm install
# Start the server
npm start\n๐ Server URLs:
\nnpm install stock-nse-india
# or
yarn add stock-nse-india\nnpm install -g stock-nse-india\ngit clone https://github.com/hi-imcodeman/stock-nse-india.git
cd stock-nse-india
npm install
npm start\nThe project now includes a powerful GraphQL API for flexible data querying:
\n# Get equity information
query GetEquity {
equities(symbolFilter: { symbols: ["IRCTC", "RELIANCE"] }) {
symbol
details {
info {
companyName
industry
isFNOSec
}
metadata {
listingDate
status
}
}
}
}
# Get indices data
query GetIndices {
indices(filter: { filterBy: "NIFTY" }) {
key
index
last
variation
percentChange
}
}\nThe API includes schemas for:
\nThe project includes a Model Context Protocol (MCP) server that allows AI assistants to access NSE India stock market data:
\nModel Context Protocol (MCP) is a standard for AI assistants to communicate with external data sources and tools. This MCP server exposes all NSE India functions as tools that AI models can use.
\nThe MCP implementation is built with a modular architecture for maintainability and consistency:
\nsrc/mcp/mcp-tools.ts: Common tools configuration and handler functions shared across all implementationssrc/mcp/server/mcp-server.ts: Stdio-based MCP server for local AI assistant integrationsrc/mcp/client/mcp-client.ts: OpenAI Functions-based MCP client for natural language queriesAll components share the same tool definitions and business logic, ensuring consistency and making maintenance easier.
\nThe MCP server provides 30 tools covering:
\nThe project includes an advanced MCP client that uses OpenAI's native function calling feature for intelligent query processing:
\nprocessQuery(): Single-round query processing for straightforward requestsprocessQueryWithMultipleFunctions(): Multi-step query processing for complex analysisimport { mcpClient } from './mcp/client/mcp-client'
// Simple query
const response = await mcpClient.processQuery({
query: "What is the current price of TCS stock?",
model: "gpt-4o-mini"
})
// Complex multi-step query
const complexResponse = await mcpClient.processQueryWithMemory({
query: "Compare the performance of Reliance and TCS over the last month and analyze their trends"
})\n# Start the stdio MCP server
npm run start:mcp
# Test the stdio MCP server
npm run test:mcp\nInstallation Steps:
\nPrerequisites: Ensure Node.js 18+ is installed on your system
\nnode --version # Should be v18.0.0 or higher\nInstall the package (optional but recommended for faster startup):
\nnpm install -g stock-nse-india\nNote: If you don't install globally, npx will automatically download and cache the package on first use, which may take a few moments.
Configuration:
\n{
"mcpServers": {
"npx-stock-nse-india": {
"command": "npx",
"args": ["stock-nse-india", "mcp"],
"env": {
"NODE_ENV": "production"
}
}
}
}\n{
"mcpServers": {
"nse-india-stdio": {
"command": "node",
"args": ["build/mcp/server/mcp-server-stdio.js"],
"env": {
"NODE_ENV": "production"
}
}
}
}\nCmd+, (Mac) or Ctrl+, (Windows/Linux) to open settingsAlternatively, you can directly edit the Cursor configuration file:
\n~/.cursor/mcp.json or in your workspace settings%APPDATA%\\Cursor\\mcp.jsonAfter configuration, the MCP server will be available in Cursor's AI assistant, allowing you to query NSE India stock market data directly from the chat interface.
\nFor detailed MCP documentation, see MCP_README.md.
\nComprehensive REST endpoints with automatic Swagger documentation:
\nGET / - Market statusGET /api/marketStatus - Market status informationGET /api/glossary - NSE glossaryGET /api/equity/:symbol - Equity detailsGET /api/equity/:symbol/historical - Historical dataGET /api/indices - Market indicesGET /api-docs - Interactive API documentationPOST /api/mcp/query - Natural language query using OpenAI FunctionsPOST /api/mcp/query-multiple - Multi-step natural language queriesVisit http://localhost:3000/api-docs for complete interactive API documentation powered by Swagger UI.
# Get help
nseindia --help
# Get market status
nseindia
# Get equity details
nseindia equity IRCTC
# Get historical data
nseindia historical IRCTC
# Get indices information
nseindia index
# Get specific index details
nseindia index "NIFTY AUTO"\n# Pull and run from Docker Hub
docker run --rm -d -p 3001:3001 imcodeman/nseindia
# Or build locally
docker build -t nseindia . && docker run --rm -d -p 3001:3001 nseindia:latest\nImage: imcodeman/nseindia
Registry: Docker Hub
# Server Configuration
PORT=3000
HOST_URL=http://localhost:3000
NODE_ENV=development
# CORS Configuration
CORS_ORIGINS=https://myapp.com,https://admin.myapp.com
CORS_METHODS=GET,POST,OPTIONS
CORS_HEADERS=Content-Type,Authorization,X-Requested-With
CORS_CREDENTIALS=true\ngetAllStockSymbols() - Get all NSE stock symbolsgetData() - Generic data retrievalgetDataByEndpoint() - Get data by specific NSE API endpointsgetEquityDetails(symbol) - Get equity informationgetEquityHistoricalData(symbol, range) - Historical price datagetEquityIntradayData(symbol) - Intraday trading datagetEquityOptionChain(symbol) - Options chain datagetEquityCorporateInfo(symbol) - Corporate informationgetEquityTradeInfo(symbol) - Trading statisticsgetEquityStockIndices() - Get all market indicesgetIndexIntradayData(index) - Index intraday datagetIndexOptionChain(index) - Index options datagetIndexOptionChainContractInfo(indexSymbol) - Get option chain contract information (expiry dates and strike prices)getCommodityOptionChain(symbol) - Commodity options datagetGainersAndLosersByIndex(index) - Top gainers and losersgetMostActiveEquities() - Most actively traded stocksโ ๏ธ Prerequisites: Node.js 18+ required
\n# Clone repository
git clone https://github.com/hi-imcodeman/stock-nse-india.git
cd stock-nse-india
# Install dependencies
npm install
# Development mode with auto-reload
npm run start:dev
# Build project
npm run build
# Run tests
npm test
# Generate documentation
npm run docs\nnpm start - Start production servernpm run start:dev - Development mode with auto-reloadnpm run build - Build TypeScript to JavaScriptnpm test - Run test suite with coveragenpm run docs - Generate TypeDoc documentationnpm run lint - Run ESLintnpm run start:mcp - Start stdio MCP servernpm run test:mcp - Test stdio MCP server# Run all tests
npm test
# Run tests with coverage
npm test -- --coverage
# Run specific test file
npm test -- utils.spec.ts\nWe welcome contributions! Please see our contributing guidelines and feel free to submit issues and pull requests.
\nThis project is licensed under the MIT License - see the LICENSE file for details.
\nโญ Star this repository if you find it helpful!
\nGenerated using TypeDoc
All indices data
\nGenerated using TypeDoc
Circulars data from NSE
\nGenerated using TypeDoc
Generated using TypeDoc
Commodity option chain records with numeric strike prices
\nGenerated using TypeDoc
Generated using TypeDoc
Option chain datum with strike price and option details
\nOptional CEOptional PEOptional expiryGenerated using TypeDoc
Corporate information including announcements, actions, and financial results
\nGenerated using TypeDoc
Detailed equity information including price, metadata, and market data
\nGenerated using TypeDoc
Historical equity data with price and volume information
\nGenerated using TypeDoc
Historical equity price and volume information for a single day
\nGenerated using TypeDoc
Equity information including company details and security metadata
\nGenerated using TypeDoc
Equity master data organized by category
\nGenerated using TypeDoc
Equity metadata including series, ISIN, status, and listing information
\nGenerated using TypeDoc
Generated using TypeDoc
Individual equity option chain item with strike price and option details
\nGenerated using TypeDoc
Pre-open market data for equity including indicative equilibrium price
\nGenerated using TypeDoc
Equity price information including current price, change, and trading bands
\nGenerated using TypeDoc
Equity security information including trading status and surveillance details
\nGenerated using TypeDoc
Equity trade information including order book and trade statistics
\nGenerated using TypeDoc
Generated using TypeDoc
Gift Nifty (formerly SGX Nifty) futures data
\nGenerated using TypeDoc
NSE glossary content
\nOptional changedOptional body?: stringOptional field_Optional field_Optional field_Optional field_Optional title?: stringGenerated using TypeDoc
Trading holiday information
\nGenerated using TypeDoc
Trading and clearing holidays organized by segment
\nGenerated using TypeDoc
Detailed index information including constituent stocks and metadata
\nGenerated using TypeDoc
Index constituent equity information
\nOptional metaGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Index option chain records with string strike prices
\nGenerated using TypeDoc
Indicative Nifty 50 index information
\nGenerated using TypeDoc
Generated using TypeDoc
Latest circular data from NSE
\nGenerated using TypeDoc
Market capitalization information
\nGenerated using TypeDoc
Market state information including status and trading details
\nOptional expiryOptional slickclassOptional tradeOptional underlyingOptional updated_Generated using TypeDoc
Generated using TypeDoc
Market turnover information
\nGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Detailed options information including open interest, volume, and pricing
\nOptional askOptional askOptional bidOptional bidpriceOptional buyOptional buyOptional pOptional pchangeOptional sellOptional sellGenerated using TypeDoc
Generated using TypeDoc
Pre-open market data
\nOptional detail?: anyOptional lastOptional listingOptional series?: stringOptional status?: stringOptional priceGenerated using TypeDoc
Series data for equity symbols
\nGenerated using TypeDoc
Technical indicators including SMA, EMA, RSI, MACD, Bollinger Bands, etc.
\nGenerated using TypeDoc
Generated using TypeDoc
Get all indices
\n