BannersΒΆ

thetvdb_api.api.get_banners(series)

Get all the banners of the series.

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

The get_banners() function returns a dictionary with one sub-dictionary for each banner of the series. These sub-dictionaries have the following keys:

  • BannerPath: the location of the artwork.
  • ThumbnailPath: used exactly the same way as BannerPath, only shows if BannerType is fanart.
  • VignettePath: used exactly the same way as BannerPath, only shows if BannerType is fanart.
  • BannerType: this can be poster, fanart, series or season.
  • BannerType2: for series banners it can be text, graphical, or blank. For season banners it can be season or seasonwide. For fanart it can be 1280x720 or 1920x1080. For poster it will always be 680x1000. Blank banners will leave the title and show logo off the banner. Text banners will show the series name as plain text in an Arial font. Graphical banners will show the series name in the show’s official font or will display the actual logo for the show. Season banners are the standard DVD cover format while wide season banners will be the same dimensions as the series banners.
  • Language: some banners list the series name in a foreign language. The language abbreviation will be listed here.
  • Season: if the banner is for a specific season, that season number will be listed here.
  • Rating: returns either null or a decimal with four decimal places. The rating the banner currently has on the site.
  • RatingCount: always returns an unsigned integer. Number of people who have rated the image.
  • SeriesName: this can be true or false. Only shows if BannerType is fanart. Indicates if the seriesname is included in the image or not.
  • Colors: returns either null or three RGB colors in decimal format and pipe delimited. These are colors the artist picked that go well with the image. In order they are Light Accent Color, Dark Accent Color and Neutral Midtone Color. It’s meant to be used if you want to write something over the image, it gives you a good idea of what colors may work and show up well. Only shows if BannerType is fanart.