Exchange-tracker NPM

screenshot

exchange-tracker is a small nodejs based application to track crypto currencies related information by utilising the APIs provided by kraken.com. This project is formerly know as ether-tracker.

Features
Changelog
Installation
Kraken API
CLI
Future Plans
Security
Known Problems
Copyright/Licensing
Donate

Features

Timestamp of last update
Days until a year is gone since the purchase (can be useful concerning taxes)
Graph of the last exchange rates
Current exchange
Current balance
Supported exchange keys:
XETHZCAD,XETHZEUR,XETHZGBP,XETHZJPY,XETHZUSD,XLTCZCAD,XLTCZEUR XLTCZUSD,XETHXXBT,XXBTXLTC,XXBTXNMC,XXBTXXDG,XXBTXXLM,XXBTXXRP

Changelog

Have a look at the CHANGELOG.md.

Installation

Simply via npm npm install -g exchange-tracker.

And start the program by typing exchange-tracker into your command line.

Kraken API

To use this tracker you can specify a kraken API key and secret, so your current founds can be queried and displayed. Simply login to kraken, go here and generate a new key. I would suggest to only check the box entitled with Query Funds as this is the only one you actually need. After generating you can simply copy paste the key and secret into your console like shown below.

CLI

The CLI provides some options to be set by user on the startup of the tracker.

This is how one could start the tracker (the parameters are explained below):

exchange-tracker -k KEY -s SECRET  -e XETHZEUR -d 2016-01-13 -i 60 -l false

Or without an API key and secret to only show the graph without your balance:

exchange-tracker -e XETHZEUR -i 60

The configuration is saved in .exchange-tracker.config.json in your home folder. Everytime you update a config parameter, the old one gets overridden.

All options can be found by using the help command:

$ exchange-tracker --help

  Usage: exchange-tracker 

  Changelog: https://github.com/nobol/exchange-tracker/blob/master/CHANGELOG.md
  Readme:    https://github.com/nobol/exchange-tracker/blob/master/README.md

  Possible exchange keys: 
  XETHZCAD,XETHZEUR,XETHZGBP,XETHZJPY,XETHZUSD,XLTCZCAD,XLTCZEUR
  XLTCZUSD,XETHXXBT,XXBTXLTC,XXBTXNMC,XXBTXXDG,XXBTXXLM,XXBTXXRP

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -p, --print                          print the current configuration
    -r, --reset                          reset the current configuration
    -i, --intervall [time of intervall]  update intervall in seconds
    -d, --day [day bought]               day bought
    -k, --key [kraken key]               your kraken key
    -s, --secret [kraken secret]         your kraken secret
    -e, --exchangeKey [exchange key]     currencies to exchange, options in the README
    -w, --chartWidth [width of chart]    width of the chart in chars
    -h, --chartHeight [height of chart]  height of the chart in chars
    -l, --log [true or false]            enables or disables the log

Format for day: YYYY-MM-DD

Future Plans

Support for more markets, e.g. Polonix
I want to have something similar to a profile tracker. The use case would be to set up a profile consisting out of n currencies, there price bought, the current price and the ratio/absolute value change since purchase. At first the current and this new use case will be strictly divided, until I figure out a nice way to sync between the profile and the exchange accounts. I guess I will add a web interface.

Security

Be aware that your kraken API key and secret are not encrypted, but stored locally on your machine. That means that anyone with access to your machine can find the config file with your credentials, if one knows where to search for!

Known Problems

Sometimes it seems like the kraken API is a bit overwhelmed by all our love, so the program is not shutting down anymore, when an API call failed. But informs the user and tries to reach the server again at the next interval.