ApiFootball 3.0.0

CSharpApiFootball

DI compatible C# API client for api-football.com supporting all documented v3 endpoints except widgets. If you find any issues or missing endpoints, please open an issue or submit a pull request.

This project is not affiliated with api-football or api-sports.

Example

var key = "your api key";
var host = Host
    .CreateDefaultBuilder(args)
    .ConfigureServices(services => services.AddApiFootball(key))
    .Build();

var serviceScope = host.Services.CreateScope();
var provider = serviceScope.ServiceProvider;

// Print Dutch Eredivisie games and final scores for the 2022 season
var fixturesClient = provider.GetRequiredService<IFixturesClient>();
var fixtures = await fixturesClient.GetFixtures(league: 88, season: 2022);

// To throw an exception in case of errors
fixtures.EnsureSuccess();

foreach (var fixture in fixtures.Response)
{
    Console.WriteLine($"{fixture.Teams.Home.Name,20}  -  {fixture.Teams.Away.Name,-20} {" ",10} {fixture.Goals.Home} - {fixture.Goals.Away}");
}

Configuration

Configure the library with the AddApiFootball options overload. The simpler AddApiFootball(apiKey, apiUrl) overload sets just the API key and base URL.

// Example, default options shown in table below
services.AddApiFootball(options =>
{
    options.ApiKey = key;
    options.ApiUrl = "https://v3.football.api-sports.io/";
    options.ThrowOnError = true; 
    options.RateLimiterOptions = ApiFootballRateLimiterOptions.ProPlan;
    options.ConfigureHttpClient = http => http.ConfigureHttpClient(client =>
        client.Timeout = TimeSpan.FromSeconds(30));
});

Rate limiter presets

RateLimiterOptions accepts one of four built-in presets. They control requests per second and minute, concurrent requests, and the maximum number of requests waiting for a permit. These rate limiters do not enforce daily quotas.

You can also create your own instance of ApiFootballRateLimiterOptions to set custom limits, this table shows the available options and their defaults.

The client-side limiter applies across the registered API-Football clients. API quota headers, when returned, are also available on each response through Quota.

Supported endpoints

Here you can find a list of all the endpoints that are currently supported and which interface to use to call them.