stock-nse-india

v1.2.0

This package will help us to get equity/index details and historical data from National Stock Exchange of India. For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.2.0	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.7	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.3	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (384)

GitHub Stars: 115
Forks: 55
Contributors: 5

Direct Usage Popularity

The npm package stock-nse-india receives a total of 384 downloads a week. As such, we scored stock-nse-india popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package stock-nse-india, we found that it has been starred 115 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like stock-nse-india is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 13
Open PR: 11
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of stock-nse-india based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that stock-nse-india demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12

Age: 4 years
Dependencies: 20 Direct
Versions: 14
Install Size: 121 kB
Dist-tags: 1
# of Files: 29
Maintainers: 1
TS Typings: No

stock-nse-india has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

National Stock Exchange - India (Unofficial)

npm NPM GitHub Release Date - Published_At GitHub top language

This package will help us to get equity/index details and historical data from National Stock Exchange of India.

Please refer Documentation here.

See the Examples here

Installation

Install using 'npm'

npm i stock-nse-india

Install using 'yarn'

yarn add stock-nse-india

Usage

import { NseIndia } from  "stock-nse-india";
const  nseIndia = new  NseIndia()
// To get all symbols from NSE
nseIndia.getAllStockSymbols().then(symbols  =&gt; {
console.log(symbols)
})

// To get equity details for specific symbol
nseIndia.getEquityDetails('IRCTC').then(details  =&gt; {
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 =&gt; {
    console.log(data)
})

API Methods

Run locally

Clone the repo locally using below command

git clone https://github.com/hi-imcodeman/stock-nse-india.git

Goto 'stock-nse-india' folder

cd stock-nse-india

Then install packages using 'npm' or 'yarn'

npm install

yarn

Start the application using 'npm' or 'yarn'

npm start

yarn start

Then open the URL https://localhost:3000 in browser.

For API service documentation please hit https://localhoast:3000/api-docs

CLI

We can use this package in CLI.

Install for CLI

npm i -g stock-nse-india

CLI Usage

To get CLI help

nseindia --help

To get market status

nseindia

To get the current equity details of the NSE symbol

nseindia equity IRCTC

To get the historical details of the NSE symbol

nseindia historical IRCTC

To get the details of the indices

nseindia index

To get the details of the specific index

nseindia index "NIFTY AUTO"

Docker

Build & Run in local

Build and run the docker instance in local machine.

docker build -t nseindia . &amp;&amp; docker run --rm -d -p 3001:3001 nseindia:latest

Start a instance

docker run --rm -d -p 3001:3001 imcodeman/nseindia

Test the instance

Open the browser and hit https://localhoast:3001

For API service documentation please hit https://localhoast:3001/api-docs

Docker Hub link

https://hub.docker.com/r/imcodeman/nseindia

Testing

Run the below command for testing and coverage.

yarn test

Contributors

stock-nse-india development dependencies

@types/express @types/jest @types/node @types/swagger-jsdoc @types/swagger-ui-express @types/user-agents @typescript-eslint/eslint-plugin @typescript-eslint/parser copyfiles eslint husky jest lint-staged rimraf ts-jest tsc-watch typedoc typescript

FAQs

What is stock-nse-india?

This package will help us to get equity/index details and historical data from National Stock Exchange of India. Visit Snyk Advisor to see a full health score report for stock-nse-india, including popularity, security, maintenance & community analysis.

Is stock-nse-india popular?

The npm package stock-nse-india receives a total of 384 weekly downloads. As such, stock-nse-india popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is stock-nse-india well maintained?

We found that stock-nse-india demonstrated a healthy version release cadence and project activity. It has a community of 5 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is stock-nse-india safe to use?

While scanning the latest version of stock-nse-india, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 19 December-2024, at 13:37 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP