Skip to content

Latest commit

 

History

History
1400 lines (1054 loc) · 55.8 KB

v4-api.md

File metadata and controls

1400 lines (1054 loc) · 55.8 KB
Raw

Modules

account
authentication
list
movie
tvSeason
tv
watchProvider

account

account.favoriteMovies ⇒ Promise

Get the list of movies you have marked as a favorite.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-favorite-movies

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc,

account.favoriteTvShows ⇒ Promise

Get the list of TV shows you have marked as a favorite.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-favorite-tv-shows

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.lists ⇒ Promise

Get all of the lists you have created.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-lists

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number

account.movieRecommendations ⇒ Promise

Get a list of your personal movie recommendations.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-movie-recommendations

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.movieWatchlist ⇒ Promise

Get the list of movies you have added to your watchlist.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-movie-watchlist

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.ratedMovies ⇒ Promise

Get the list of movies you have rated.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-rated-movies

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.ratedTvShows ⇒ Promise

Get the list of TV shows you have rated.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-rated-tv-shows

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.tvShowRecommendations ⇒ Promise

Get a list of your personal TV show recommendations.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-tv-show-recommendations

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

account.tvShowWatchlist ⇒ Promise

Get the list of TV shows you have added to your watchlist.

Kind: static constant of account
See: https://developers.themoviedb.org/4/account/get-account-tv-show-watchlist

Param Type Description
accessToken string Required
accountId string Required
options Object
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

authentication

authentication.createAccessToken ⇒ Promise

This method will finish the user authentication flow and issue an official user access token. The requesToken in this request is sent along as part of the POST body.

Kind: static constant of authentication
See: https://developers.themoviedb.org/4/auth/create-access-token

Param Type
requestToken string

authentication.createRequestToken ⇒ Promise

This method generates a new request token that you can ask a user to approve. This is the first step in getting permission from a user to read and write data on their behalf. Note that there is an optional body you can post alongside this request to set a redirect URL or callback that will be executed once a request token has been approved on TMDb.

Kind: static constant of authentication
See: https://developers.themoviedb.org/4/auth/create-request-token

Param Type
redirectTo string

authentication.deleteAccessToken ⇒ Promise

This method gives your users the ability to log out of a session.

Kind: static constant of authentication
See: https://developers.themoviedb.org/4/auth/delete-access-token

Param Type
accessToken string

list

list.addItems ⇒ Promise

This method will let you add items to a list. We support essentially an unlimited number of items to be posted at a time. Both movie and TV series are supported. The results of this query will return a results array. Each result includes a success field. If a result is false this will usually indicate that the item already exists on the list. It may also indicate that the item could not be found. You must be the owner of the list and therefore have a valid user access token in order to add items to a list.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/add-items

Param Type Description
accessToken string Required
listId number Required
items Array.<Object> Required
items[].media_type 'movie' | 'tv' Allowed values: movie, tv
items[].media_id number

list.clearItems ⇒ Promise

This method lets you clear all of the items from a list in a single request. This action cannot be reversed so use it with caution. You must be the owner of the list and therefore have a valid user access token in order to clear a list.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/clear-list

Param Type Description
accessToken string Required
listId number Required

list.create ⇒ Promise

This method will create a new list. You will need to have valid user access token in order to create a new list.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/create-list

Param Type Description
accessToken string Required
options object Required
options.name string Required
options.iso_639_1 string Required
options.description string
options.public boolean
options.iso_3166_1 string

list.details ⇒ Promise

This method will retrieve a list by id. Private lists can only be accessed by their owners and therefore require a valid user access token.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/get-list

Param Type Description
accessToken string Required
listId number Required
options object
options.language string
options.page number
options.sort_by 'created_at.asc' | 'created_at.desc' | 'release_date.asc' | 'release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: created_at.asc, created_at.desc, release_date.asc, release_date.desc, title.asc, title.desc, vote_average.asc, vote_average.desc

list.deleteItems ⇒ Promise

This method will let you remove items from a list. You can remove multiple items at a time. You must be the owner of the list and therefore have a valid user access token in order to delete items from it.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/remove-items

Param Type Description
accessToken string Required
listId number Required
items Array.<Object> Required
items[].media_type 'movie' | 'tv' Allowed values: movie, tv
items[].media_id number

list.itemStatus ⇒ Promise

This method lets you quickly check if the item is already added to the list. You must be the owner of the list and therefore have a valid user access token in order to check an item status.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/check-item-status

Param Type Description
accessToken string Required
listId number Required
item object
item.media_type 'movie' | 'tv' Allowed values: movie, tv
item.media_id number

list.remove ⇒ Promise

This method will delete a list by id. This action is not reversible so take care when issuing it. You must be the owner of the list and therefore have a valid user access token in order to delete it.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/delete-list

Param Type Description
accessToken string Required
listId number Required

list.update ⇒ Promise

This method will let you update the details of a list. You must be the owner of the list and therefore have a valid user access token in order to edit it.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/update-list

Param Type Description
accessToken string Required
listId number Required
options object Required
options.name string Required
options.description string
options.public boolean
options.sort_by 'original_order.asc' | 'original_order.desc' | 'primary_release_date.asc' | 'primary_release_date.desc' | 'title.asc' | 'title.desc' | 'vote_average.asc' | 'vote_average.desc' Allowed values: original_order.asc, original_order.desc, vote_average.asc, vote_average.desc, primary_release_date.asc, primary_release_date.desc, title.asc, title.desc

list.updateItems ⇒ Promise

This method will let you update an individual item on a list. Currently, only adding a comment is suported. You must be the owner of the list and therefore have a valid user access token in order to edit items.

Kind: static constant of list
See: https://developers.themoviedb.org/4/list/update-items

Param Type Description
accessToken string Required
listId number Required
items Array.<Object> Required
items[].media_type 'movie' | 'tv' Allowed values: movie, tv
items[].media_id number
items[].comment string

movie

movie.accountStates ⇒ Promise

Grab the following account states for a session:

  • Movie rating
  • If it belongs to your watchlist
  • If it belongs to your favourite list

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-account-states

Param Type Description
movieId number Required
options Object
options.session_id string
options.guest_session_id string

movie.alternativeTitles ⇒ Promise

Get all of the alternative titles for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-alternative-titles

Param Type
movieId number
options Object
options.country string

movie.changes ⇒ Promise

Get the changes for a movie. By default only the last 24 hours are returned. You can query up to 14 days in a single query by using the start_date and end_date query parameters.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-changes

Param Type
movieId number
options Object
options.start_date string
options.end_date string
options.page number

movie.credits ⇒ Promise

Get the cast and crew for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-credits

Param Type
movieId number

movie.deleteRating ⇒ Promise

Remove your rating for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/delete-movie-rating

Param Type
movieId number
options Object
options.session_id string
options.guest_session_id string

movie.details ⇒ Promise

Get the primary information about a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-details

Param Type
movieId number
options Object
options.language string
options.append_to_response string
options.include_image_language string

movie.externalIds ⇒ Promise

Get the external ids for a movie. We currently support the following external sources: IMDB ID, Facebook, Instagram, Twitter.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-external-ids

Param Type
movieId number

movie.images ⇒ Promise

Get the images that belong to a movie. Querying images with a language parameter will filter the results. If you want to include a fallback language (especially useful for backdrops) you can use the include_image_language parameter. This should be a comma separated value like so: { include_image_language: "en,null" }.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-images

Param Type
movieId number
options Object
options.language string
options.include_image_language string

movie.keywords ⇒ Promise

Get the keywords that have been added to a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-keywords

Param Type
movieId number

movie.latest ⇒ Promise

Get the most newly created movie. This is a live response and will continuously change.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-latest-movie

Param Type
options Object
options.language string

movie.lists ⇒ Promise

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-lists

Param Type
movieId number
options Object
options.language string
options.page number

movie.nowPlaying

Get a list of movies in theatres. This is a release type query that looks for all movies that have a release type of 2 or 3 within the specified date range. You can optionally specify a region prameter which will narrow the search to only look for theatrical release dates within the specified country.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-now-playing

Param Type
options Object
options.language string
options.page number
options.region string

movie.popular ⇒ Promise

Get a list of the current popular movies on TMDb. This list updates daily.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-popular-movies

Param Type
options Object
options.language string
options.page number
options.region string

movie.rate ⇒ Promise

Rate a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/rate-movie

Param Type Description
movieId number Required
rating rating between 0.5 and 10.0
options Object
options.guestSessionId string
options.sessionId string

movie.recommendations ⇒ Promise

Get a list of recommended movies for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-recommendations

Param Type
movieId number
options Object
options.language string
options.page number

movie.releaseDates ⇒ Promise

Get the release date along with the certification for a movie. Release dates support different types:

  • Premiere
  • Theatrical (limited)
  • Theatrical
  • Digital
  • Physical
  • TV

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-release-dates

Param Type
movieId number

movie.reviews ⇒ Promise

Get the user reviews for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-reviews

Param Type
movieId number
options Object
options.language string
options.page number

movie.similar ⇒ Promise

Get a list of similar movies. This is not the same as the "Recommendation" system you see on the website. These items are assembled by looking at keywords and genres.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-similar-movies

Param Type
movieId number
options Object
options.language string
options.page number

movie.topRated ⇒ Promise

Get the top rated movies on TMDb.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-top-rated-movies

Param Type
options Object
options.language string
options.page number
options.region string

movie.translations ⇒ Promise

Get a list of translations that have been created for a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-translations

Param Type
movieId number

movie.upcoming ⇒ Promise

Get a list of upcoming movies in theatres. This is a release type query that looks for all movies that have a release type of 2 or 3 within the specified date range. You can optionally specify a region parameter which will narrow the search to only look for theatrical release dates within the specified country.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-upcoming

Param Type
options Object
options.language string
options.page number
options.region string

movie.videos ⇒ Promise

Get the videos that have been added to a movie.

Kind: static constant of movie
See: https://developers.themoviedb.org/3/movies/get-movie-videos

Param Type
movieId number

movie.watchProviders ⇒ Promise

Powered by our partnership with JustWatch, you can query this method to get a list of the availabilities per country by provider. This is not going to return full deep links, but rather, it's just enough information to display what's available where. You can link to the provided TMDB URL to help support TMDB and provide the actual deep links to the content. Please note: In order to use this data you must attribute the source of the data as JustWatch. If we find any usage not complying with these terms we will revoke access to the API.

Kind: static constant of movie
Returns: Promise - Promise
See: https://developers.themoviedb.org/3/movies/get-movie-watch-providers

Param Type
movieId number

tvSeason

tvSeason.accountStates ⇒ Promise

Returns all of the user ratings for the season's episodes.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-account-states

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string
options.session_id string
options.guest_session_id string

tvSeason.aggregateCredits ⇒ Promise

Get the aggregate credits for TV season. This call differs from the main credits call in that it does not only return the season credits, but rather is a view of all the cast & crew for all of the episodes belonging to a season.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-aggregate-credits

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string

tvSeason.changes ⇒ Promise

Get the changes for a TV season. By default only the last 24 hours are returned. You can query up to 14 days in a single query by using the start_date and end_date query options.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-changes

Param Type Description
seasonId number Required
options Object
options.start_date string
options.end_date string
options.page number

tvSeason.credits ⇒ Promise

Get the credits for TV season.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-credits

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string

tvSeason.details ⇒ Promise

Get the TV season details by id.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-details

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string
options.append_to_response string
options.include_image_language string

tvSeason.externalIds ⇒ Promise

Get the external ids for a TV season. We currently support the following external sources. TVDB ID, Freebase MID, Freebase ID, TVRage ID

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-external-ids

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string

tvSeason.images ⇒ Promise

Get the images that belong to a TV season. Querying images with a language parameter will filter the results. If you want to include a fallback language (especially useful for backdrops) you can use the include_image_language option. This should be a: include_image_language comma separated value like so: include_image_language: "en,null".

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-images

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string
options.include_image_language string

tvSeason.translations ⇒ Promise

Get the credits for TV season.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-translations

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string

tvSeason.videos ⇒ Promise

Get the videos that have been added to a TV season.

Kind: static constant of tvSeason
See: https://developers.themoviedb.org/3/tv-seasons/get-tv-season-videos

Param Type Description
tvId number Required
seasonNumber number Required
options Object
options.language string

tv

tv.accountStates ⇒ Promise

Grab the following account states for a session: TV show rating, If it belongs to your watchlist and If it belongs to your favourite list

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-account-states

Param Type Description
tvId number Required
options Object
options.session_id string
options.guest_session_id string
options.language string

tv.aggregateCredits ⇒ Promise

Get the aggregate credits (cast and crew) that have been added to a TV show. This call differs from the main credits call in that it does not return the newest season but rather, is a view of all the entire cast & crew for all episodes belonging to a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-aggregate-credits

Param Type Description
tvId number Required
options Object
options.language string

tv.airingToday ⇒ Promise

Get a list of TV shows that are airing today. This query is purely day based as we do not currently support airing times. You can specify a timezone to offset the day calculation. Without a specified timezone, this query defaults to EST (Eastern Time UTC-05:00).

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-airing-today

Param Type
options Object
options.language string
options.page number

tv.alternativeTitles ⇒ Promise

Returns all of the alternative titles for a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-alternative-titles

Param Type Description
tvId number Required
options Object
options.language string

tv.changes ⇒ Promise

Get the changes for a TV show. By default only the last 24 hours are returned. You can query up to 14 days in a single query by using the start_date and end_date options.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-changes

Param Type Description
tvId number Required
options Object
options.start_date string
options.end_date string
options.page number

tv.contentRatings ⇒ Promise

Get the list of content ratings (certifications) that have been added to a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-content-ratings

Param Type Description
tvId number Required
options Object
options.language string

tv.credits ⇒ Promise

Get the credits (cast and crew) that have been added to a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-credits

Param Type Description
tvId number Required
options Object
options.language string

tv.deleteRating ⇒ Promise

Remove your rating for a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/delete-tv-show-rating

Param Type
tvId number
options Object
options.session_id string
options.guest_session_id string

tv.details ⇒ Promise

Get the primary TV show details by id.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-details

Param Type Description
tvId number Required
options Object
options.language string
options.append_to_response string
options.include_image_language string

tv.episodeGroups ⇒ Promise

Get all of the episode groups that have been created for a TV show. With a group ID you can call the tvEpisodeGroups.details method.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-credits

Param Type Description
tvId number Required
options Object
options.language string

tv.externalIds ⇒ Promise

Get the external ids for a TV show. We currently support the following external sources. IMDB ID, TVDB ID, Freebase MID, Freebase ID, TVRage ID

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-external-ids

Param Type Description
tvId number Required
options Object
options.language string

tv.images ⇒ Promise

Get the images that belong to a TV show. Querying images with a language parameter will filter the results. If you want to include a fallback language (especially useful for backdrops) you can use the include_image_language option. This should be a comma separated value like so: include_image_language=en,null.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-images

Param Type Description
tvId number Required
options Object
options.language string
options.include_image_language string

tv.keywords ⇒ Promise

Get the keywords that have been added to a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-keywords

Param Type Description
tvId number Required

tv.latest ⇒ Promise

Get the most newly created TV show. This is a live response and will continuously change.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-latest-tv

Param Type
options Object
options.language string

tv.onTheAir ⇒ Promise

Get a list of shows that are currently on the air. This query looks for any TV show that has an episode with an air date in the next 7 days.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-on-the-air

Param Type
options Object
options.language string
options.page number

tv.popular ⇒ Promise

Get a list of the current popular TV shows on TMDb. This list updates daily.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-popular-tv-shows

Param Type
options Object
options.language string
options.page number

tv.rate ⇒ Promise

Rate a TV episode.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/rate-tv-show

Param Type Description
tvId number Required
rating rating between 0.5 and 10.0
options Object
options.session_id string
options.guest_session_id string

tv.recommendations ⇒ Promise

Get the list of TV show recommendations for this item.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-recommendations

Param Type Description
tvId number Required
options Object
options.language string
options.page number

tv.reviews ⇒ Promise

Get the reviews for a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-reviews

Param Type Description
tvId number Required
options Object
options.language string
options.page number

tv.screenedTheatrically ⇒ Promise

Get a list of seasons or episodes that have been screened in a film festival or theatre.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-screened-theatrically

Param Type Description
tvId number Required

tv.similar ⇒ Promise

Get a list of similar TV shows. These items are assembled by looking at keywords and genres.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-similar-tv-shows

Param Type Description
tvId number Required
options Object
options.language string
options.page number

tv.topRated ⇒ Promise

Get a list of the top rated TV shows on TMDb.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-top-rated-tv

Param Type
options Object
options.language string
options.page number

tv.translations ⇒ Promise

Get a list of the translations that exist for a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-translations

Param Type Description
tvId number Required
options Object
options.language string

tv.videos ⇒ Promise

Get the videos that have been added to a TV show.

Kind: static constant of tv
See: https://developers.themoviedb.org/3/tv/get-tv-videos

Param Type Description
tvId number Required
options Object
options.language string

tv.watchProviders ⇒ Promise

Powered by our partnership with JustWatch, you can query this method to get a list of the availabilities per country by provider. This is not going to return full deep links, but rather, it's just enough information to display what's available where. You can link to the provided TMDB URL to help support TMDB and provide the actual deep links to the content. Please note: In order to use this data you must attribute the source of the data as JustWatch. If we find any usage not complying with these terms we will revoke access to the API.

Kind: static constant of tv
Returns: Promise - Promise
See: https://developers.themoviedb.org/3/tv/get-tv-watch-providers

Param Type
tvId number

watchProvider

watchProvider.availableRegions ⇒ Promise

Returns a list of all of the countries we have watch provider (OTT/streaming) data for.

Kind: static constant of watchProvider
See: https://developers.themoviedb.org/3/watch-providers/get-available-regions

Param Type
options Object
options.language string

watchProvider.movie ⇒ Promise

Returns a list of the watch provider (OTT/streaming) data we have available for movies. You can specify a watch_region param if you want to further filter the list by country.

Kind: static constant of watchProvider
See: https://developers.themoviedb.org/3/watch-providers/get-movie-providers

Param Type
options Object
options.language string
options.watch_region string

watchProvider.tv ⇒ Promise

Returns a list of the watch provider (OTT/streaming) data we have available for TV series. You can specify a watch_region param if you want to further filter the list by country.

Kind: static constant of watchProvider
See: https://developers.themoviedb.org/3/watch-providers/get-tv-providers

Param Type
options Object
options.language string
options.watch_region string