npm.io
1.0.1 • Published 3 years ago

@everapi/freecurrencyapi-js

Licence
MIT
Version
1.0.1
Deps
0
Size
4 kB
Vulns
0
Weekly
0
Stars
12

freecurrencyapi-js: JS Currency Converter

Freecurrencyapi.com is a free currency API that provides realtime & historic data. This package is a JavaScript wrapper for freecurrencyapi.com that aims to make the usage of the API as easy as possible in your project.

Installation

npm

npm install --save @everapi/freecurrencyapi-js
yarn
yarn add @everapi/freecurrencyapi-js

Import

import Freecurrencyapi from '@everapi/freecurrencyapi-js';

or use it directly in a Browser:

<script src="path/to/freecurrencyapi-js/index.js"></script>

Usage

Initialize the API with your API Key (get one for free at freecurrencyapi.com):

const freecurrencyapi = new Freecurrencyapi('YOUR-API-KEY');

Afterwards you can make calls to the API like this:

freecurrencyapi.latest({
        base_currency: 'USD',
        currencies: 'EUR'
    }).then(response => {
        console.log(response);
    });

Endpoints accessible with a free account:

  • status
  • currencies
  • latest
  • historical

Find out more about our endpoints, parameters and response data structure in the docs

License

The MIT License (MIT). Please see License File for more information.

Keywords