https://github.com/crissdev/curs-bnr

Cursul valutar comunicat de BNR
https://github.com/crissdev/curs-bnr

Last synced: about 2 months ago
JSON representation

Cursul valutar comunicat de BNR

• Host: GitHub
• URL: https://github.com/crissdev/curs-bnr
• Owner: crissdev
• Created: 2023-05-31T05:18:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-06T05:32:17.000Z (8 months ago)
• Last Synced: 2024-05-06T06:34:12.893Z (8 months ago)
• Language: TypeScript
• Size: 816 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CURS-BNR

[![npm version](https://badge.fury.io/js/curs-bnr.svg)](https://badge.fury.io/js/curs-bnr)

[![CI](https://github.com/crissdev/curs-bnr/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/crissdev/curs-bnr/actions/workflows/node.js.yml)

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

## Installation

```sh

npm install curs-bnr

```

## How to use

**Retrieve the most recent BNR exchange rates**

```js

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**

```js

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**

```js

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.

```env

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](https://cristian-trifan.dev)