Package Exports

forexrateapi
forexrateapi/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (forexrateapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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();

Link

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']);

Link

fetchHistorical(date, base, currencies)

date <string> Required. Pass in a string with format YYYY-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']);

Link

ohlc(base, currency, date, dateType)

base <string> Optional. Pass in a base currency, defaults to USD.
currency <string> Required. Specify currency you would like to get OHLC for.
date <string> Required. Specify date to use historical midpoint value for conversion with format YYYY-MM-DD. Otherwise, it will use live exchange rate date if value not passed in.
dateType <string> Optional. Pass in a date type, overrides date parameter if passed in.

await api.ohlc('USD', 'EUR', '2024-02-05', null);

Link

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 format YYYY-MM-DD. Otherwise, it will use live exchange rate date if value not passed in.

await api.convert('USD', 'EUR', 100, '2024-02-05');

Link

timeframe(start_date, end_date, base, currencies)

start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
end_date <string> Required. Specify the end date of your timeframe using the format YYYY-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']);

Link

change(start_date, end_date, base, currencies)

start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
end_date <string> Required. Specify the end date of your timeframe using the format YYYY-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']);

Link

usage()

await api.usage();

Link

Official documentation

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.