Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 1.37 KB

README.md

File metadata and controls

68 lines (49 loc) · 1.37 KB

currencyapi-js: JS Currency Converter

This package is a JavaScript wrapper for currencyapi.com that aims to make the usage of the API as easy as possible in your project.

Installation

npm

npm install --save @everapi/currencyapi-js

yarn

yarn add @everapi/currencyapi-js

Import

import CurrencyAPI from '@everapi/currencyapi-js';

or use it directly in a Browser:

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

Usage

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

const currencyApi = new CurrencyAPI('YOUR-API-KEY');

Afterwards you can make calls to the API like this:

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

Endpoints accessible with a free account:

  • status
  • currencies
  • latest
  • historical

These advanced endpoints currently require a paid subscription:

  • convert
  • range

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.