Bodu.Financial.ExchangeRates.Ecb
0.7.1
dotnet add package Bodu.Financial.ExchangeRates.Ecb --version 0.7.1
NuGet\Install-Package Bodu.Financial.ExchangeRates.Ecb -Version 0.7.1
<PackageReference Include="Bodu.Financial.ExchangeRates.Ecb" Version="0.7.1" />
<PackageVersion Include="Bodu.Financial.ExchangeRates.Ecb" Version="0.7.1" />
<PackageReference Include="Bodu.Financial.ExchangeRates.Ecb" />
paket add Bodu.Financial.ExchangeRates.Ecb --version 0.7.1
#r "nuget: Bodu.Financial.ExchangeRates.Ecb, 0.7.1"
#:package Bodu.Financial.ExchangeRates.Ecb@0.7.1
#addin nuget:?package=Bodu.Financial.ExchangeRates.Ecb&version=0.7.1
#tool nuget:?package=Bodu.Financial.ExchangeRates.Ecb&version=0.7.1
Bodu.Financial.ExchangeRates.Ecb
API stability — Preview. The public API surface is largely settled but is still being finalized ahead of the 1.0 release and may change; breaking changes can land in a minor version until then.
A Bodu.Financial exchange-rate provider backed by the European Central Bank's published euro foreign-exchange reference rates.
It downloads the ECB eurofxref XML feeds, parses them, and serves the results as
Bodu.Financial.ExchangeRates.ExchangeRate values through the standard IDatedRateProvider
and IRateProvider contracts — so it composes with Money.ConvertTo,
the caching and aggregating providers, and the rest of the Bodu.Financial FX stack.
using Bodu.Financial.ExchangeRates;
// The provider builds and owns its HttpClient from the options; dispose it to release the client.
using var provider = new EcbRateProvider(new EcbRateProviderOptions());
// Warm the cache for a range (recommended), then look rates up synchronously.
await provider.LoadRangeAsync(new DateOnly(2023, 1, 1), new DateOnly(2026, 6, 30));
RateLookupResult usd = provider.GetRate("EUR", "USD", new DateOnly(2023, 1, 3));
// usd.Rate.Rate is the number of US dollars per euro on that date.
// Read a whole range at once (EUR-based pairs; the reverse direction is inverted). The result is
// an IReadOnlyList<ExchangeRate> that also reports the requested window and the observed span.
RateRangeResult series =
await provider.GetRatesAsync("EUR", "JPY", new DateOnly(2026, 1, 1), new DateOnly(2026, 6, 12));
// Discover what pairs the loaded data supports.
foreach (EcbSeriesInfo info in provider.GetAvailablePairs())
Console.WriteLine($"{info.Pair.FromIsoCode}/{info.Pair.ToIsoCode}");
Behaviour
- EUR-based. The ECB quotes the euro against each currency. Direct (
EUR→X) and inverse (X→EUR) lookups are supported; cross pairs are not. - Feeds. The ECB publishes overlapping
eurofxreffiles that each end at the most recent business day and reach back a different distance: a rolling 90-day file and the full history since 1999 (a latest-day file is also available viaEcbRateFeed.Daily). The provider loads the narrowest feed that covers the dates you ask for, minimizing bandwidth. - Loading. Call
PreloadAsync/LoadRangeAsyncto warm the in-memory store. A synchronous lookup that misses an unloaded date will block to download its covering feed only whenAllowSynchronousNetworkAccessis enabled (it isfalseby default, so the provider serves a snapshot of already-loaded data and a synchronous miss does not reach the network). - Caching. Downloaded files are cached on disk (configurable); because every feed extends to the latest business day, each is refreshed on a TTL.
- Configuration.
EcbRateProviderOptionscarries working defaults and binds throughMicrosoft.Extensions.Options. The provider's connection to the ECB is grouped under itsEndpoint(EcbEndpointOptions) — base URL, HTTP timeout, and user-agent — so the feeds can be pointed at a mirror or proxy without touching caching or feed selection. See the package's ownAddEcbExchangeRatesregistration in theBodu.Financial.ExchangeRatesnamespace.
HTTP client and lifetime
The provider is IDisposable and offers two construction styles:
new EcbRateProvider(options, ...)— the provider builds, owns, and disposes its ownHttpClient, created viaRateProviderHttpClientFactory.Createfrom the configured user agent and timeout. Dispose the provider (for example withusing) to release the client.new EcbRateProvider(httpClient, options, ...)— you supply the client and own its lifetime; the provider never disposes a client it did not create. This is the form the*.DependencyInjectionpackage uses, backed byIHttpClientFactory.
Logging
The provider logs through Microsoft.Extensions.Logging. Pass an ILogger to the
constructor, or let the *.DependencyInjection package wire one for you (category
Bodu.Financial.ExchangeRates.EcbRateProvider). When no logger is supplied it
defaults to NullLogger.Instance, so logging is entirely opt-in and free when unused.
The levels follow the conventions used by Microsoft.Extensions.Http, EF Core, and the
Azure SDK — the completed download is the one Information line per fetch, payload detail
is Trace, and degraded paths are Warning. Every level is individually configurable on
EcbRateProviderOptions:
| Event | Default level | Option property |
|---|---|---|
| A feed download is starting | Debug |
DownloadStartingLogLevel |
| A feed loaded (with its observation count) | Information |
DownloadCompletedLogLevel |
| Each individual rate observation ingested | Trace |
ObservationIngestedLogLevel |
| A feed download failed (logged, then re-thrown) | Warning |
DownloadFailedLogLevel |
| A synchronous lookup triggered a blocking network fetch | Warning |
SynchronousNetworkFetchLogLevel |
// Quieten the per-fetch line and turn off per-observation tracing entirely.
var options = new EcbRateProviderOptions
{
DownloadCompletedLogLevel = LogLevel.Debug,
ObservationIngestedLogLevel = LogLevel.None,
};
The default verbosity is deliberately low: at Information you see one line per feed
loaded; at Debug you additionally see when downloads start; only at Trace do you get a
line per rate observation (which can be thousands per feed — keep it for targeted
debugging).
Part of the Bodu utility library.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Bodu.Core (>= 1.0.0)
- Bodu.Financial (>= 1.0.0)
- Bodu.Financial.DependencyInjection (>= 1.0.0)
- Bodu.Financial.ExchangeRates (>= 1.0.0)
- Bodu.Financial.ExchangeRates.DependencyInjection (>= 1.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.12)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Http (>= 10.0.12)
- Microsoft.Extensions.Http.Resilience (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Options (>= 10.0.12)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.12)
-
net8.0
- Bodu.Core (>= 1.0.0)
- Bodu.Financial (>= 1.0.0)
- Bodu.Financial.DependencyInjection (>= 1.0.0)
- Bodu.Financial.ExchangeRates (>= 1.0.0)
- Bodu.Financial.ExchangeRates.DependencyInjection (>= 1.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Http.Resilience (>= 8.10.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.