curs-bnr v0.0.4

CURS-BNR

Retrieve the BNR exchange rates for a specific date or the most recent BNR exchange rates.

Installation

npm install curs-bnr

How to use

Retrieve the most recent BNR exchange rates

const { getMostRecentExchangeRates } = require("curs-bnr");
const rates = await getMostRecentExchangeRates();
console.log(rates);
// [
//   { date: '2023-06-02', value: 4.9633, currency: 'EUR' },
//   { date: '2023-06-02', value: 5.7790, currency: 'GBP' }
//   ...
// ]

Retrieve the BNR exchange rates for a specific year

const { getExchangeRatesOfYear } = require("curs-bnr");
const rates = await getExchangeRatesOfYear(2023);
console.log(rates);
// [
//    { date: '2023-01-03', value: 4.9273, currency: 'EUR' },
//    { date: '2023-01-04', value: 4.9264, currency: 'EUR' },
//    ...
// ]

Retrieve the BNR exchange rates for a specific date

const { getExchangeRatesForDate } = require("curs-bnr");
const rates = await getExchangeRatesForDate('2023-06-12');
console.log(rates);
// [
//    { date: '2023-06-12', value: 4.9568, currency: 'EUR' },
//    { date: '2023-06-12', value: 5.7893, currency: 'GBP' },
//    { date: '2023-06-12', value: 3.3022, currency: 'JPY', multiplier: 100 },
//    ...
// ]

Configuration

By default, the API is configured to use the well-known BNR endpoints. If you want to use different endpoints, you can configure them via environment variables. Note that BNR_FX_RATES_OF_YEAR_URL must have the same structure as the default value, with the {year} placeholder.

BNR_FX_RATES_MOST_RECENT_URL="https://www.bnr.ro/nbrfxrates.xml"
BNR_FX_RATES_OF_YEAR_URL="https://bnr.ro/files/xml/years/nbrfxrates{year}.xml"

License

MIT © Cristian Trifan