forexrateapi
v1.0.2
Published
Official Node.js Library for ForexRateAPI
Downloads
1,843
Maintainers
Readme
ForexRateAPI
forexrateapi is the official Node.js wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.
Installation
NPM
$ npm i forexrateapi
Usage
const api = require('forexrateapi');
api.setAPIKey('SET_YOUR_API_KEY_HERE');
await api.fetchLive('USD', ['AUD', 'CAD', 'GBP', 'JPY']);
Documentation
setAPIKey(apiKey)
apiKey
<string> API Key
In order to use this library, you must first call this function with an API key.
api.setAPIKey('SET_YOUR_API_KEY_HERE');
fetchSymbols()
await api.fetchSymbols();
fetchLive(base, currencies)
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.fetchLive('USD', ['AUD', 'CAD', 'GBP', 'JPY']);
fetchHistorical(date, base, currencies)
date
<string> Required. Pass in a string with formatYYYY-MM-DD
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.fetchHistorical('2024-02-05', 'USD', ['AUD', 'CAD', 'GBP', 'JPY']);
convert(from, to, amount, date)
from
<string> Optional. Pass in a base currency, defaults to USD.to
<string> Required. Specify currency you would like to convert to.amount
<number> Required. The amount to convert.date
<string> Optional. Specify date to use historical midpoint value for conversion with formatYYYY-MM-DD
. Otherwise, it will use live exchange rate date if value not passed in.
await api.convert('USD', 'EUR', 100, '2024-02-05');
timeframe(start_date, end_date, base, currencies)
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.timeframe('2024-02-05', '2024-02-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY']);
change(start_date, end_date, base, currencies)
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.change('2024-02-05', '2024-02-06', 'USD', ['AUD', 'CAD', 'GBP', 'JPY']);
FAQ
How do I get an API Key?
Free API Keys are available here.
I want more information
Checkout our FAQs here.
Support
For support, get in touch using this form.