Bodu.Financial.ExchangeRates.Rba
0.7.1
dotnet add package Bodu.Financial.ExchangeRates.Rba --version 0.7.1
NuGet\Install-Package Bodu.Financial.ExchangeRates.Rba -Version 0.7.1
<PackageReference Include="Bodu.Financial.ExchangeRates.Rba" Version="0.7.1" />
<PackageVersion Include="Bodu.Financial.ExchangeRates.Rba" Version="0.7.1" />
<PackageReference Include="Bodu.Financial.ExchangeRates.Rba" />
paket add Bodu.Financial.ExchangeRates.Rba --version 0.7.1
#r "nuget: Bodu.Financial.ExchangeRates.Rba, 0.7.1"
#:package Bodu.Financial.ExchangeRates.Rba@0.7.1
#addin nuget:?package=Bodu.Financial.ExchangeRates.Rba&version=0.7.1
#tool nuget:?package=Bodu.Financial.ExchangeRates.Rba&version=0.7.1
Bodu.Financial.ExchangeRates.Rba
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 Reserve Bank of Australia's published historical daily exchange-rate files.
It downloads the RBA .xls files, parses them (via
Bodu.Formats.Excel.Binary →
Bodu.IO.Compound), 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 RbaRateProvider(new RbaRateProviderOptions());
// 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("AUD", "USD", new DateOnly(2023, 1, 3));
// usd.Rate == 0.6828m
// Read a whole range at once (AUD-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("AUD", "JPY", new DateOnly(2026, 1, 1), new DateOnly(2026, 6, 12));
// Discover what pairs the loaded data supports.
foreach (RbaSeriesInfo info in provider.GetAvailablePairs())
Console.WriteLine($"{info.Pair.FromIsoCode}/{info.Pair.ToIsoCode} ({info.SeriesId})");
Behaviour
- AUD-based. RBA quotes the Australian dollar against each currency. Direct
(
AUD→X) and inverse (X→AUD) lookups are supported; cross pairs are not. - Loading. Call
PreloadAsync/LoadRangeAsyncto warm the in-memory store. A synchronous lookup that misses an unloaded era will block to download it 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); immutable historical eras are cached indefinitely and the open-ended current era refreshes on a TTL.
- Configuration.
RbaRateProviderOptionscarries working defaults and binds throughMicrosoft.Extensions.Options. The package ships its ownAddRbaExchangeRatesregistration in theBodu.Financial.ExchangeRatesnamespace.
HTTP client and lifetime
The provider is IDisposable and offers two construction styles:
new RbaRateProvider(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 RbaRateProvider(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.RbaRateProvider). 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
RbaRateProviderOptions:
| Event | Default level | Option property |
|---|---|---|
| An era download is starting | Debug |
DownloadStartingLogLevel |
| An era loaded (with its observation count) | Information |
DownloadCompletedLogLevel |
| Each individual rate observation ingested | Trace |
ObservationIngestedLogLevel |
| An era download failed (logged, then re-thrown) | Warning |
DownloadFailedLogLevel |
// Quieten the per-fetch line and turn off per-observation tracing entirely.
var options = new RbaRateProviderOptions
{
DownloadCompletedLogLevel = LogLevel.Debug,
ObservationIngestedLogLevel = LogLevel.None,
};
The default verbosity is deliberately low: at Information you see one line per era
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 era — 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)
- Bodu.Formats.Excel.Binary (>= 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)
- Bodu.Formats.Excel.Binary (>= 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.