Nuclear Power Manager

    stock-nse-india
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    NPM

    National Stock Exchange - India (Unofficial)

    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  => {
    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

    getData

    getDataByEndpoint - Get data by NSE API endpoints. API Endpoints list

    Equity Methods

    getEquityCorporateInfo

    getEquityDetails

    getEquityHistoricalData

    getEquityIntradayData

    getEquitySeries

    getEquityTradeInfo

    Index Methods

    getEquityStockIndices

    getIndexIntradayData

    getIndexHistoricalData

    Helper Methods

    getGainersAndLosersByIndex

    getMostActiveEquities

    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

    or

    yarn

    Start the application using 'npm' or 'yarn'

    npm start

    or

    yarn start

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

    For API service documentation please hit http://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 . && 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 http://localhoast:3001

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

    Docker Hub link

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

    Demo

    Please the use below links for the demo.

    Demo URL: https://stock-nse-india.herokuapp.com/

    API Docs URL: https://stock-nse-india.herokuapp.com/api-docs

    Testing

    Run the below command for testing and coverage.

    yarn test

    Install

    npm i stock-nse-india

    DownloadsWeekly Downloads

    12

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    103 kB

    Total Files

    19

    Last publish

    Collaborators

    • asrafalih