kp666 / quotr Goto Github PK

#Quotr#

Quotr is a Node.js CLI for getting near real-time stock quotes from Yahoo Finance. It works for pretty much every relevant ticker in the world (currently 26.626 symbols across the globe). The delay depends on the Yahoo's data provider. Normally it's 15 minutes. You can check the list of exchanges and their corresponding delays here.

#Installing#

Make sure you have Node.js installed, then... (you'll need sudo on linux boxes)

npm install -g quotr

#Using#

Open the terminal (or command prompt on Windows) and type:

quotr

Now you've entered the quotr shell.

For getting all available commands:

help

for getting help for a specific command:

<command> /?

Now you can start entering commands...

##Commands##

###symbol-search (short: ss)###

Searchs for ticker symbols that match the given criteria. Example:

ss apple

###snapshot (short: s)###

Displays the latest information about the given symbol. Example:

s aapl

Optionally, you can pass fields in using the -f parameter. Example:

s aapl -f v (displays the volume)

Now it would be helpful to know the available fields for the s command...

###field-list (short: f)###

Displays or searches for the available snapshot fields. Examples:

f (displays all fields)
f -s average (displays all fields that match `average`)

###history (short: h)###

Displays the history for a given symbol. Examples:

h aapl (displays the last 10 days history of the `aapl` symbol, which is the default in case no interval is specified)
h aapl -l 60 (displays the last 60 days history for the `aapl` symbol)
h aapl -f 2015-10-01 -t 2015-10-30 (displays the history for the `aapl` symbol from 2015-10-01 to 2015-10-30)

Currently, the history command does not take into account the current day until it's closed.

###variation (short: v)###

Displays the variation of the given symbol. Examples:

v aapl (displays the last 10 days variation of the `aapl` symbol, which is the default in case no interval is specified)
v aapl -l 60 (displays the last 60 days variation for the `aapl` symbol)
v aapl -f 2015-10-01 -t 2015-10-30 (displays the varoatopm for the `aapl` symbol from 2015-10-01 to 2015-10-30)

Currently, the variation command does not take into account the current day until it's closed.

###License###

MIT.

###Third Party###

• vorpal - For creating the CLI.
• node-yahoo-finance - For getting data out of Yahoo Finance.
• yahoo-ticker-symbol-downloader - For getting all the ticker symbols our of Yahoo Finance.
• babar - For creating the bar charts.