ticker-term

README

ticker-term

Live futures quotes along with a selection of global market indicators, all in your terminal. Data is sourced from Investing.com

About

As an amateur trader mostly focused on US index + treasury futures, I wanted a simple snapshot of various global market indicators that I could reference at a glance outside regular trading hours.

After listening to my laptop fans redline night after night because I had to leave my broker's desktop client open, I decided to build myself a lightweight alternative.

GIFs

Screenshots

Updates

06 April 2021: Added BTC/USD + ETH/USD to the default instruments. See the FAQ for information about the upcoming release of the custom user configurations feature.

05 April 2021: Fixed issue causing occasional program termination when invalid payloads are received.

27 February 2021: Updated color scheme to fix certain elements not displaying with sufficient contrast in some terminals.

Requirements

Linux or macOS. It might work with Windows 10's new bash shell.

go 1.14 (if using go get or building from source).

Installation

Option 1: Using go get (recommended)

go get automatically pulls the source and builds a binary locally.

1. Install go for your platform.

2. Follow these instructions for setting up your $GOPATH.

3. Edit your .bash_profile or .zshrc and make sure $GOPATH/bin is in your $PATH. This is where go get will drop your compiled binary.

4. From a terminal, run go get -u github.com/zpkg/ticker-term

Option 2: Clone and build from source

1. If you don't already have go installed, follow the installation steps for the go runtime laid out under Option 1 above.

2. Clone the repo.

3. cd into the clone path and run go build (if you want to manually place the compiled binary afterwards) or go install (if you want the compiled binary to be automatically dropped into $GOPATH/bin).

Usage

Once installed, simply open a new terminal session and enter ticker-term at the prompt.

FAQ

1. Why can't I see the inactive tickers? Why are the lines spaced inconsistently?

   Inactive tickers are greyed out if there are no price updates for an extended period of time. You may have to adjust your terminal emulator's color settings if the greyed out items are not visible.

2. I keep getting a message about "sleep mode". What is that?

   If there are no price updates to any of the tickers for several minutes, a notification will appear stating that the application has entered sleep mode. While in sleep mode, checks for new data occur only once every sixty seconds.

3. Can I select the instruments myself?

   This functionality will be added soon. Consider it roadmap item #1 (as of 13 March 2020).

   UPDATE (06 April 2021): Coming back to this after a busy year that diverted my attention elsewhere. Adding this feature turned out to be a bit tricky. I've collated a list of symbol IDs that have been used on Investing.com, but around 1/3 of them are inactive or no longer return a valid result (e.g. quoted price is stale).

   Plan at the moment is to add a validated subset of these IDs to the repo as a reference. Thinking I'll then add a startup check for a config file located at $HOME/.config/ticker-term/default.yaml.

   If one isn't found, the current default configuration will be written to that path. If the file exists, it will be read in and used to set the active symbols and the associated layout. Editing this file will provide a means for users to select their own default instruments. Alternate configs would be specified by providing the config path at startup -- something like ticker-term -c $HOME/my-configs/crypto.yaml

Disclaimer

This package is a tool that allows you to retrieve market information from Investing.com. It is not in any way affiliated with Investing.com or its parents, partners, or subsidiaries. No claims are made with regard to the accuracy of the data. This package is for research purposes only and is not intended to provide investment or trading advice.