Token Ticker
![Go Report Card](https://goreportcard.com/badge/github.com/polyrabbit/token-ticker)
NEVER LEAVE YOUR TERMINAL
![token-ticker](https://user-images.githubusercontent.com/2657334/40175207-ff9e6504-5a09-11e8-9a3d-a887ebc4895a.png)
Token-ticker (or tt
for short) is a CLI tool for those who are both Crypto investors and Engineers, allowing you to track token prices and changes in your favorite exchanges on the terminal.
Features
- Auto refresh on a specified interval, watch prices in live update mode
- Proxy aware HTTP request, for easy access to blocked exchanges
- Real-time prices from 12+ exchanges
Supported Exchanges
Installation
Homebrew
# WIP
curl | bash
style downloads to /usr/local/bin
$ curl -sfL https://raw.githubusercontent.com/polyrabbit/token-ticker/master/install.sh | bash -s -- -d -b /usr/local/bin
Using Go (1.12+)
$ go get -u github.com/polyrabbit/token-ticker
Manually
Download from release page and extact the tarbal into /usr/bin or your PATH
directory.
Usage
$ tt --help
Usage: tt [Options] [Exchange1.Token1 Exchange2.Token2 ...]
Track token prices of your favorite exchanges in the terminal
Options:
-v, --Version Show Version number
-d, --debug Enable debug mode
-l, --list-exchanges List supported exchanges
-r, --refresh int Auto refresh on every specified seconds, note every exchange has a rate limit,
too frequent refresh may cause your IP banned by their servers
-c, --config-file string Config file path, use "--example-config-file <path>" to generate an example config file,
by default token-ticker uses "token_ticker.yml" in current directory or $HOME as config file
--example-config-file string[="-"] Generate example config file to the specified file path, by default it outputs to stdout
-s, --show strings Only show comma-separated columns (default [Symbol,Price,%Change(1h),%Change(24h),Source,Updated])
-p, --proxy string Proxy used when sending HTTP request
(eg. "http://localhost:7777", "https://localhost:7777", "socks5://localhost:1080")
-t, --timeout int HTTP request timeout in seconds (default 20)
Exchange.Token Pairs:
Specify which exchange and token pair to query, different exchanges use different forms to express tokens/trading pairs, refer to their URLs to find the format, eg. to get BitCoin price from Bitfinex and CoinMarketCap you should use query string "Bitfinex.BTCUSDT CoinMarketCap.Bitcoin"
Find help/updates from here - https://github.com/polyrabbit/token-ticker
-
Display latest market prices for for BNBUSDT
, BTCUSDT
from Binance
and HTUSDT
from Huobi
$ tt binance.BNBUSDT binance.BTCUSDT Huobi.HTUSDT
Here Binance
and Huobi
can be replaced by any supported exchanges, and different exchanges use different forms to express tokens/symbols/markets, refer to their URLs to find the format.
-
Auto-refresh on every 10 seconds
$ tt -r 10 binance.BNBUSDT binance.BTCUSDT Huobi.HTUSDT
NOTE: some exchanges has a strict rate limit, too frequent refresh may cause your IP banned by their servers.
-
Show specified columns only
$ tt --show Symbol,Price binance.BTCUSDT
See issue #3 for a discussion on this feature.
-
Run with options from a configuration file
$ tt -c token_ticker.example.yaml
Token-ticker can also read options from configuration file, see the attached token_ticker.example.yaml for its format. By default token-ticker searches configuration file token_ticker.yml
in current directory and $HOME
, so you can compose a token_ticker.yml
, place it in your $HOME
and just type tt
to get all pre-defined prices.
$ # Generate an example config file to my $HOME directory
$ tt --example-config-file=$HOME/token_ticker.yml
$
$
$ # token-ticker will search for configuration file "token_ticker.yml" in current directory and "$HOME" by default
$ tt # <--- This is also the way I used most freqently
Thanks
License
The MIT License (MIT) - see LICENSE.md for more details