GithubHelp home page GithubHelp logo

imranansari / ticker Goto Github PK

View Code? Open in Web Editor NEW

This project forked from achannarasappa/ticker

0.0 1.0 0.0 190 KB

Terminal stock ticker with live updates and position tracking

License: GNU General Public License v3.0

Go 100.00%

ticker's Introduction

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

Usage

Alias Flag Default Description
--config ~/.ticker.yaml config with watchlist and positions
-i --interval 5 Refresh interval in seconds
-w --watchlist comma separated list of symbols to watch
--show-tags display currency, exchange name, and quote delay for each quote
--show-fundamentals display open price, previous close, and day range
--show-separator layout with separators between each quote
--proxy proxy 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-tags: true
show-fundamentals: true
show-separator: true
interval: 10
proxy: http://localhost:3128
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-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)

Related Tools

  • tickrs - real-time terminal stock ticker with support for graphing, options, and other analysis information
  • cointop - terminal UI tracking cryptocurrencies

ticker's People

Contributors

achannarasappa avatar 1dollarsteak avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.