Install-Package TvDbSharperor with the NuGet UI in Visual Studio
There is one client you need to know about:
var client = new TvDbClient();or
ITvDbClient client = new TvDbClient();Before you do anything else you need to authenticate yourself.
- You will need an account on https://thetvdb.com/
- Then you will need to register an API key here: https://thetvdb.com/?tab=apiregister
- Then you can see all of the required information on your account page here: https://thetvdb.com/?tab=userinfo
- Note: The "Account Identifier" field holds the UserKey.
Then you can use the client like this:
await client.Authentication.AuthenticateAsync("ApiKey", "Username", "UserKey");The session expires after 24 hours, but you can refresh that period by calling RefreshTokenAsync
await client.Authentication.RefreshTokenAsync();Let's say that you need to get information about a specific series. Doctor Who. You can do it like this:
var response = await client.Series.GetAsync(78804);
Console.WriteLine(response.Data.SeriesName); //Doctor Who (2005)
Console.WriteLine(response.Data.Network); //BBC One
Console.WriteLine(response.Data.ImdbId); //tt0436992If you want to get the episodes of a series... here the REST API shows its shortcomings. You can't do that on one line. You have to do multiple calls because it's paginated at 100 per page.
The code looks something like this:
const int SeriesId = 78804;
var tasks = new List<Task<TvDbResponse<BasicEpisode[]>>>();
var firstResponse = await client.Series.GetEpisodesAsync(SeriesId, 1);
for (int i = 2; i <= firstResponse.Links.Last; i++)
{
tasks.Add(client.Series.GetEpisodesAsync(SeriesId, i));
}
var results = await Task.WhenAll(tasks);
var episodes = firstResponse.Data.Concat(results.SelectMany(x => x.Data));
Console.WriteLine(episodes.Count()); //263To get all of the actors for a giver series, you can do this:
var response = await client.Series.GetActorsAsync(78804);
var theBestDoctor = response.Data.First();
Console.WriteLine(theBestDoctor.Name); //David Tennant
Console.WriteLine(theBestDoctor.Role); //10 (Tenth Doctor)If you want to search for a series you have a few options. You can search by name, imdb ID or zap2it ID
Here is an example imdb search:
var response = await client.Search.SearchSeriesByImdbIdAsync("tt0436992");
var result = response.Data.First(); // We know there is only one
Console.WriteLine(result.SeriesName); //Doctor Who (2005)
Console.WriteLine(result.Network); //BBC One
Console.WriteLine(result.Id); //78804and now that we know the series ID we can to other things with it.
If you want to get all of the series that have been updated in a time interval you can do it like this:
var response = await client.Updates.GetAsync(new DateTime(2016, 10, 1), new DateTime(2016, 10, 5));
Update[] updates = response.Data;
var update = updates.First();
Console.WriteLine(update.Id); //76264
Console.WriteLine(update.LastUpdated.ToDateTime().ToString(CultureInfo.InvariantCulture)); //10/01/2016 00:02:21If the interval is wider that 7 days it will be reduced to 7 days.
You can get all available languages like that:
var response = await client.Languages.GetAllAsync();
Language[] languages = response.Data;If you want to get details for a specific language, you can do it like that:
var response = await client.Languages.GetAsync(14);
Console.WriteLine(response.Data.EnglishName); //German
Console.WriteLine(response.Data.Abbreviation); //deIf you want to change the language that the client is working with, you can do it using the language abbreviation like this:
client.AcceptedLanguage = "de";This client supports all of the functionality of the REST API and I can't list every single method here. You can explore that yourself or read the REST API documentation provided by thetvdb.com here https://api.thetvdb.com/swagger
You will find equvalent method for every single route there.