SeriesΒΆ

thetvdb_api.api.get_series(series)

Get the series informations.

Parameters:series – the series created with set_series()
Returns:a dictionary of all the series informations provided by theTVDB.com.
Return type:dict
Raises:thetvdb_api.theTVDBError if something went wrong

The get_series() function returns a dictionary with the following keys (some are only available if you have specified a language in set_series() or with the set_language() function):

  • seriesid: an unsigned integer that the unique identifier of the series. Cannot be null.
  • id: same as :mod:`seriesid*. Cannot be null.
  • language: a two digit string indicating the language. Cannot be null.
  • SeriesName: a string containing the series name in the language you requested. Will return the English name if no translation is found in the language requested. Can be null if the name isn’t known in the requested language or English.
  • AliasNames: a pipe “|” delimited list of alias names if the series has any other names in that language. Can be null.
  • SeriesNameList: a list (a Python list) of all the names of the series (SeriesNames and AliasNames). Cannot be null.
  • banner: the relative path to the highest rated banner for this series. Can be null.
  • Overview: a string containing the overview in the language requested. Will return the English overview if no translation is available in the language requested. Can be null.
  • FirstAired: the first aired date for the series in the “YYYY-MM-DD” format. Can be null.
  • IMDB_ID: the IMDB id for the series if known. Can be null.
  • zap2it_id: the zap2it ID if known. Can be null.
  • Network: the Network name if known. Can be null.

The parameters below are only available if a language has been specified:

  • Actors: a pipe delimited string of actors in plain text. Begins and ends with a pipe even if no actors are listed. Cannot be null.
  • ActorsList: same as Actors but in Python List format. Cannot be null.
  • Airs_DayOfWeek: the full name in English for the day of the week the series airs in plain text. Can be null.
  • Airs_Time: a string indicating the time of day the series airs on its original network. Format “HH:MM AM/PM”. Can be null.
  • ContentRating: the rating given to the series based on the US rating system. Can be null or a 4-5 character string.
  • Genre: a pipe delimited list of genres in plain text. Begins and ends with a | but may also be null.
  • GenreList: same as Genre but in Python List format. Cannot be null.
  • Rating: the average rating users of theTVDB.com have rated the series out of 10, rounded to 1 decimal place. Can be null.
  • RatingCount: an unsigned integer representing the number of users who have rated the series. Can be null.
  • Runtime: an unsigned integer representing the runtime of the series in minutes. Can be null.
  • Status: a string containing either “Ended” or “Continuing”. Can be null.
  • added: a string containing the date/time the series was added to theTVDB.com in the format “YYYY-MM-DD HH:MM:SS” based on a 24 hour clock. Is null for older series.
  • addedBy: an unsigned integer. The ID of the theTVDB user who added the series to our database. Is null for older series.
  • fanart: the highest voted fanart for the requested series. Can be null.
  • lastupdated: Unix time stamp indicating the last time any changes were made to the series. Can be null.
  • posters: the highest voted poster for the requested series. Can be null.