Menu
▾
▴
Tree [10a1f1] master / History
Read Me
quoter - The Console Based Stock Quote Tool
Quoter is a small command line tool to fetch stock quotes. In order to minimize HTML scraping, it retrieves quotes from IEXCloud. You can signup for free and get 500k stock quotes per month. Please check their usage agreements prior to signing up and ensure you are allowed to user their service.
After getting an account, log into the dashboard and you can see your API tokens. You'll need the secret token to use this program. The secret key starts with sk_
Unfortunately, IEXCloud does not provide index data. Therefore they are scraped from a finance website to get the DOW, NASDAQ, and S&P500 data. I don't really like this, but it seems the only option at this point. It does mean that there is a likelihood that I'll probably have to keep updating the program if the web page format changes.
I live in the US and have no idea how this will perform for stock exchanges. For indexes, it only pulls the DOW, S&P500, and the NASDAQ.
Program Setup
Before you can start to use the tool, you'll need to store your API Secret Key. To do this execute the following:
java -jar quoter.jar -c
This will prompt you for the key which will be stored in the java preferences system. On Windows this is the registry. In Linux it's a hidden directory inside your home directory. Currently it is not encrypted, but I'll need to look into this at some point.
Note that if Quoter has been installed via a snap, quoter -c is all that is needed.
Program Options
Configuration
| Option | Description |
|---|---|
| -c | Configure the IEXCloud.IO API key |
| -k | Display the configured IEX secret API key and exit |
| -s | Save the securities provided into the preferences system to be executed each time Quoter is run. If a -d Detailed or -t Trend is requested, the saved securities will be included. If a symbol is added on the command line it will be shown along with those that are saved. If -s is provided and there are already saved securities, the current list will overwrite the old list |
| -r | Remove saved securities. If you'd like them back you'll need to re-save them |
| -i | Ignore saved queries for this execution. They will remain saved |
Security Information
| Option | Description |
|---|---|
| -d | Display detailed stock information for the symbols provided. This is simply additional information retreived from IEXCloud |
| -t | After the initial quote information, display a three month historical view of close prices. Please note that this call is heavily weighted by IEXCLOUD and will use quite a few messages |
| -x FileName | Export the results into the specified file in CSV format. Note it needs to be a location can can be written to by the user |
Miscellaneous
| Option | Description |
|---|---|
| -D | Start in Debug Mode which will display additional debugging data. Normally not used |
| -v | Display the version and exit |
| -h or -? | Display the help page |
Parameters
No parameters are required. If none are entered, the program will provide the DOW, NASDAQ, and S&P500 index data.
However, you probably want some quotes. Therefore, provide one or more.
Example:
java -jar quoter.jar amzn msft acn ibm
java -jar quoter.jar -x outputfile.csv t bp cmcsa ni vz
Trending
This feature will allow for approximately three months of trending. Quoter will pull the data from IEXCloud.io and show a simple time based graph. The dates are on the Y axis, an the cost is on the X axis. It's probably 90 degrees to what I'd like, but it's not a GUI application and there are limited capabilities of doing this in the console.
It's executed by giving Quoter the -t command line switch. If there are 5 symbols on the command line, it will trend them all.
Please note that this call to IEXCloud is weighted heavily and will use quite a few of your allowed monthly calls. However, given you get 500,000 calls per month, there is probably plenty if it's not massively over used.
SNAP Installation
I would encourage anyone with a supported Linux platform to use snap. See Snapcraft Homepage for more information. You can download, install, and keep the application up to date automatically by installing the snap via :
sudo snap install quoter (Assuming snap is installed)
This will install the application into a sandbox where it is separate from other applications. Java is even included in the SNAP package so you don't evey have to have it elsewhere. I do want to look at packaging it via Flatpak as well, but my understanding is that Maven is not well supported. However, I need to do more investigation.
Feedback
This is obviously not meant to be a large financial package. It's just a small utility that I wanted to use to tell me if I'll ever be able to retire :-) If you have suggestions or idea, please let me know.
quoter at fross dot org.
License
Copyright 2018-2020 by Michael Fross
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.