User Guide
Official Website: https://virresh.github.io/projects/stockd
You will get the downloadable files at https://github.com/virresh/StockD/releases/latest .
Download the file corresponding to your operating system. For example, if you are using Windows, download StockD_Windows.exe, If you're using Linux, download StockD_x64_Linux etc. Note that links to files on this page can be outdated, hence it's recommended to download from the above link to always get the latest release.
Just download the new exe and replace the old one with it.
- Install Microsoft dot net (latest version. >= version 4.1 is recommended) from https://dotnet.microsoft.com/download/dotnet-framework
- Download the latest release from https://github.com/virresh/StockD/releases/latest.
- Run the .exe on Windows
Note - You do not need to install anything for the 64-bit Linux version
- Unzip the downloaded file (You may need an application like 7-zip if your platform doesn't have native .zip support)
- Please extract the files into a new directory. Do not just double click. Use right-click, and then select Extract To / Extract Here, or whatever similar option you have.
- On Windows:
Simply double click on Launcher.bat, that's all. - On Linux and MacOS:
Open a terminal and navigate to the unzipped location. Now from the terminal, type./Launcher.shor./LauncherMac.shas applicable
The main has a from date and a to date. This marks the interval within which you want to download data for. Select this interval and click download, your download should start.
For a detailed set of configuration, you can open the preferences window. You'll find various options for customizing the downloader, for e.g the location of downloaded files, the server to download from, skipping over weekends etc etc.
NSE has several different links on which it serves data. Some links stop working at times and this becomes a problem. To prevent this, I've introduced a dynamically load-able link profile. This profile has links to all the servers. Load whichever profile you wish to use, and the data will be downloaded from there. The available profiles are:
| Profile Name | Profile URL | Description | Minimum StockD version |
|---|---|---|---|
| NSE (with delivery data) | https://virresh.github.io/StockD/py/nse_with_delivery.json | This is the default. Use this for delivery data. Do not use this for historic data pre 2020 | v4.4 |
| NSE Daily | https://virresh.github.io/StockD/py/nse_live.json | This is the one that you will see on the new official website under "daily" section. Use this for EOD without delivery data | v4.0 |
| NSE Archives | https://virresh.github.io/StockD/py/nse_archives.json | This is the one that you will see on the new official website under "archives" section. Use this for EOD without delivery data for backup | v4.0 |
| NSE Old (Depreciated) | https://virresh.github.io/StockD/py/nse_old.json | This is NSE's www1 server. This server will be depreciated from August 2020, so I recommend to not use this profile | v4.0 |
To use any of the above profiles, on go to Advanced tab and paste the profile link. Then hit load button. This will load the corresponding link profile.
Note: These profiles are hosted online using Github-Pages. You can see the exact files at https://github.com/virresh/StockD/tree/gh-pages
You can create your own profiles and load them locally as well using file://<path to your json>. However, be wary that these strings are processed by Java 11's String.format function python's strftime with additional support for the ^ Glibc extension, so you might need some programming knowledge to create the correct string.
Also, only "HTTP get" servers will work.
Note2: You can also edit the generate_config.json directly. If this file is not generated yet, just click on update preferences and it'll generate this file for you with your selected configuration inside this file.
You need to have Microsoft Dot Net framework >= 4.1 installed (https://dotnet.microsoft.com/download/dotnet-framework). Nothing is required for Linux version. Also no need to install Java / Python. These are shipped with the software itself.
No, you don't to download anything other than the zip files from the download page. Starting from Java 9, Oracle will not provide any more JRE binaries. Hence you cannot get "java" even if you wanted to. You will need to install the developer version (JDK), and then you can use the cross-platform "StockD.jar" from the releases.
However, I have already provided platform-specific JREs necessary for running the application in the platform-specific corresponding zip files. I advise you to make use of them.
Use Github Issues: https://github.com/virresh/StockD/issues
I've created a chatroom for all StockD users to connect with each other. You're welcome to use it: https://gitter.im/virresh/StockD
You can find information on contributing at https://github.com/virresh/StockD/wiki/Contributing
- The indices selected in the preferences do not affect Equity Data. They are only for the indices data that is downloaded separately.
Also many of them do not work. I've ported them as-is from the old software, however, it doesn't seem to be working. If someone can help figure this out, it'll be great. All indices are now working and are translated using index mapping listed at: https://github.com/virresh/StockD/wiki/Index-Mapping - Options and Currency Futures does not work. I was not able to understand the data fully and was short on time, so they are just there and do not work at the moment (in the Java version). These were removed in the Python Version (since v4.1).
- Adjustments for Bonus and Split are not done in this data. User needs to take care of these independently.
- There is no backup link profile if you want to get delivery data.
- Check out the FAQ for common queries: https://github.com/virresh/StockD#faq
- If your antivirus is flagging StockD exe, (1) Ensure you've downloaded the exe from Github releases only and (2) Add an exception in your antivirus. If for some reason you don't feel comfortable in adding the exception, the source code is open and you can compile the software yourself and get the source code audited for malicious codes by hiring someone who you trust.
- Uncheck indices download if you only need data of scrips. This will improve the speed
- Selecting a subset of indices does not affect download speed
- If downloading large historical data, download in off-market hours, especially night time.
- When closing the preferences window, saving preferences takes a while. So if it seems like the PC hanged, it has not, it's working in the background. Please be patient.