Skip to content

abskmj/exchangeratesapi

Repository files navigation

npm (scoped) NPM npm Coverage Status Sponsor

Javascript client for exchangeratesapi.io

Javascript client for exchangeratesapi.io

Exchangerates API is the most scalable API for current and historical exchange rates with unmatched performance. API documentation at exchangeratesapi.io

Installation

npm install @abskmj/exchangeratesapi

Examples

Get symbols

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.symbols({ access_key })

Get rates for today

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.rates({ access_key })

Get rates on a date

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.rates({ access_key, date })

Convert currency

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.convert({ access_key, from: 'USD', to: 'EUR', amount: 1 })

Get historical rates

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.timeseries({ access_key, start_at: '2020-01-01', end_at: '2020-03-31'})

Get fluctuations

const exchange = require('@abskmj/exchangeratesapi')

const response = await exchange.fluctuation({ access_key, start_at: '2020-01-01', end_at: '2020-03-31'})

Works with Promises & Callbacks

// promise
exchange.rates().then(response =>{
    console.log(response.data);
});

// callback
exchange.rates({}, (err, response) => {
    if(err) return console.error(err)

    console.log(response.data)
})

API Documentation

Documentation is available at API.md

Fixes & Improvements

Head over to the issues tab at github.com to report a bug or suggest an improvement. Feel free to contribute to the code or documentation by creating a pull request.

Sponsor / Support

If you find the project interesting or helpful, please consider sponsoring or supporting it at github.com.