Package Exports

whale-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (whale-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Whale

Show Ethereum and Bitcoin price in command line interface (CLI).

Install

$ npm install whale-cli -g

Usage

$ whale --help

Usage: whale [options]

Whale, show Ethereum and Bitcoin price in command line interface (CLI).

Options:

  -h, --help              output usage information
  -V, --version           output the version number
  -s, --seconds <number>  Set auto refresh time

Examples:

  $ whale
  $ whale -h
  $ whale -s 60

Interactive UI

Run whale without arguments to launch the interactive UI that guides you through showing market price.

API

const whale = require('whale-cli')

/**
 * Fetch current price of markets
 * @param {String} exchange
 * @param {Array} markets
 */
whale.getCurrentPrice('Poloniex', ['BTC', 'ETH', 'ZEC']).then((res) => {
  console.log(res)
})

/**
 * Fetch price trend of markets
 * @param {String} exchange
 * @param {String} market
 * @param {Number} since options, default one month ago
 * @param {Number} period options, default 24 hour, such as 1440
 */
whale.getPriceTrend('Yunbi', 'ETH').then((res) => {
  console.log(res)
})

Supported Exchanges

whale-tmux - Show Ethereum and Bitcoin price in tmux

whale-cli