@swapbills/xchange-rate

Exchange Rate Extractor

Description

A simple wrapper around google finance API for retrieving the exchange rate between two currencies, use at your own risk.

Usage

import xChanger from '@swapbills/xchange-rate'

const xChangeService = xChanger()

const listAllCurrencies = await xChangeService.getCurrencies()
/*
 [{
  "symbol":"AED",
  "name":"United Arab Emirates Dirham",
  "symbol_native":"د.إ.‏",
  "decimal_digits":2,
  "rounding":0,
  "code":"AED",
  "name_plural":"UAE dirhams"
}, ... ] about 168 objects in  a list
*/
const dollarInfo = await xChangeService.getCurrencyInfo('usd')
/*
{
  "symbol":"$",
  "name":"US Dollar",
  "symbol_native":"$",
  "decimal_digits":2,
  "rounding":0,
  "code":"USD",
  "name_plural":"US dollars"
}
*/

const dollarToCediRate = await xChangeService.getRate('ghs','usd')
/*
  4.30
*/

const chartUri = await xChangeService.getChartUri('ghs','usd')
/*
  https://www.google.com/finance/getchart?x=CURRENCY&p=1Y&i=86400&q=GHSUSD
*/ visit this uri and you see a trend chart

Development Quickstart

$ git clone https://github.com/swapbills/xchange-rate.git
$ cd xchange-rate
$ npm install
$ npm run start

Development and Testing

Source Code

The xchange-rate source is hosted on GitHub. Clone the project with

$ git clone [e-mail]:swapbills/xchange-rate.git

Requirements

You will need Node.js.

Be sure that all commands run under the correct Node version, e.g., if using nvm, install the correct version with

$ nvm install

and set the active version for each shell session with

$ nvm use

Install the development dependencies with

$ npm install

Tasks

Primary development tasks are defined under scripts in package.json and available via npm run. View them with

$ npm run

Production Build

Lint, test, and transpile the production build to lib with

$ npm run build

License

This npm package is Copyright (c) 2016-2017 SwapBills Global.

Warranty

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.