[![NPM](https://nodei.co/npm/stock-nse-india.png)](https://nodei.co/npm/stock-nse-india/) # 🔒 Secure Fork: National Stock Exchange - India (Unofficial) > **Security-focused fork of stock-nse-india with updated axios dependency** ## 🚨 Security Fix This is a secure fork of the original `stock-nse-india` package that addresses critical security vulnerabilities: - ✅ **Fixed**: Axios CSRF Vulnerability (GHSA-wf5p-g6vw-rhxx) - ✅ **Fixed**: Axios SSRF and Credential Leakage (GHSA-jr5f-v2jv-69x6) - ✅ **Updated**: axios from `^0.21.2` to `^1.7.9` - ✅ **Maintained**: Full API compatibility with original package ## 🔄 Migration from stock-nse-india Simply replace your dependency: ```bash # Remove vulnerable package npm uninstall stock-nse-india # Install secure version npm install @vercelink/stock-nse-india-secure ``` Update your imports: ```javascript // Before import { NseIndia } from 'stock-nse-india'; // After import { NseIndia } from '@vercelink/stock-nse-india-secure'; ``` ## National Stock Exchange - India (Unofficial) ![](https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg) ![npm](https://img.shields.io/npm/dt/stock-nse-india) ![NPM](https://img.shields.io/npm/l/stock-nse-india) ![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/hi-imcodeman/stock-nse-india) ![GitHub top language](https://img.shields.io/github/languages/top/hi-imcodeman/stock-nse-india) This package will help us to get equity/index details and historical data from National Stock Exchange of India. Please refer [Documentation](https://hi-imcodeman.github.io/stock-nse-india) here. See the [Examples](https://github.com/hi-imcodeman/stock-nse-india/tree/master/examples) here ## Installation Install using 'npm' ```sh npm i stock-nse-india ``` Install using 'yarn' ```sh yarn add stock-nse-india ``` ## Usage ```javascript import { NseIndia } from "stock-nse-india"; const nseIndia = new NseIndia() // To get all symbols from NSE nseIndia.getAllStockSymbols().then(symbols => { console.log(symbols) }) // To get equity details for specific symbol nseIndia.getEquityDetails('IRCTC').then(details => { console.log(details) }) // To get equity historical data for specific symbol const range = { start: new Date("2010-01-01"), end: new Date("2021-03-20") } nseIndia.getEquityHistoricalData(symbol, range).then(data => { console.log(data) }) ``` ## API Methods ### Common Methods [getAllStockSymbols](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getallstocksymbols) [getData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getdata) [getDataByEndpoint](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getdatabyendpoint) - Get data by NSE API endpoints. [API Endpoints list](https://hi-imcodeman.github.io/stock-nse-india/enums/index.apilist.html) ### Equity Methods [getEquityCorporateInfo](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitycorporateinfo) [getEquityDetails](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitydetails) [getEquityHistoricalData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityhistoricaldata) [getEquityIntradayData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityintradaydata) [getEquityOptionChain](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityoptionchain) [getEquitySeries](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequityseries) [getEquityTradeInfo](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitytradeinfo) ### Index Methods [getEquityStockIndices](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getequitystockindices) [getIndexIntradayData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexintradaydata) [getIndexHistoricalData](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexhistoricaldata) [getIndexOptionChain](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getindexoptionchain) ### Commodity Methods [getCommodityOptionChain](https://hi-imcodeman.github.io/stock-nse-india/classes/index.nseindia.html#getcommodityoptionchain) ### Helper Methods [getGainersAndLosersByIndex](https://hi-imcodeman.github.io/stock-nse-india/modules/helpers.html#getgainersandlosersbyindex) [getMostActiveEquities](https://hi-imcodeman.github.io/stock-nse-india/modules/helpers.html#getmostactiveequities) ## Run locally Clone the repo locally using below command ```sh git clone https://github.com/hi-imcodeman/stock-nse-india.git ``` Goto 'stock-nse-india' folder ```sh cd stock-nse-india ``` Then install packages using 'npm' or 'yarn' ```sh npm install ``` or ```sh yarn ``` Start the application using 'npm' or 'yarn' ```sh npm start ``` or ```sh yarn start ``` **Then open the URL http://localhost:3000 in browser.** For API service documentation please hit http://localhost:3000/api-docs ## CLI We can use this package in CLI. Install for CLI ```sh npm i -g stock-nse-india ``` ### CLI Usage To get CLI help ```sh nseindia --help ``` To get market status ```sh nseindia ``` To get the current equity details of the NSE symbol ```sh nseindia equity IRCTC ``` To get the historical details of the NSE symbol ```sh nseindia historical IRCTC ``` To get the details of the indices ```sh nseindia index ``` To get the details of the specific index ```sh nseindia index "NIFTY AUTO" ``` ## Docker ### Build & Run in local Build and run the docker instance in local machine. ```sh docker build -t nseindia . && docker run --rm -d -p 3001:3001 nseindia:latest ``` ### Start a instance ```sh docker run --rm -d -p 3001:3001 imcodeman/nseindia ``` ### Test the instance Open the browser and hit http://localhost:3001 For API service documentation please hit http://localhost:3001/api-docs ### Docker Hub link https://hub.docker.com/r/imcodeman/nseindia ## Testing Run the below command for testing and coverage. ```sh yarn test ``` ## Contributors