Objective
We wish to create a project that will allow retreival of data from the national stock exchange in realtime. This repo aims to be fast and easy to use.
Introduction.
NSEToolsPy is a library for collecting real time data from National Stock Exchange (India). It can be used in various types of projects which requires getting live quotes for a given stock or index or build large data sets for further data analytics. You can also build cli applications which can provide you live market details at a blazing fast speeds, much faster that the browsers. The accuracy of data is only as correct as provided on www.nseindia.com.
Main Features:
- Getting live quotes for stocks using stock codes.
- Return data in both json and python dict and list formats.
- Getting quotes for all the indices traded in NSE, e.g CNX NIFTY, BANKNIFTY etc.
- Getting list of top losers.
- Getting list of top gainers.
- Helper APIs to check whether a given stock code or index code is correct.
- Getting list of all indices and stocks.
- Cent percent unittest coverage.
Dependencies
It is advised to use Anaconda python 3.6 as there is extensive use of pandas along with other libraries.
Note: To use the API you will need an active internet connection
Detailed Documenation
For complete documentation of this project refer to https://arkoprabho.github.io/NSEToolsPy3/
Contributing
This is primarily a hobby project. There will be stretches of time when there will be very little to no activity in this repo, as sometimes it is tough to balance hobbies and life in general. Try promoting the project wherever you can if you liked it. It will bring the attention of more people into this repo and allow for more eyes and brains better than mine to start working on it. You can contribute to the project in the following ways:
- Raise issues here. I will try to fix and solve the issues as soon as possible. They will be top priority at all times. I also urge the community to keep that in mind.
- Fork the repository, make changes as you feel suitable. These changes can improve readability, performance or add new features. In case they do enhance performance, add a performance comparison along with the pull requests. I will add frequent contributors to the contributor list to prevent the hassle of submitting pull requests.
- Contact me on my email address, for any other way of contributing.