Tor.Fixer.Client 1.0.1

Tor.Fixer.Client

A C# client library for Fixer.io API with dependency injection support.

Installation

Install-Package Tor.Fixer.Client

Usage

Registering to .NET Core service collection

You have to register the FixerClient with the dependencies in the Program.cs file.

For the minimal registration, you have to add your Fixer.io API key to the options builder:

services.AddFixer(options =>
{
    options.WithApiKey("Your API key");
});

Options

Setting the API key:

services.AddFixer(options =>
{
    options.WithApiKey("Your Fixer.io API key");
});

If you want to implement some API key factory logic, f.e.: if you want to change your API key in runtime:

public static class SharedData
{
    public static string FixerApiKey { get; set; } = "Your Fixer.io API key";
}

services.AddFixer(options =>
{
    options.WithApiKeyFactory(() => SharedData.FixerApiKey);
});

If you use an alias accessing Fixer.io or the Fixer.io base address changes and this package is not updated yet, you can override the base address:

services.AddFixer(options =>
{
    options.WithBaseUrl("Your URL");
});

Based on your design, you can choose a http error handling mode with the following code:

services.AddFixer(options =>
{
    options.WithHttpErrorHandling(HttpErrorHandlingMode.ReturnsError);
});

There are two options (default: ReturnsError):

• ReturnsError: when the http call ends with an errorcode, the error will be in the response, there will be no exceptions
• ThrowsException: when http call ends with an errorcode, there will be an exception

Of course, you can combine these options for your needs except WithApiKey and WithApiKeyFactory.

IFixerClient usage

You can get the IFixerClient via dependency injection:

public class MyService
{
    public MyService(IFixerClient client)
    {
    }   
}

NOTE: Please note that depending on your subscription plan, certain API endpoints may or may not be available.

Response object

Every method call will return with the following FixerResponse<TResult> class:

public class FixerResponse<TResult>
{
    public bool Success { get; set; }

    public TResult Result { get; set; }

    public FixerError Error { get; set; }
}

• When the request succeed
  • Success: true
  • Error: null
  • Result: object
• When the request failed
  • Success: false
  • Error: object
  • Result: null

IFixerClient.GetSymbolsAsync method

No method parameters.

Response:

IFixerClient.GetLatestRatesAsync method

Method parameters:

Response:

IFixerClient.GetHistoricalRatesAsync method

Method parameters:

Response:

IFixerClient.ConvertAsync method

Method parameters:

Response:

IFixerClient.GetTimeSeriesAsync method

Method parameters:

Response:

IFixerClient.GetFluctuationAsync method

Method parameters:

Response: