1.2.1 • Published 3 years ago

safe-exchange-rate v1.2.1

Weekly downloads
18
License
MIT
Repository
github
Last release
3 years ago

safe-exchange-rate

Build Status Code Style Known Vulnerabilities

Safely get exchange rates from different providers. If any provider is down or failing, a different one from an internal list will be used.

The following exchange rate pairs are currently supported:

  • BAT:USD
  • ETH:USD
  • DAI:USD
  • ETC:USD
  • KNC:USD
  • MANA:USD
  • QTUM:USD
  • USDC:USD
  • WBTC:USD
  • ZRX:USD

Only 100% open and free providers are queried:

Installation

npm install safe-exchange-rate

Usage

const getExchangeRate = require('safe-exchange-rate')

getExchangeRate('ETH:USD').then(function (rate) {
  console.log(rate) // 225.68
}

API

getExchangeRate(pair) ⇒ Promise<number>

Obtain the exchange rate between two assets given list of providers. If one fails for any reason, the next in the list is used. The providers include: Bittrex, CoinCap, CoinGecko.

Returns: Promise<number> - The exchange rate.

ParamTypeDescription
pairstringThe rate pair like ETH:USD.

License

MIT