OfxRateProvider Class

Definition

Namespace

Bodu.Financial.ExchangeRates

Assembly

Bodu.Financial.ExchangeRates.Ofx.dll

Package

Bodu.Financial.ExchangeRates.Ofx 0.7.1

Source

OfxRateProvider.cs

Serves OFX (ofx.com) exchange rates as ExchangeRate values, implementing the Bodu.Financial provider contracts over the OFX public spot-rate-history JSON REST service.

public sealed class OfxRateProvider : PairWebRateProvider<OfxSeriesInfo>, IDatedRateProvider, IRateProvider, IPairRateLoader, IHistoricalRateProvider, IDisposable

Inheritance

object

WebRateProvider

PairWebRateProvider<OfxSeriesInfo>

OfxRateProvider

Implements

IDatedRateProvider

IRateProvider

IPairRateLoader

IHistoricalRateProvider

IDisposable

Inherited Members

PairWebRateProvider<OfxSeriesInfo>.GetAvailablePairs()

PairWebRateProvider<OfxSeriesInfo>.HistoryAvailability

WebRateProvider.GetRate(string, string, RateLookupOptions)

WebRateProvider.GetRate(string, string, DateOnly, RateLookupOptions)

WebRateProvider.TryGetRate(string, string, DateOnly, RateLookupOptions, out RateLookupResult)

WebRateProvider.GetRates(string, string, DateOnly, DateOnly)

WebRateProvider.GetRateAsync(string, string, RateLookupOptions, CancellationToken)

WebRateProvider.GetRateAsync(string, string, DateOnly, RateLookupOptions, CancellationToken)

WebRateProvider.GetRatesAsync(string, string, DateOnly, DateOnly, CancellationToken)

WebRateProvider.LoadPairAsync(string, string, DateOnly, DateOnly, CancellationToken)

WebRateProvider.GetLoadedPairs()

WebRateProvider.GetLoadedBook()

WebRateProvider.GetLoadedSnapshot()

WebRateProvider.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Examples

using var ofx = new OfxRateProvider(new OfxRateProviderOptions());
await ofx.LoadPairAsync("USD", "AUD", new DateOnly(2023, 1, 1), new DateOnly(2023, 1, 31));

RateLookupResult aud = ofx.GetRate("USD", "AUD", new DateOnly(2023, 1, 3));

Remarks

The provider derives from PairWebRateProvider<TSeries>, which supplies the per-pair coverage tracking, single-flight coalescing, fetch-and-accumulate orchestration, and diagnostic logging shared by every pair-based web source; this type contributes only the OFX identity and the OFX-specific exception text. OFX serves arbitrary pairs through its spot-rate-history endpoint, so any pair of ISO codes can be requested directly. Use LoadPairAsync(string, string, DateOnly, DateOnly, CancellationToken) to warm a pair's in-memory store.

HttpClient ownership. The constructor that takes only options builds and owns an HttpClient configured with the options' UserAgent and HttpTimeout (the OFX endpoint rejects requests without a recognizable user agent), disposing it with the provider. The constructor that takes an HttpClient uses the caller-supplied client as-is, leaving its configuration and lifetime to the caller; this is the path the dependency-injection package uses.

Constructors

OfxRateProvider(OfxRateProviderOptions, ILogger?, TimeProvider?)

Initializes a new instance of the OfxRateProvider class backed by an HttpClient the provider creates and owns, configured from the supplied options.

public OfxRateProvider(OfxRateProviderOptions options, ILogger? logger = null, TimeProvider? timeProvider = null)

Parameters

options OfxRateProviderOptions

The provider options.

logger ILogger

The logger that records downloads and on-demand network fetches. null selects a no-op logger.

timeProvider TimeProvider

The time source used to resolve the current instant for the undated lookup surface. null selects System.

Exceptions

ArgumentNullException

Thrown when options is null.

ArgumentException

Thrown when options fails validation.

OfxRateProvider(HttpClient, OfxRateProviderOptions, ILogger?, TimeProvider?)

Initializes a new instance of the OfxRateProvider class backed by the OFX endpoint, queried with the caller-supplied HTTP client. The caller owns the client's configuration and lifetime.

public OfxRateProvider(HttpClient httpClient, OfxRateProviderOptions options, ILogger? logger = null, TimeProvider? timeProvider = null)

Parameters

httpClient HttpClient

The HTTP client used to issue history requests.

options OfxRateProviderOptions

The provider options.

logger ILogger

The logger that records downloads and on-demand network fetches. null selects a no-op logger.

timeProvider TimeProvider

The time source used to resolve the current instant for the undated lookup surface. null selects System.

Exceptions

ArgumentNullException

Thrown when httpClient or options is null.

ArgumentException

Thrown when options fails validation.

Fields

ProviderName

The provider identifier stamped on every rate this provider produces.

public const string ProviderName = "OFX"

Field Value

string

Properties

ProviderId

Gets the provider identifier stamped on every rate this provider produces.

protected override string ProviderId { get; }

Property Value

string

The provider identifier.

Methods

FormatRateNotFound(string, string, DateOnly)

Formats the message for the KeyNotFoundException thrown when a single-rate lookup fails. Derived types may override to use a feed-specific resource string.

protected override string FormatRateNotFound(string fromIsoCode, string toIsoCode, DateOnly date)

Parameters

fromIsoCode string

The source-currency ISO code.

toIsoCode string

The destination-currency ISO code.

date DateOnly

The requested date.

Returns

string

The exception message.

Applies to

Product	Versions
.NET	8, 10