ecbfx v1.0.3

ecb-exchange-rates

Node.js API for accessing exchange rates from the European Central Bank public API (https://sdw-wsrest.ecb.europa.eu/help/). Please configure your firewall to allow connections over https to https://sdw-wsrest.ecb.europa.eu if necessary

I am not affiliated with the ECB, this software is provided as is. Please be considerate when accessing ECB resources and try to cache as much as possible. Please check out the help page above if you're going to use this is production.

Installation

npm i -S ecb-exchange-rates

Usage

import { EuropeanCentralBankExchangeRates } from 'ecb-exchange-rates'
// OR
const { EuropeanCentralBankExchangeRates } = require('ecb-exchange-rates')

const ecb = new EuropeanCentralBankExchangeRates()

const options = { 
  startPeriod: new Date('2000'), 
  endPeriod: new Date('2001'), 
  interval: 'M' 
}

(async () => {
  const result = await ecb.exchangeRate(options)
  console.log(result)
})()

Class: EuropeanCentralBankExchangeRates

constructor

endpoint

• Optional endpoint: undefined | string

maxCacheEntries

• Optional maxCacheEntries: undefined | number

maxCacheSize

defaults to 100

• Optional maxCacheSize: undefined | number

maxResponseSize

defaults to 2 mb

• Optional maxResponseSize: undefined | number

requestTimeout

defaults to 20 seconds

• Optional requestTimeout: undefined | number

Methods

destroy

▸ destroy(): void

Returns: void

exchangeRate

▸ exchangeRate(options: IOptions): Promise\

Parameters:

endPeriod

• endPeriod: Date

fromCurrency

defaults to 'EUR'

• Optional fromCurrency: Currency

interval

defaults to 'M'

• Optional interval: \"M\" | \"D\"

maxByteSize

• maxByteSize: number

maxSize

• maxSize: number

startPeriod

• startPeriod: Date

toCurrency

defaults to all

• Optional toCurrency

type

defaults to A

• Optional type: undefined | string

variationCode

defaults to SP00

• Optional variationCode: undefined | string

Returns: Promise\

Interface IOutput

data

• data: IDatum

meta

• meta: IMeta

Interface: IDatum

collection

• collection: string

compilation

• Optional compilation: undefined | string

decimals

• decimals: string

items

• items: IItem

sourceAgency

• sourceAgency: string

timeFormat

• timeFormat: string

title

• title: string

titleCompl

• titleCompl: string

unit

• unit: string

unitMult

• unitMult: string

IItem

period

• period: string

value

• value: number