Struct Client 

pub struct Client { /* private fields */ }

the entry point; clone freely, it shares one connection pool

Implementations

impl Client

pub fn with_read_token(read_access_token: impl Into<String>) -> Self

authenticate with a v4 read access token

pub fn with_api_key(api_key: impl Into<String>) -> Self

authenticate with a v3 api key

pub fn v4(&self, access_token: &AccessToken) -> V4

Available on crate feature v4 only.

the v4 api, authenticated with a user access token from the v4 auth flow — a different credential than the read token, so mixing them is a compile error

pub fn with_http_client(self, http: Client) -> Self

bring your own reqwest client (proxies, timeouts, …)

pub fn with_base_url(self, url: impl Into<String>) -> Self

point at another host (a proxy, or a mock in tests)

impl Client

pub fn account(&self, session_id: SessionId) -> AccountRequest

the account the session belongs to

impl Client

pub fn favorite_movies( &self, account_id: u64, session_id: SessionId, ) -> FavoriteMoviesRequest

the account’s favorite movies

impl Client

pub fn favorite_tv( &self, account_id: u64, session_id: SessionId, ) -> FavoriteTvRequest

the account’s favorite series

impl Client

pub fn mark_favorite( &self, account_id: u64, session_id: SessionId, media_type: MediaType, media_id: u64, favorite: bool, ) -> MarkFavoriteRequest

mark or unmark a favorite

impl Client

pub fn rated_movies( &self, account_id: u64, session_id: SessionId, ) -> RatedMoviesRequest

the account’s rated movies

impl Client

pub fn rated_tv(&self, account_id: u64, session_id: SessionId) -> RatedTvRequest

the account’s rated series

impl Client

pub fn rated_episodes( &self, account_id: u64, session_id: SessionId, ) -> RatedEpisodesRequest

the account’s rated episodes

impl Client

pub fn watchlist_movies( &self, account_id: u64, session_id: SessionId, ) -> WatchlistMoviesRequest

the account’s movie watchlist

impl Client

pub fn watchlist_tv( &self, account_id: u64, session_id: SessionId, ) -> WatchlistTvRequest

the account’s series watchlist

impl Client

pub fn set_watchlist( &self, account_id: u64, session_id: SessionId, media_type: MediaType, media_id: u64, watchlist: bool, ) -> SetWatchlistRequest

add or remove a watchlist entry

impl Client

pub fn account_lists( &self, account_id: u64, session_id: SessionId, ) -> AccountListsRequest

the account’s lists

impl Client

pub fn account_watch_providers( &self, session_id: SessionId, ) -> AccountWatchProvidersRequest

the account’s watch providers preferences

impl Client

pub fn validate_key(&self) -> ValidateKeyRequest

validate the credentials: the key is good when this answers

impl Client

pub fn request_token(&self) -> RequestTokenRequest

step 1 of the v3 auth flow: a request token for the user to approve

impl Client

pub fn validate_with_login( &self, username: &str, password: &str, request_token: &str, ) -> ValidateWithLoginRequest

step 2, app-approved variant: validate with the user’s credentials

impl Client

pub fn create_session(&self, request_token: &str) -> CreateSessionRequest

step 3: exchange an approved request token for a session

impl Client

pub fn create_guest_session(&self) -> CreateGuestSessionRequest

a guest session, for rating without an account

impl Client

pub fn delete_session(&self, session_id: SessionId) -> DeleteSessionRequest

end a session

impl Client

pub fn movie_certifications(&self) -> MovieCertificationsRequest

the movie certifications by country

impl Client

pub fn tv_certifications(&self) -> TvCertificationsRequest

the series certifications by country

impl Client

pub fn collection(&self, id: u64) -> CollectionDetailsRequest

a collection and its parts

impl Client

pub fn collection_images(&self, id: u64) -> CollectionImagesRequest

a collection’s images

impl Client

pub fn collection_translations(&self, id: u64) -> CollectionTranslationsRequest

a collection’s translations

impl Client

pub fn company(&self, id: u64) -> CompanyRequest

a company’s details

impl Client

pub fn company_alternative_names( &self, id: u64, ) -> CompanyAlternativeNamesRequest

a company’s alternative names

impl Client

pub fn company_images(&self, id: u64) -> CompanyImagesRequest

a company’s logos

impl Client

pub fn configuration(&self) -> ConfigurationRequest

the API-wide configuration

impl Client

pub fn countries(&self) -> CountriesRequest

the countries TMDB knows

impl Client

pub fn jobs(&self) -> JobsRequest

the departments and jobs credits use

impl Client

pub fn languages(&self) -> LanguagesRequest

the languages TMDB knows

impl Client

pub fn primary_translations(&self) -> PrimaryTranslationsRequest

the languages translations can be requested in

impl Client

pub fn timezones(&self) -> TimezonesRequest

the timezones TMDB knows, by country

impl Client

pub fn credit(&self, id: &str) -> CreditRequest

a credit by its credit id

impl Client

pub fn discover_movies(&self) -> DiscoverMoviesRequest

discover movies by filters: genres, dates, ratings, providers, …

impl Client

pub fn discover_tv(&self) -> DiscoverTvRequest

discover series by filters: genres, dates, ratings, networks, …

impl Client

pub fn find( &self, external_id: &str, external_source: ExternalSource, ) -> FindRequest

find TMDB entries by an external id (imdb, tvdb, wikidata, …)

impl Client

pub fn movie_genres(&self) -> MovieGenresRequest

the movie genre list

impl Client

pub fn tv_genres(&self) -> TvGenresRequest

the series genre list

impl Client

pub fn keyword(&self, id: u64) -> KeywordRequest

a keyword by id

impl Client

pub fn keyword_movies(&self, id: u64) -> KeywordMoviesRequest

👎Deprecated:

TMDB deprecated this endpoint; use discover_movies().with_keywords(…) instead

the movies tagged with a keyword

impl Client

pub fn list(&self, id: u64, session_id: SessionId) -> ListRequest

a list and its items

impl Client

pub fn list_item_status( &self, id: u64, session_id: SessionId, ) -> ListItemStatusRequest

whether a title is on a list

impl Client

pub fn create_list( &self, session_id: SessionId, name: &str, description: &str, language: &str, ) -> CreateListRequest

create a list

impl Client

pub fn list_add_item( &self, id: u64, session_id: SessionId, media_id: u64, ) -> ListAddItemRequest

add a title to a list

impl Client

pub fn list_remove_item( &self, id: u64, session_id: SessionId, media_id: u64, ) -> ListRemoveItemRequest

remove a title from a list

impl Client

pub fn list_clear( &self, id: u64, session_id: SessionId, confirm: bool, ) -> ListClearRequest

remove every title from a list

impl Client

pub fn list_delete(&self, id: u64, session_id: SessionId) -> ListDeleteRequest

delete a list

impl Client

pub fn movie(&self, id: u64) -> MovieDetailsRequest

the primary details of a movie

impl Client

pub fn movie_account_states(&self, id: u64) -> MovieAccountStatesRequest

a movie’s account states (favorite, rated, watchlist)

impl Client

pub fn movie_alternative_titles(&self, id: u64) -> MovieAlternativeTitlesRequest

a movie’s alternative titles

impl Client

pub fn movie_changes_by_id(&self, id: u64) -> MovieChangesByIdRequest

a movie’s recent changes

impl Client

pub fn movie_credits(&self, id: u64) -> MovieCreditsRequest

a movie’s credits

impl Client

pub fn movie_images(&self, id: u64) -> MovieImagesRequest

a movie’s images

impl Client

pub fn movie_lists(&self, id: u64) -> MovieListsRequest

the lists a movie appears in

impl Client

pub fn movie_similar(&self, id: u64) -> MovieSimilarRequest

movies similar to a movie, from TMDB’s collaborative filtering

impl Client

pub fn movie_recommendations(&self, id: u64) -> MovieRecommendationsRequest

a movie’s recommendations

impl Client

pub fn movie_release_dates(&self, id: u64) -> MovieReleaseDatesRequest

a movie’s release dates by country

impl Client

pub fn movie_reviews(&self, id: u64) -> MovieReviewsRequest

a movie’s reviews

impl Client

pub fn movie_translations(&self, id: u64) -> MovieTranslationsRequest

a movie’s translations

impl Client

pub fn movie_videos(&self, id: u64) -> MovieVideosRequest

a movie’s videos (trailers, teasers, …)

impl Client

pub fn movie_watch_providers(&self, id: u64) -> MovieWatchProvidersRequest

where a movie can be streamed, rented or bought, by country

impl Client

pub fn rate_movie(&self, id: u64, value: f64) -> RateMovieRequest

rate a movie; pass a session or guest session

impl Client

pub fn unrate_movie(&self, id: u64) -> UnrateMovieRequest

delete a movie rating

impl Client

pub fn movie_changes(&self) -> MovieChangesRequest

the current movie ids, paged by insertion order

impl Client

pub fn movie_latest(&self) -> MovieLatestRequest

the newest movie

impl Client

pub fn movie_now_playing(&self) -> MovieNowPlayingRequest

movies currently in theatres

impl Client

pub fn movie_popular(&self) -> MoviePopularRequest

movies ordered by popularity

impl Client

pub fn movie_top_rated(&self) -> MovieTopRatedRequest

movies ordered by rating

impl Client

pub fn movie_upcoming(&self) -> MovieUpcomingRequest

upcoming movies

impl Client

pub fn movie_keywords(&self, id: u64) -> MovieKeywordsRequest

a movie’s keywords, without the details round-trip

impl Client

pub fn movie_external_ids(&self, id: u64) -> MovieExternalIdsRequest

a movie’s ids on other databases

impl Client

pub fn network(&self, id: u64) -> NetworkRequest

a network’s details

impl Client

pub fn network_alternative_names( &self, id: u64, ) -> NetworkAlternativeNamesRequest

a network’s alternative names

impl Client

pub fn network_images(&self, id: u64) -> NetworkImagesRequest

a network’s logos

impl Client

pub fn person(&self, id: u64) -> PersonDetailsRequest

the primary details of a person

impl Client

pub fn person_latest(&self) -> PersonLatestRequest

the newest person

impl Client

pub fn person_popular(&self) -> PersonPopularRequest

people ordered by popularity

impl Client

pub fn person_changes(&self, id: u64) -> PersonChangesRequest

a person’s recent changes

impl Client

pub fn person_combined_credits(&self, id: u64) -> PersonCombinedCreditsRequest

a person’s combined movie and series credits

impl Client

pub fn person_movie_credits(&self, id: u64) -> PersonMovieCreditsRequest

a person’s movie credits

impl Client

pub fn person_tv_credits(&self, id: u64) -> PersonTvCreditsRequest

a person’s series credits

impl Client

pub fn person_external_ids(&self, id: u64) -> PersonExternalIdsRequest

a person’s ids on other databases

impl Client

pub fn person_images(&self, id: u64) -> PersonImagesRequest

a person’s profile images

impl Client

pub fn person_translations(&self, id: u64) -> PersonTranslationsRequest

a person’s translations

impl Client

pub fn review(&self, id: &str) -> ReviewRequest

a review by id

impl Client

pub fn search_movies(&self, query: &str) -> SearchMoviesRequest

search for movies by title

impl Client

pub fn search_tv(&self, query: &str) -> SearchTvRequest

search for series by name

impl Client

pub fn search(&self, query: &str) -> SearchRequest

search movies, series and people in one call

impl Client

pub fn search_people(&self, query: &str) -> SearchPeopleRequest

search for people by name

impl Client

pub fn search_collections(&self, query: &str) -> SearchCollectionsRequest

search for collections by name

impl Client

pub fn search_keywords(&self, query: &str) -> SearchKeywordsRequest

search for keywords by name

impl Client

pub fn search_companies(&self, query: &str) -> SearchCompaniesRequest

search for companies by name

impl Client

pub fn trending_movies(&self, window: TimeWindow) -> TrendingMoviesRequest

the trending movies

impl Client

pub fn trending_tv(&self, window: TimeWindow) -> TrendingTvRequest

the trending series

impl Client

pub fn trending_people(&self, window: TimeWindow) -> TrendingPeopleRequest

the trending people

impl Client

pub fn trending_all(&self, window: TimeWindow) -> TrendingAllRequest

everything trending, movies, series and people mixed

impl Client

pub fn tv(&self, id: u64) -> TvDetailsRequest

the primary details of a series

impl Client

pub fn tv_season(&self, id: u64, season: u32) -> SeasonDetailsRequest

one season of a series, episodes included

impl Client

pub fn tv_episode( &self, id: u64, season: u32, episode: u32, ) -> EpisodeDetailsRequest

one episode of a series

impl Client

pub fn tv_latest(&self) -> TvLatestRequest

the newest series

impl Client

pub fn tv_popular(&self) -> TvPopularRequest

series ordered by popularity

impl Client

pub fn tv_top_rated(&self) -> TvTopRatedRequest

series ordered by rating

impl Client

pub fn tv_on_the_air(&self) -> TvOnTheAirRequest

series with an episode airing in the next week

impl Client

pub fn tv_airing_today(&self) -> TvAiringTodayRequest

series with an episode airing today

impl Client

pub fn tv_keywords(&self, id: u64) -> TvKeywordsRequest

a series’ keywords, without the details round-trip

impl Client

pub fn tv_external_ids(&self, id: u64) -> TvExternalIdsRequest

a series’ ids on other databases

impl Client

pub fn tv_account_states(&self, id: u64) -> TvAccountStatesRequest

a series’ account states (favorite, rated, watchlist)

impl Client

pub fn tv_aggregate_credits(&self, id: u64) -> TvAggregateCreditsRequest

a series’ aggregate credits

impl Client

pub fn tv_alternative_titles(&self, id: u64) -> TvAlternativeTitlesRequest

a series’ alternative titles

impl Client

pub fn tv_changes_by_id(&self, id: u64) -> TvChangesByIdRequest

a series’ recent changes

impl Client

pub fn tv_content_ratings(&self, id: u64) -> TvContentRatingsRequest

a series’ content ratings by country

impl Client

pub fn tv_credits(&self, id: u64) -> TvCreditsRequest

a series’ credits

impl Client

pub fn tv_episode_groups(&self, id: u64) -> TvEpisodeGroupsRequest

a series’ episode groups

impl Client

pub fn tv_images(&self, id: u64) -> TvImagesRequest

a series’ images

impl Client

pub fn tv_lists(&self, id: u64) -> TvListsRequest

the lists a series appears in

impl Client

pub fn tv_similar(&self, id: u64) -> TvSimilarRequest

series similar to a series

impl Client

pub fn tv_recommendations(&self, id: u64) -> TvRecommendationsRequest

a series’ recommendations

impl Client

pub fn tv_reviews(&self, id: u64) -> TvReviewsRequest

a series’ reviews

impl Client

pub fn tv_screened_theatrically(&self, id: u64) -> TvScreenedTheatricallyRequest

the episodes of a series that were screened in theatres

impl Client

pub fn tv_translations(&self, id: u64) -> TvTranslationsRequest

a series’ translations

impl Client

pub fn tv_videos(&self, id: u64) -> TvVideosRequest

a series’ videos (trailers, teasers, …)

impl Client

pub fn tv_watch_providers(&self, id: u64) -> TvWatchProvidersRequest

where a series can be streamed, rented or bought, by country

impl Client

pub fn rate_tv(&self, id: u64, value: f64) -> RateTvRequest

rate a series; pass a session or guest session

impl Client

pub fn unrate_tv(&self, id: u64) -> UnrateTvRequest

delete a series rating

impl Client

pub fn tv_season_account_states( &self, id: u64, season: u32, ) -> TvSeasonAccountStatesRequest

a season’s account states (per-episode ratings)

impl Client

pub fn tv_season_aggregate_credits( &self, id: u64, season: u32, ) -> TvSeasonAggregateCreditsRequest

a season’s aggregate credits

impl Client

pub fn tv_season_changes(&self, id: u64) -> TvSeasonChangesRequest

a season’s changes

impl Client

pub fn tv_season_credits(&self, id: u64, season: u32) -> TvSeasonCreditsRequest

a season’s credits

impl Client

pub fn tv_season_external_ids( &self, id: u64, season: u32, ) -> TvSeasonExternalIdsRequest

a season’s ids on other databases

impl Client

pub fn tv_season_images(&self, id: u64, season: u32) -> TvSeasonImagesRequest

a season’s images

impl Client

pub fn tv_season_translations( &self, id: u64, season: u32, ) -> TvSeasonTranslationsRequest

a season’s translations

impl Client

pub fn tv_season_videos(&self, id: u64, season: u32) -> TvSeasonVideosRequest

a season’s videos

impl Client

pub fn tv_season_watch_providers( &self, id: u64, season: u32, ) -> TvSeasonWatchProvidersRequest

where a season can be watched, by country

impl Client

pub fn tv_episode_account_states( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeAccountStatesRequest

an episode’s account states

impl Client

pub fn tv_episode_changes(&self, id: u64) -> TvEpisodeChangesRequest

an episode’s changes

impl Client

pub fn tv_episode_credits( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeCreditsRequest

an episode’s credits

impl Client

pub fn tv_episode_external_ids( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeExternalIdsRequest

an episode’s ids on other databases

impl Client

pub fn tv_episode_images( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeImagesRequest

an episode’s images

impl Client

pub fn tv_episode_translations( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeTranslationsRequest

an episode’s translations

impl Client

pub fn tv_episode_videos( &self, id: u64, season: u32, episode: u32, ) -> TvEpisodeVideosRequest

an episode’s videos

impl Client

pub fn rate_tv_episode( &self, id: u64, season: u32, episode: u32, value: f64, ) -> RateTvEpisodeRequest

rate an episode; pass a session or guest session

impl Client

pub fn unrate_tv_episode( &self, id: u64, season: u32, episode: u32, ) -> UnrateTvEpisodeRequest

delete an episode rating

impl Client

pub fn tv_episode_group(&self, id: &str) -> TvEpisodeGroupRequest

an episode group

impl Client

pub fn watch_provider_regions(&self) -> WatchProviderRegionsRequest

the regions watch provider data covers

impl Client

pub fn movie_watch_provider_list(&self) -> MovieWatchProviderListRequest

the movie watch providers available in a region

impl Client

pub fn tv_watch_provider_list(&self) -> TvWatchProviderListRequest

the series watch providers available in a region

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.