TvdbApi

C# Api Client for the TVDB project

TVDB Project

• TVDB API
• TVDB API Github
• TVDB API Documentation

Usage

The TVDB Team recommends to maintain your own copy of their database or use a caching proxy to reduce the amount of calls being made against their API. It is entirely up to you as the developer to implement this. This lbirary provides a simple API client AS IS, without any of the recommended caching mechanism.

Configuration

The Client library relies on config records being present in either your appsettings.json or in a standalone TvdbClientConfig.json:

{
  "TvdbConfiguration": {
    "BaseUrl": "https://api4.thetvdb.com/v4",
    /* This API Key comes from the TVDB Example and obviously needs to be replaced in production */
    "ApiKey": "580c9239-d2f8-4460-a22e-6831900a97a3",
    "Pin": "IPQZOCMN"
  }
}

Make sure to replace the API Key in the example with your own API Key in TVDBs API Key Dashboard.

DI Registration

Register TVDB Client with your DI of choice:

        var config = builder.Configuration.AddTvdbClient().Build();
        builder.Services.AddTvdbClient(config);

Using the Clients

        var client = serviceProvider.GetRequiredService<ITvdbClient>();
        var series = await client.GetSeriesAsync(121361);
        Console.WriteLine(series.Data.SeriesName);

Versioning

I try my best to align the version of this library to the latest TVDB version on their Github repository to make it easy to see which version this client is compatible with.