exchange-rates-ecb
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

Exchange Rates by ECB

npm version

Retrieve Euro foreign exchange reference rates from the European Central Bank.

This module is intended to run on the server via Node.js, not in the browser.

The current currency list is available here. Note that historic data may contain currencies that are no longer available. For the full list of currencies check this.

Supports ESM and CommonJS (require/import).

Installation

$ yarn add exchange-rate-ecb
$ npm install exchange-rate-ecb
$ pnpm install exchange-rate-ecb

Usage

import * as exchangeRates from 'exchange-rate-ecb';

const { date, rates } = await exchangeRates.getLatest();

console.log(`Date: ${date}`);
console.log(`Rates: ${rates}`);

Note: Use the date property to determine when the rates were last updated.

Fetch specific currencies

import * as exchangeRates from 'exchange-rate-ecb';

const { date, rates } = await exchangeRates.getLatest({
  currencies: ['USD', 'JPY'],
});

console.log(`USD: ${rates.USD}`);
console.log(`JPY: ${rates.JPY}`);

Fetch historic rates

import * as exchangeRates from 'exchange-rate-ecb';

const data = await exchangeRates.getHistory();

console.log(`USD: ${data[0].rates.USD}`);

Note: This will fetch the latest 90 days of rates by default.

Fetch historic rates for a specific currency

import * as exchangeRates from 'exchange-rate-ecb';

const data = await exchangeRates.getHistory({
  from: new Date('2023-01-01'),
  currencies: ['USD'],
});

console.log(`USD: ${data[0].rates.USD}`);

Calculate extra pairs (WIP)

import * as exchangeRates from 'exchange-rate-ecb';

const { date, rates, extraPairs } = await exchangeRates.getLatest({
  extraPairs: [
    {
      from: 'SEK',
      to: 'USD',
    },
  ],
});

console.log(`ExtraPairs - From: ${extraPairs[0].from} - To: ${extraPairs[0].to} - Rate: ${extraPairs[0].rate`);

Note: The extra pairs are calculated from the available rates based on the formula rate = rate(from) / rate(to). These are not official rates.

Convert amount to other currencies (WIP)

import * as exchangeRates from 'exchange-rate-ecb';

const { date, rates, amount } = await exchangeRates.getLatest({
  currencies: ['USD', 'JPY'],
  amount: 1000,
});

console.log(`Amount in USD: ${ammount.usd}`);
console.log(`Amount in JPY: ${amount.jpy}`);

Note: Default currency is EUR. If you want to convert to other currency, you need to specify the amount and amountCurrency options.

FAQ

Why are the rates not updated to the latest values ?

The ECB updates the rates daily around 16:00 CET, except on TARGET closing days.

From the ECB website:

The reference rates are usually updated at around 16:00 CET every working day, except on TARGET closing days. They are based on a regular daily concertation procedure between central banks across Europe, which normally takes place at 14:15 CET.

Why do I only get 90 days of data ?

Set the fullHistory option to true to get the full history of rates. ⚠️ This returns a lot of data (daily rates since 1999).

import * as exchangeRates from 'exchange-rate-ecb';

const data = await exchangeRates.getHistory({
  fullHistory: true,
});

Readme

Keywords

none

Package Sidebar

Install

npm i exchange-rates-ecb

Weekly Downloads

2

Version

1.0.4

License

MIT

Unpacked Size

19.5 kB

Total Files

7

Last publish

Collaborators

  • nip10