Sign inSign up

junior/ticker

By junior

•Updated over 5 years ago

Docker image for ticker: Terminal stock ticker with live updates and position tracking

Image
0

596

junior/ticker repository overview

Latest Release Build Status Coverage Status Report Card

⁠Ticker

Terminal stock watcher and stock position tracker

⁠Features

  • Live stock price quotes
  • Track value of your stock positions
  • Support for multiple cost basis lots
  • Support for pre and post market price quotes

⁠Install

Download the pre-compiled binaries from the releases page⁠ and copy to a location in PATH or see quick installs below

mac

brew install achannarasappa/tap/ticker

linux

curl -Ls https://api.github.com/repos/achannarasappa/ticker/releases/latest \
| grep -wo "https.*linux-amd64*.tar.gz" \
| wget -qi - \
&& tar -xf ticker*.tar.gz \
&& chmod +x ./ticker \
&& sudo mv ticker /usr/local/bin/

⁠Quick Start

ticker -w NET,AAPL,TSLA
⁠Docker
docker run -it --rm junior/ticker -w AAPL,TSLA,BTC-USD
⁠Docker with options
docker run -it --rm junior/ticker \
  --show-tags --show-fundamentals --show-separator \
  -w BTC-USD,AAPL,TSLA
⁠Docker with configuration file
docker run -it --rm -v ${PWD}/.ticker.yaml:/.ticker.yaml junior/ticker

⁠Usage

AliasFlagDefaultDescription
--config~/.ticker.yamlconfig with watchlist and positions
-i--interval5Refresh interval in seconds
-w--watchlistcomma separated list of symbols to watch
--show-tagsdisplay currency, exchange name, and quote delay for each quote
--show-fundamentalsdisplay open price, previous close, and day range
--show-separatorlayout with separators between each quote
--show-summaryshow total day change, total value, and total value change
--proxyproxy URL for requests (default is none)

⁠Configuration

Configuration is not required to watch stock price but is helpful when always watching the same stocks. Configuration can also be used to set cost basis lots which will in turn be used to show daily gain or loss on any position.

# ~/.ticker.yaml
show-summary: true
show-tags: true
show-fundamentals: true
show-separator: true
interval: 5
watchlist:
  - NET
  - TEAM
  - ESTC
  - BTC-USD
lots:
  - symbol: "ABNB"
    quantity: 35.0
    unit_cost: 146.00
  - symbol: "ARKW"
    quantity: 20.0
    unit_cost: 152.25
  - symbol: "ARKW"
    quantity: 20.0
    unit_cost: 145.35
  • Symbols not on the watchlist that exists in lots will automatically be watched
  • All properties in .ticker.yaml are optional
  • .ticker.yaml can be set in user home directory, the current directory, or XDG config home⁠
⁠Display Options

With --show-summary, --show-tags, --show-fundamentals, and --show-separator options set, the layout and information displayed expands:

⁠Notes

  • Real-time quotes - Quotes are pulled from Yahoo finance which may provide delayed stock quotes depending on the exchange. The major US exchanges (NYSE, NASDAQ) have real-time quotes however other exchanges may not. Consult the help article⁠ on exchange delays to determine which exchanges you can expect delays for or use the --show-tags flag to include timeliness of data alongside quotes in ticker.
  • Cryptocurrencies - ticker supports any cryptocurrency Yahoo / CoinMarketCap supports. A full list can be found here⁠
  • Non-US Symbols, Forex, ETFs - The names for there may differ from their common name/symbols. Try searching the native name in Yahoo finance⁠ to determine the symbol to use in ticker
  • Terminal fonts - Font with support for the HORIZONTAL LINE SEPARATOR unicode character⁠ is required to properly render separators (--show-separator option)
  • tickrs⁠ - real-time terminal stock ticker with support for graphing, options, and other analysis information
  • cointop⁠ - terminal UI tracking cryptocurrencies

Tag summary

Content type

Image

Digest

Size

11.6 MB

Last updated

over 5 years ago

docker pull junior/ticker