Reload Objects

class TMDbReload(tmdb, data, load=False, partial=False)[source]

Bases: TMDbObj

Base object for objects that Reload.

reload(partial: bool | str | None = False)[source]

Reloads the object.

Parameters:

partial (Optional[Union[bool, str]]) – leave False for a full load otherwise specify the endpoints you want added.

class Account(tmdb)[source]

Bases: TMDbReload

Represents a single User Account.

Variables:

  • avatar_hash (str) – Avatar Hash Value.

  • avatar_path (str) – Avatar Path.

  • avatar_url (str) – Avatar Full URL.

  • country (Country) – Country object for the ISO 3166-1 Country Code.

  • id (str) – v3 User Account ID.

  • include_adult (bool) – Default include adult items in search results

  • iso_3166_1 (str) – Default ISO 3166-1 Alpha-2 Country Code of the User Account.

  • iso_639_1 (str) – Default ISO 639-1 Language Code of the User Account.

  • language (Language) – Language object for the ISO 639-1 Language Code.

  • name (str) – User Account Name.

  • username (str) – User Account Username.

created_lists(v3: bool = False)[source]

Alias for created_lists()

favorite_movies(sort_by: str = None, v3: bool = False)[source]

Alias for favorite_movies()

favorite_tv_shows(sort_by: str | None = None, v3: bool = False)[source]

Alias for favorite_tv_shows()

movie_recommendations(sort_by: str | None = None)[source]

Alias for movie_recommendations()

movie_watchlist(sort_by: str | None = None, v3: bool = False)[source]

Alias for movie_watchlist()

rated_episodes(sort_by: str | None = None)[source]

Alias for rated_episodes()

rated_movies(sort_by: str | None = None, v3: bool = False)[source]

Alias for rated_movies()

rated_tv_shows(sort_by: str | None = None, v3: bool = False)[source]

Alias for rated_tv_shows()

tv_show_recommendations(sort_by: str | None = None)[source]

Alias for tv_show_recommendations()

tv_show_watchlist(sort_by: str | None = None, v3: bool = False)[source]

Alias for tv_show_watchlist()

class Collection(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Collection.

Variables:

  • backdrop_path (str) – Backdrop Path.

  • backdrop_url (str) – Backdrop Full URL.

  • backdrops (List[Backdrop]) – List of other Backdrops for the Collection.

  • id (int) – Collection ID.

  • movies (List[Movie]) – Movies within the Collection.

  • name (str) – Collection Name.

  • overview (str) – Collection Overview.

  • poster_path (str) – Poster Path.

  • poster_url (str) – Poster Full URL.

  • posters (List[Poster]) – List of other Posters for the Collection.

  • translations (List[Translation]) – List of Translations for the Collection.

class Company(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Company.

Variables:

  • alternative_names (List[AlternativeName]) – Company Alternative Names.

  • description (str) – Company Description.

  • headquarters (str) – Company Headquarters.

  • homepage (str) – Company Homepage.

  • id (int) – Company ID.

  • logo_path (str) – Logo Path.

  • logo_url (str) – Logo Full URL.

  • logos (List[Logo]) – List of other Logos for the Company.

  • name (str) – Company Name.

  • movies (DiscoverMovies) – Pagination Object of Company Movies.

  • origin_country (str) – Company Origin Country.

  • parent_company (Company) – Parent Company.

  • tv_shows (DiscoverTVShows) – Pagination Object of Company TV Shows.

class Configuration(tmdb, partial=False)[source]

Bases: TMDbReload

Represents TMDb’s Configuration.

Variables:

  • backdrop_sizes (List[str]) – Backdrop sizes.

  • base_image_url (str) – Base Image URL.

  • change_keys (List[str]) – Change Keys.

  • countries (List[Country]) – Countries in TMDb.

  • departments (List[Department]) – Departments in TMDb.

  • languages (List[Language]) – Languages in TMDb.

  • logo_sizes (List[str]) – Logo Sizes.

  • poster_sizes (List[str]) – Poster Sizes.

  • primary_translations (List[str]) – Primary Translations in TMDb.

  • profile_sizes (List[str]) – Profile Sizes.

  • secure_base_image_url (str) – Secure Base Image URL.

  • still_sizes (List[str]) – Still Sizes

  • timezones (List[str]) – Timezones in TMDb.

class Credit(tmdb, data, credit_type=None, media_type=None, load=False)[source]

Bases: TMDbReload

Represents a single Credit.

Variables:

  • adult (bool) – Is the Actor an adult actor.

  • character (str) – Character Name.

  • credit_type (str) – Credit Type.

  • department (str) – Credit Department

  • episode_count (int) – Number of Episodes the Actor appeared in.

  • episodes (List[Episode]) – Episodes of credit. Only exists when media_type == “tv”.

  • gender (int) – Actor’s Gender. (1: Women, 2: Men)

  • id (str) – The Credit ID.

  • job (str) – Job in Department.

  • known_for (List[Union[Movie, TVShow]])

  • known_for_department (str) – Department Actor is known for.

  • media_type (str) – Media Type of the Credit.

  • movie (Movie) – Movie of credit. Only exists when media_type == “movie” .

  • name (str) – Actor Name.

  • order (int) – Order of the Credits.

  • original_name (str) – Actor Original Name.

  • person_id (int) – Person ID of the Actor.

  • popularity (float) – Popularity of the Credit.

  • profile_path (str) – Profile Path.

  • profile_url (str) – Profile Full URL.

  • seasons (List[Season]) – Season of credit. Only exists when media_type == “tv”.

  • tv_show (TVShow) – TV Show of credit. Only exists when media_type == “tv”.

class Episode(tmdb, data, tv_id=None, load=False, partial=False)[source]

Bases: TMDbReload, Rate

Represents a single Episode.

Variables:

  • air_date (datetime) – Episode Air Date.

  • cast (List[Credit]) – List of Episode Cast Credits.

  • crew (List[Credit]) – List of Episode Crew Credits.

  • episode_number (int) – Episode in Season Number.

  • freebase_id (str) – Freebase ID for the Episode.

  • freebase_mid (str) – Freebase MID for the Episode.

  • guest_stars (List[Credit]) – List of Episode Guest Stars Credits.

  • id (int) – Episode ID.

  • imdb_id (str) – Episode IMDb ID.

  • name (str) – Episode Name.

  • order (int) – Episode Order in Group.

  • overview (str) – Episode Overview.

  • production_code (str) – Episode Production Code.

  • rated (float) – Either your TMDb Rating for the Episode or None if there is no rating.

  • season_number (int) – Season the Episode is in.

  • still_path (str) – Still Path.

  • still_url (str) – Still Full URL.

  • stills (List[Still]) – List of other Stills for the Episode.

  • title (str) – alias of name.

  • translations (List[Translation]) – List of Translations for the Episode.

  • tv_id (int) – TMDb TV Show ID the contains the Episode.

  • tvdb_id (int) – TVDB ID of the Episode.

  • tvrage_id (int) – TVRage ID of the Episode.

  • videos (List[Video]) – List of Videos associated with the Episode.

  • vote_average (float) – Vote Average for the Episode.

  • vote_count (int) – Number of Votes for the Episode.

delete_rating()

Delete a Rating (Authentication Required)

rate(rating: float)

Add a Rating (Authentication Required)

Parameters:

rating (float) – Rating to use.

reload(partial: bool | str | None = False)

Reloads the object.

Parameters:

partial (Optional[Union[bool, str]]) – leave False for a full load otherwise specify the endpoints you want added.

class EpisodeGroup(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Episode Group.

Variables:

  • description (str) – Episode Group Description.

  • episode_count (int) – Episode Group Episode Count.

  • group_count (int) – Number of Groups in the Episode Group.

  • groups (List[Group]) – Groups in the Episode Group.

  • id (str) – Episode Group ID.

  • name (str) – Episode Group Name.

  • network (Network) – Episode Group Network.

  • type (int) – Episode Group Type.

class Keyword(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Keyword.

Variables:

  • id (int) – Keyword ID.

  • name (str) – Keyword Name.

  • movies (DiscoverMovies) – Keyword Movies.

  • tv_shows (DiscoverTVShows) – Keyword TV Shows.

class Movie(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload, Favorite, Rate, Watchlist

Represents a single Episode.

Variables:

  • adult (bool) – Is the Movie an adult movie.

  • alternative_titles (List[AlternativeTitle]) – Movie Alternative Titles.

  • backdrop_path (str) – Backdrop Path.

  • backdrop_url (str) – Backdrop Full URL.

  • backdrops (List[Still]) – List of other Backdrops for the Movie.

  • budget (int) – Movie Budget.

  • cast (List[Credit]) – List of Movie Cast Credits.

  • collection (Collection) – Movie’s Collection.

  • companies (List[Company]) – List of Production Companies for the Movie.

  • countries (List[Country]) – List of Production Countries for the Movie.

  • crew (List[Credit]) – List of Movie Crew Credits.

  • facebook_id (str) – Facebook ID for the Movie.

  • favorite (bool) – If this Movie has been marked as a favorite. (Authentication Required)

  • genres (List[Genre]) – List of Genres for the Movie.

  • homepage (str) – Homepage for the Movie.

  • id (str) – Movie ID.

  • imdb_id (str) – IMDb ID for the Movie.

  • instagram_id (str) – Instagram ID for the Movie.

  • keywords (List[Keyword]) – List of Keywords for the Movie.

  • spoken_languages (List[Language]) – List of Spoken Languages for the Movie.

  • lists (MovieLists) – Pagination Object of Lists containing the Movie.

  • logos (List[Logo]) – List of other Logos for the Movie.

  • name (str) – alias of title.

  • original_language (Language) – Original Language of the Movie.

  • original_title (str) – Movie’s Original Title.

  • overview (str) – Movie Overview.

  • popularity (float) – Movie’s Popularity.

  • poster_path (str) – Poster Path.

  • poster_url (str) – Poster Full URL.

  • posters (List[Poster]) – List of other Posters for the Movie.

  • rated (float) – Your rating for this Movie or None if you have not rated it. (Authentication Required)

  • recommendations (RecommendedMovies) – Pagination Object of Recommended Movies based on this Movie.

  • release_date (datetime) – Movie’s Primary Release Date.

  • release_dates (Dict[str, List[ReleaseDate]]) – Dictionary of Release Dates where the keys are the ISO 3166-1 Alpha-2 Country Codes.

  • revenue (int) – Movie’s Revenue.

  • (class (similar) – ~tmdbapis.objs.pagination.MovieReviews): Pagination Object of Movie Reviews for this Movie.

  • runtime (int)

  • (class – ~tmdbapis.objs.pagination.SimilarMovies): Pagination Object of Similar Movie to this Movie.

  • status (str) – Movie’s Status.

  • tagline (str) – Movie’s Tagline.

  • title (str) – Movie’s Title.

  • trailers (List[Trailer]) – List of Trailers for the Movie.

  • translations (List[Translation]) – List of Translations for the Movie.

  • twitter_id (str) – Twitter ID for the Movie.

  • video (bool) – Unsure when this is true.

  • videos (List[Video]) – List of Videos associated with the Movie.

  • vote_average (float) – Vote Average for the Movie.

  • vote_count (int) – Number of Votes for the Movie.

  • watch_providers (Dict[str, CountryWatchProviders]) – Dictionary of Watch Providers where the keys are the ISO 3166-1 Alpha-2 Country Codes.

  • watchlist (bool) – If this Movie has been added to your watchlist. (Authentication Required)

add_to_watchlist()

Add to your Watchlist (Authentication Required)

delete_rating()

Delete a Rating (Authentication Required)

mark_as_favorite()

Mark as a Favorite (Authentication Required)

rate(rating: float)

Add a Rating (Authentication Required)

Parameters:

rating (float) – Rating to use.

reload(partial: bool | str | None = False)

Reloads the object.

Parameters:

partial (Optional[Union[bool, str]]) – leave False for a full load otherwise specify the endpoints you want added.

remove_as_favorite()

Remove as a Favorite (Authentication Required)

remove_from_watchlist()

Remove from your Watchlist (Authentication Required)

class Network(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Network.

Variables:

  • alternative_names (List[AlternativeName]) – Network Alternative Names.

  • country (Country) – Network Country.

  • headquarters (str) – Network Headquarters.

  • homepage (str) – Network Homepage.

  • id (int) – Network ID.

  • logo_path (str) – Logo Path.

  • logo_url (str) – Logo Full URL.

  • logos (List[Logo]) – List of other Logos for the Network.

  • name (str) – Network Name.

  • tv_shows (DiscoverTVShows) – Network TV Shows.

class Person(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Person.

Variables:

  • adult (bool) – Is the Person an adult actor.

  • also_known_as (List[str]) – Name’s this Person is also known as.

  • biography (str) – Person’s Biography.

  • birthday (datetime) – Person’s Birthday.

  • deathday (datetime) – Person’s Deathday.

  • facebook_id (str) – Facebook ID for the Person.

  • freebase_id (str) – Freebase ID for the Person.

  • freebase_mid (str) – Freebase MID for the Person.

  • gender (int) – Person’s Gender. (1: Women, 2: Men)

  • homepage (str) – Homepage for the Person.

  • id (str) – Person ID.

  • imdb_id (str) – IMDb ID for the Person.

  • instagram_id (str) – Instagram ID for the Person.

  • known_for_department (str) – Department the Person is best known for.

  • name (str) – Person’s Name.

  • place_of_birth (str) – Person’s Place of Birth.

  • popularity (float) – Person’s Popularity.

  • profile_path (str) – Profile Path.

  • profile_url (str) – Profile Full URL.

  • profiles (List[Profile]) – List of other Profiles for the Person.

  • movie_cast (List[Credit]) – List of Movie Cast Credits for the Person.

  • movie_crew (List[Credit]) – List of Movie Crew Credits for the Person.

  • (class (tagged) – ~tmdbapis.objs.pagination.TaggedImages): Pagination Object of Tagged Images of this Person.

  • translations (List[Translation]) – List of Translations for the Person.

  • tv_cast (List[Credit]) – List of TV Cast Credits for the Person.

  • tv_crew (List[Credit]) – List of TV Crew Credits for the Person.

  • tvrage_id (str) – TVRage ID for the Person.

  • twitter_id (str) – Twitter ID for the Person.

class Review(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Review.

Variables:

  • author (str) – Review Author.

  • avatar_path (str) – Review Author Avatar Path.

  • avatar_url (str) – Review Author Avatar Full URL.

  • content (str) – Review content.

  • created_at (datetime) – Date Review was Created.

  • id (str) – Review ID.

  • iso_639_1 (str) – Default ISO 639-1 Language Code of the Review.

  • language (Language) – Language object for the ISO 639-1 Language Code.

  • media_id (int) – Media ID of the Review.

  • media_title (str) – Media Title of the Review.

  • media_type (str) – Media Type of the Media ID.

  • rating (float) – Review Rating.

  • updated_at (datetime) – Date Review was Updated.

  • url (str) – Review URL.

  • username (str) – Review Author Username.

class Season(tmdb, data, tv_id, load=False, partial=False)[source]

Bases: TMDbReload

Represents a single Season.

Variables:

  • aggregate_cast (List[Credit]) – List of Season Aggregate Crew Credits.

  • aggregate_crew (List[Credit]) – List of Season Aggregate Crew Credits.

  • air_date (datetime) – Season Air Date.

  • cast (List[Credit]) – List of Season Cast Credits.

  • crew (List[Credit]) – List of Season Crew Credits.

  • episodes (List[Episode]) – List of Episodes in the Season.

  • freebase_id (str) – Freebase ID for the Season.

  • freebase_mid (str) – Freebase MID for the Season.

  • id (int) – Season ID.

  • name (str) – Season Name.

  • poster_path (str) – Poster Path.

  • poster_url (str) – Poster Full URL.

  • posters (List[Poster]) – List of other Posters for the Season.

  • overview (str) – Season Overview.

  • season_number (int) – Season Number.

  • title (str) – alias of name.

  • translations (List[Translation]) – List of Translations for the Season.

  • tv_id (int) – TMDb TV Show ID the contains the Season.

  • tvdb_id (int) – TVDB ID of the Season.

  • tvrage_id (int) – TV Rage ID of the Season.

  • videos (List[Video]) – List of Videos associated with the Season.

  • vote_average (float) – Vote Average for the TV Season.

class TVShow(tmdb, data, load=False, partial=False)[source]

Bases: TMDbReload, Favorite, Rate, Watchlist

Represents a single TV Show.

Variables:

  • aggregate_cast (List[Credit]) – List of Aggregate Crew Credits.

  • aggregate_crew (List[Credit]) – List of Aggregate Crew Credits.

  • alternative_titles (List[AlternativeTitle]) – TV Show Alternative Titles.

  • backdrop_path (str) – Backdrop Path.

  • backdrop_url (str) – Backdrop Full URL.

  • backdrops (List[Still]) – List of other Backdrops for the TV Show.

  • cast (List[Credit]) – List of TV Show Cast Credits.

  • companies (List[Company]) – List of Production Companies for the TV Show.

  • content_ratings (Dict[str, str]) – Dictionary of Content Ratings where the keys are the ISO 3166-1 Alpha-2 Country Codes.

  • countries (List[Country]) – List of Production Countries for the TV Show.

  • created_by (List[Credit]) – List of Credits of who Created the TV Show.

  • crew (List[Credit]) – List of TV Show Crew Credits.

  • episode_groups (List[EpisodeGroup]) – List of TV Show Episode Groups.

  • episode_run_time (List[int]) – List of Episode Run Times in this TV Show.

  • facebook_id (str) – Facebook ID for the TV Show.

  • favorite (bool) – If this TV Show has been marked as a favorite. (Authentication Required)

  • first_air_date (datetime) – Date TV Show was First Aired.

  • freebase_id (str) – Freebase ID for the TV Show.

  • freebase_mid (str) – Freebase MID for the TV Show.

  • genres (List[Genre]) – List of Genres for the TV Show.

  • homepage (str) – Homepage for the TV Show.

  • id (str) – TV Show ID.

  • imdb_id (str) – IMDb ID for the TV Show.

  • in_production (bool) – If the TV Show is in Production or not.

  • instagram_id (str) – Instagram ID for the TV Show.

  • keywords (List[Keyword]) – List of Keywords for the TV Show.

  • languages (List[Language]) – List of Languages for the TV Show.

  • last_air_date (datetime) – Date TV Show was Last Aired.

  • last_episode_to_air (Episode) – Last Episode to Air.

  • logos (List[Logo]) – List of other Logos for the TV Show.

  • name (str) – TV Show’s Name.

  • networks (List[Network]) – List of Networks for the TV Show.

  • next_episode_to_air (Episode) – Next Episode to Air.

  • number_of_episodes (int) – Number of Episodes in the TV Show.

  • number_of_seasons (int) – Number of Seasons in the TV Show.

  • origin_countries (List[Country]) – Origin Countries of the TV Show.

  • original_language (Language) – Original Language of the TV Show.

  • original_name (str) – TV Show’s Original Name.

  • overview (str) – TV Show Overview.

  • popularity (float) – TV Show’s Popularity.

  • poster_path (str) – Poster Path.

  • poster_url (str) – Poster Full URL.

  • posters (List[Poster]) – List of other Posters for the TV Show.

  • rated (float) – Your rating for this TV Show or None if you have not rated it. (Authentication Required)

  • recommendations (RecommendedTVShows) – Pagination Object of Recommended TV Show based on this TV Show.

  • seasons (List[Season]) – List of Seasons in the TV Show.

  • (class (similar) – ~tmdbapis.objs.pagination.SimilarTVShows): Pagination Object of Similar TV Show to this TV Show.

  • spoken_languages (List[Language]) – List of Spoken Languages for the TV Show.

  • status (str) – TV Show’s Status.

  • tagline (str) – TV Show’s Tagline.

  • title (str) – alias of name.

  • translations (List[Translation]) – List of Translations for the TV Show.

  • tvdb_id (int) – TVDB ID of the TV Show.

  • tvrage_id (int) – TV Rage ID of the TV Show.

  • twitter_id (str) – Twitter ID for the TV Show.

  • type (str) – Type of TV Show.

  • videos (List[Video]) – List of Videos associated with the TV Show.

  • vote_average (float) – Vote Average for the TV Show.

  • vote_count (int) – Number of Votes for the TV Show.

  • watch_providers (Dict[str, CountryWatchProviders]) – Dictionary of Watch Providers where the keys are the ISO 3166-1 Alpha-2 Country Codes.

  • watchlist (bool) – If this TV Show has been added to your watchlist. (Authentication Required)

add_to_watchlist()

Add to your Watchlist (Authentication Required)

delete_rating()

Delete a Rating (Authentication Required)

mark_as_favorite()

Mark as a Favorite (Authentication Required)

rate(rating: float)

Add a Rating (Authentication Required)

Parameters:

rating (float) – Rating to use.

reload(partial: bool | str | None = False)

Reloads the object.

Parameters:

partial (Optional[Union[bool, str]]) – leave False for a full load otherwise specify the endpoints you want added.

remove_as_favorite()

Remove as a Favorite (Authentication Required)

remove_from_watchlist()

Remove from your Watchlist (Authentication Required)