Package nseinfopackage

Date: 31-May-2022

Installation

Use the following for importing: from nseinfopackage import nseinfo

Prerequisites

The pandas package will be imported as pd.

Features

This is a comprehensive app that will allow you to get the details of about 1800 stocks from the National Stock Exchange (NSE) India. This package is developed from the data that is shared by NSE. There are many methods with the help of which you can get the following details:

• Symbol of the company
• Name of the Company
• ISIN Number of the company
• Date of listing
• Paid up Value
• Market lot, and
• Face Value

Methods of the Package

This package is powered by many useful methods. The following is the list of all the methods and their return types.

1. nseinfo.getISINNumber(symbol) This method takes the string input (symbol) of the NSE stock as a string and returns the ISIN number of that stock as a string.
2. nseinfo.getSymbol(isin) This method takes the string input (isin) of the NSE stock as a string and returns the SYMBOL of that stock as a string.
3. nseinfo.getName(irs, value) This method takes two arguments - irs and value. The name of the first argument - irs stands for ISIN or Symboe - hence irs. You can use either ISIN or SYMBOL to get the name of the company. Examples will be given below.
4. nseinfo.getMarketLot(irs, value) This method helps you in getting the value of Market Lot, as an integer. Input to the method would be either ISIN or SYMBOL, and example of its usage is given below.
5. nseinfo.getFaceValue(irs, value) This method helps you in getting the Face value of the underlying stock, as an integer. Input to the method would be either ISIN or SYMBOL, and example of its usage is given below.
6. nseinfo.getPaidUpValue(irs, value) This method helps you in getting the Paid-up value of the underlying stock, as an integer. Input to the method would be either ISIN or SYMBOL, and example of its usage is given below.
7. nseinfo.listedSince(irs, value) This method helps you in fetching the date since the stock was listed in the NSE exchange. Input to this would be, again, irs and value. Examples are shown below.
8. nseinfo.getISINNumbers(symbols) This methods takes a list of strings (SYMBOLS) as the argument, and provides a list of corresponding ISIN values, in that order.
9. nseinfo.getSymbols(isins) This methods takes a list of strings (ISIN) as the argument, and provides a list of corresponding SYMBOL values, in that order.

Method details with examples

1. The nseinfo.getISINNumber(symbol) method accepts symbol which is a string variable. It returns ISIN, which is also a string, and any ISIN begins with INE. Example:
2. nseinfo.getISINNumber('INFY') returns INE009A01021
3. nseinfo.getISINNumber('M&M') returns INE101A01026
4. The nseinfo.getSymbol(isin) method accepts isin which is a string variable, and returns SYMBOL, which is also a string variable. Here are a couple of examples:
5. nseinfo.getSymbol('INE009A01021') returns 'INFY'
6. nseinfo.getSymbol('INE101A01026') returns 'M&M'
7. The getName(irs, value) method accepts two inputs - irs and value. The irs can have one of the two values - 'SYMBOL' or 'ISIN'. Based on this the value of value changes. See the below exmaples for clarity:
8. nseinfo.getName('SYMBOL', 'INFY') will return "Infosys Limited"
9. nseinfo.getName('ISIN NUMBER', 'INE009A01021') will also return "Infosys Limited"
10. The method getMarketLot(irs, value) also accepts two inputs - irs and value. The irs can have one of the two values - 'SYMBOL' or 'ISIN NUMBER'. Based on this the value of value changes. The return value is an integer. See the below exmaples:
11. nseinfo.getMarketLot('SYMBOL', 'INFY') will return integer value of 1.
12. nseinfo.getMarketLot('ISIN NUMBER', 'INE768C01010') will return integer value of 1.
13. The method nseinfo.getFaceValue(irs, value) accepts two inputs - irs and value. The irs can have one of the two values - 'SYMBOL' or 'ISIN NUMBER'. Based on this the value of value changes. The return value is an integer. See the below exmaples:
14. nseinfo.getFaceValue('ISIN NUMBER', 'INE768C01010') will return 10.
15. nseinfo.getFaceValue('SYMBOL', 'ICICIBANK') will return a value of 2.
16. The method nseinfo.getPaidUpValue(irs, value) is also similar to the above methods. This method accepts two inputs - irs and value. The irs can have one of the two values - 'SYMBOL' or 'ISIN NUMBER'. Based on this the value of value changes. The return value is an integer. See the below exmaples:
17. nseinfo.getPaidUpValue('SYMBOL', 'ICICIBANK') returns a value of 2.
18. nseinfo.getPaidUpValue('ISIN NUMBER', 'INE040A01034') returns a value of 1.
19. The nseinfo.listedSince(irs, value) method, like the others, accepts two inputs - irs and value. The irs can have one of the two values - 'SYMBOL' or 'ISIN NUMBER'. Based on this the value of value changes. The return value is string representation of date. Below are the examples:
20. nseinfo.listedSince('SYMBOL', 'INFY') will return '08-FEB-1995'.
21. nseinfo.listedSince('ISIN NUMBER', 'INE358U01012') returns '19-AUG-2019'
22. The method getISINNumbers(symbols) accept an array of symbols and return corresponding array of ISIN Numbers. Below are the examples.
23. nseinfo.getISINNumbers(['INFY','HDFCBANK', 'ICICIBANK']) returns ['INE009A01021', 'INE040A01034', 'INE090A01021']
24. The method getSymbols(isins) accept an array of ISIN Numbers and return corresponding arrays of SYMBOLS. Below is the typical example:
25. nseinfo.getSymbols(['INE009A01021', 'INE040A01034', 'INE090A01021']) returns ['INFY', 'HDFCBANK', 'ICICIBANK']

Notes and Caveats

• The ISINs or SYMBOLS are limited to SERIES type 'EQ' or Equities only.
• If there is an error in the input (ISIN Number or Symbol), the method returns an error 'Error! Some input values are incorrect or not found!' for all the methods other than nseinfo.getSymbols() and nseinfo.getISINNumbers(). In case there are any errors with regards to the list of SYMBOLS or list of ISIN Numbers, then there is specific error with respect to that element, and the return will have a subset of the return value. For example, when you run the method nseinfo.getSymbols(['INE009A01021', 'INE040A08034', 'INE090A01021']), the output will be ['INFY', 'ICICIBANK'], along with an error message 'Error! Some input values are incorrect or not found!'
• You can combine niftythematic package and process for ISIN of different thematic nifty groups of shares. Please refer https://pypi.org/project/thematicnifty/