v3-api.md

Modules

account

authentication

certification

changes

collection

company

configuration

credit

discover

find

genre

guestSession

keyword

list

movie

network

people

review

search

trending

tvEpisodeGroup

tvEpisode

tvSeason

tv

watchProvider

movie

tvSeason

tv

watchProvider

account

• account
  • .addToWatchlist ⇒ Promise
  • .details ⇒ Promise
  • .favoriteMovies ⇒ Promise
  • .favoriteTvShows ⇒ Promise
  • .lists ⇒ Promise
  • .markAsFavorite ⇒ Promise
  • .movieWatchlist ⇒ Promise
  • .ratedMovies ⇒ Promise
  • .ratedTvShows ⇒ Promise
  • .ratedTvEpisodes ⇒ Promise
  • .tvShowWatchlist ⇒ Promise

account.addToWatchlist ⇒ Promise

Add a movie or TV show to your watchlist.

Kind: static constant of account
See: https://developers.themoviedb.org/3/account/add-to-watchlist

Param	Type	Description
accountId	number	Required
sessionId	string	Required
body	Object	Required
body.media_type	'movie' | 'tv'	Required - Allowed values: movie, tv
body.media_id	number	Required
body.watchlist	boolean	Required

account.details ⇒ Promise

Get your account details.

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

Param	Type
sessionId	string

account.favoriteMovies ⇒ Promise

Get the list of your favorite movies.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.favoriteTvShows ⇒ Promise

Get the list of your favorite TV shows.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.lists ⇒ Promise

Get all of the lists created by an account. Will invlude private lists if you are the owner.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number

account.markAsFavorite ⇒ Promise

This method allows you to mark a movie or TV show as a favorite item.

Kind: static constant of account
See: https://developers.themoviedb.org/3/account/mark-as-favorite

Param	Type	Description
accountId	number	Required
sessionId	string	Required
body	Object	Required
body.media_type	'movie' | 'tv'	Required
body.media_id	number	Required
body.favorite	boolean	Required

account.movieWatchlist ⇒ Promise

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

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.ratedMovies ⇒ Promise

Get a list of all the movies you have rated.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.ratedTvShows ⇒ Promise

Get a list of all the TV shows you have rated.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.ratedTvEpisodes ⇒ Promise

Get a list of all the TV episodes you have rated.

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

account.tvShowWatchlist ⇒ Promise

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

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

Param	Type	Description
accountId	number	Required
options	Object
options.session_id	string	Required
options.language	string
options.page	number
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

authentication

• authentication
  • .logout ⇒ Promise
  • .newGuestSession ⇒ Promise
  • .newSession ⇒ Promise
  • .newToken ⇒ Promise
  • .sessionConvert ⇒ Promise
  • .validateWithLogin ⇒ Promise

authentication.logout ⇒ Promise

If you would like to delete (or "logout") from a session, call this method with a valid session ID.

Kind: static constant of authentication
See: https://developers.themoviedb.org/3/authentication/delete-session

Param	Type
sessionId	string

authentication.newGuestSession ⇒ Promise

This method will let you create a new guest session. Guest sessions are a type of session that will let a user rate movies and TV shows but not require them to have a TMDb user account.

Kind: static constant of authentication
See: https://developers.themoviedb.org/3/authentication/create-guest-session

authentication.newSession ⇒ Promise

You can use this method to create a fully valid session ID once a user has validated the request token.

Kind: static constant of authentication
See: https://developers.themoviedb.org/3/authentication/create-session

Param	Type
requestToken	string

authentication.newToken ⇒ Promise

Create a temporary request token that can be used to validate a TMDb user login.

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

authentication.sessionConvert ⇒ Promise

Use this method to create a v3 session ID if you already have a valid v4 access token. The v4 token needs to be authenticated by the user. Your standard "read token" will not validate to create a session ID.

Kind: static constant of authentication
See: https://developers.themoviedb.org/3/authentication/create-session-from-v4-access-token

Param	Type
v4AccessToken	string

authentication.validateWithLogin ⇒ Promise

This method allows an application to validate a request token by entering a username and password. Not all applications have access to a web view so this can be used as a substitute. If you decide to use this method please use HTTPS.

Kind: static constant of authentication
See: https://developers.themoviedb.org/3/authentication/validate-request-token

Param	Type
options	Object
options.username	string
options.password	string
options.request_token	string

certification

• certification
  • .movies ⇒ Promise
  • .tvShows ⇒ Promise

certification.movies ⇒ Promise

Get an up to date list of the officially supported movie certifications on TMDb.

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

certification.tvShows ⇒ Promise

Get an up to date list of the officially supported TV show certifications on TMDb.

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

changes

• changes
  • .movies ⇒ Promise
  • .people ⇒ Promise
  • .tvShows ⇒ Promise

changes.movies ⇒ Promise

Get a list of all of the movie ids that have been changed in the past 24 hours. You can query it for up to 14 days worth of changed IDs at a time with the start_date and end_date query parameters. 100 items are returned per page.

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

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

changes.people ⇒ Promise

Get a list of all of the person ids that have been changed in the past 24 hours. You can query it for up to 14 days worth of changed IDs at a time with the start_date and end_date query parameters. 100 items are returned per page.

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

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

changes.tvShows ⇒ Promise

Get a list of all of the TV show ids that have been changed in the past 24 hours. You can query it for up to 14 days worth of changed IDs at a time with the start_date and end_date query parameters. 100 items are returned per page.

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

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

collection

• collection
  • .details ⇒ Promise
  • .images ⇒ Promise
  • .translations ⇒ Promise

collection.details ⇒ Promise

Get collection details by id.

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

Param	Type
collectionId	number
options	Object
options.language	string

collection.images ⇒ Promise

Get the images for a collection by id.

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

Param	Type
collectionId	number
options	Object
options.language	string

collection.translations ⇒ Promise

Get the list translations for a collection by id.

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

Param	Type
collectionId	number
options	Object
options.language	string

company

• company
  • .alternativeNames ⇒ Promise
  • .details ⇒ Promise
  • .images ⇒ Promise

company.alternativeNames ⇒ Promise

Get the alternative names of a company.

Kind: static constant of company
See: https://developers.themoviedb.org/3/companies/get-company-alternative-names

Param	Type
companyId	number

company.details ⇒ Promise

Get a companies details by id.

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

Param	Type
companyId	number

company.images ⇒ Promise

Get a companies logos by id. There are two image formats that are supported for companies, PNG"s and SVG"s. You can see which type the original file is by looking at the file_type field. We prefer SVG"s as they are resolution independent and as such, the width and height are only there to reflect the original asset that was uploaded. An SVG can be scaled properly beyond those dimensions if you call them as a PNG.

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

Param	Type
companyId	number

configuration

• configuration
  • .api ⇒ Promise
  • .countries ⇒ Promise
  • .jobs ⇒ Promise
  • .languages ⇒ Promise
  • .primaryTranslations ⇒ Promise
  • .timezones ⇒ Promise

configuration.api ⇒ Promise

Get the system wide configuration information.

Kind: static constant of configuration
See: https://developers.themoviedb.org/3/configuration/get-api-configuration

configuration.countries ⇒ Promise

Get the list of countries (ISO 3166-1 tags) used throughout TMDb.

Kind: static constant of configuration
See: https://developers.themoviedb.org/3/configuration/get-countries

configuration.jobs ⇒ Promise

Get a list of the jobs and departments we use on TMDb.

Kind: static constant of configuration
See: https://developers.themoviedb.org/3/configuration/get-jobs

configuration.languages ⇒ Promise

Get the list of languages (ISO 639-1 tags) used throughout TMDb.

Kind: static constant of configuration
See: https://developers.themoviedb.org/3/configuration/get-languages

configuration.primaryTranslations ⇒ Promise

Get a list of the officially supported translations on TMDb.

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

configuration.timezones ⇒ Promise

Get the list of timezones used throughout TMDb.

Kind: static constant of configuration
See: https://developers.themoviedb.org/3/configuration/get-timezones

credit

credit.details ⇒ Promise

Get a movie or TV credit details by id.

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

discover

• discover
  • .movie ⇒ Promise
  • .tvShows ⇒ Promise

discover.movie ⇒ Promise

Discover movies by different types of data like average rating, number of votes, genres and certifications. For a full list of options, see https://developers.themoviedb.org/3/discover/movie-discover

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

Param	Type
options	Object

discover.tvShows ⇒ Promise

Discover TV shows by different types of data like average rating, number of votes, genres, the network they aired on and air dates. For a full list of options, see https://developers.themoviedb.org/3/discover/tv-discover

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

Param	Type
options	Object

find

find.byId ⇒ Promise

The find method makes it easy to search for objects in our database by an external id. For example, an IMDB ID. This method will search all objects (movies, TV shows and people) and return the results in a single response.

Kind: static constant of find
See: https://developers.themoviedb.org/3/find/find-by-id

Param	Type	Description
options	Object
options.external_id	string
options.external_source	string	Possible values: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
options.language	string

genre

• genre
  • .movieList ⇒ Promise
  • .tvList ⇒ Promise

genre.movieList ⇒ Promise

Get the list of official genres for movies.

Kind: static constant of genre
See: https://developers.themoviedb.org/3/genres/get-movie-list

Param	Type
options	Object
options.language	string

genre.tvList ⇒ Promise

Get the list of official genres for TV shows.

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

Param	Type
options	Object
options.language	string

guestSession

• guestSession
  • .ratedMovies ⇒ Promise
  • .ratedTvEpisodes ⇒ Promise
  • .ratedTvShows ⇒ Promise

guestSession.ratedMovies ⇒ Promise

Get the rated movies for a guest session.

Kind: static constant of guestSession
See: https://developers.themoviedb.org/3/guest-sessions/get-guest-session-rated-movies

Param	Type	Description
guestSessionId	string	Required
options	Object
options.language	string
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

guestSession.ratedTvEpisodes ⇒ Promise

Get the rated TV episodes for a guest session.

Kind: static constant of guestSession
See: https://developers.themoviedb.org/3/guest-sessions/get-gest-session-rated-tv-episodes

Param	Type	Description
guestSessionId	string	Required
options	Object
options.language	string
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

guestSession.ratedTvShows ⇒ Promise

Get the rated TV shows for a guest session.

Kind: static constant of guestSession
See: https://developers.themoviedb.org/3/guest-sessions/get-guest-session-rated-tv-shows

Param	Type	Description
guestSessionId	string	Required
options	Object
options.language	string
options.sort_by	'created_at.asc' | 'created_at.desc'	Allowed values: created_at.asc, created_at.desc

keyword

• keyword
  • .details ⇒ Promise
  • .movies ⇒ Promise

keyword.details ⇒ Promise

Get details of keyword

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

Param	Type	Description
keywordId	number	Required

keyword.movies ⇒ Promise

Get the movies that belong to a keyword.

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

Param	Type	Description
keywordId	number	Required
options	Object
options.language	string
options.include_adult	boolean

list

• list
  • .addMovie ⇒ Promise
  • .clear ⇒ Promise
  • .create ⇒ Promise
  • .details ⇒ Promise
  • .itemStatus ⇒ Promise
  • .remove ⇒ Promise
  • .removeMovie ⇒ Promise

list.addMovie ⇒ Promise

Add a movie to a list.

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

Param	Type	Description
listId	string | number	Required
sessionId	string	Required
body	Object	Required
body.media_id	number	Required

list.clear ⇒ Promise

Clear all of the items from a list.

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

Param	Type	Description
listId	string	Required
options	Object	Required
options.session_id	string	Required
options.confirm	boolean	Required

list.create ⇒ Promise

Create a list.

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

Param	Type	Description
sessionId	string	Required
body	Object
body.name	string
body.description	string
body.language	string

list.details ⇒ Promise

Get the details of a list.

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

Param	Type	Description
listId	number | string	Required
options	Object
options.language	string

list.itemStatus ⇒ Promise

You can use this method to check if a movie has already been added to the list.

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

Param	Type	Description
listId	number | string	Required
options	Object
options.movieId	string	Required

list.remove ⇒ Promise

Delete a list.

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

Param	Type	Description
listId	string	Required
options	Object	Required
options.session_id	string	Required

list.removeMovie ⇒ Promise

Remove a movie from a list.

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

Param	Type	Description
listId	string | number	Required
sessionId	string	Required
body	Object	Required
body.media_id	number	Required

movie

• movie
  • .accountStates ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .lists ⇒ Promise
  • .nowPlaying
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .releaseDates ⇒ Promise
  • .reviews ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .upcoming ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise
  • .accountStates ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .lists ⇒ Promise
  • .nowPlaying
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .releaseDates ⇒ Promise
  • .reviews ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .upcoming ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise

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

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

network

• network
  • .details ⇒ Promise
  • .alternativeNames ⇒ Promise
  • .images ⇒ Promise

network.details ⇒ Promise

Get the details of a network.

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

Param	Type
networkId	number

network.alternativeNames ⇒ Promise

Get the alternative names of a network.

Kind: static constant of network
See: https://developers.themoviedb.org/3/networks/get-network-alternative-names

Param	Type
networkId	number

network.images ⇒ Promise

Get the TV network logos by id. There are two image formats that are supported for networks, PNG"s and SVG"s. You can see which type the original file is by looking at the fileType field. We prefer SVG"s as they are resolution independent and as such, the width and height are only there to reflect the original asset that was uploaded. An SVG can be scaled properly beyond those dimensions if you call them as a PNG.

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

Param	Type
networkId	number

people

• people
  • .changes ⇒ Promise
  • .combinedCredits ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .latest ⇒ Promise
  • .movieCredits ⇒ Promise
  • .popular ⇒ Promise
  • .taggedImages ⇒ Promise
  • .translations ⇒ Promise
  • .tvCredits ⇒ Promise

people.changes ⇒ Promise

Get the changes for a person. 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 people
See: https://developers.themoviedb.org/3/people/get-person-changes

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

people.combinedCredits ⇒ Promise

Get the movie and TV credits together in a single response.

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

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

people.details ⇒ Promise

Get the primary person details by id.

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

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

people.externalIds ⇒ Promise

Get the external ids for a person. We currently support the following external sources. IMDB ID, TVDB ID, Freebase MID, Freebase ID, TVRage ID, Instagram, Facebook, Twitter

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

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

people.images ⇒ Promise

Get the images for a person.

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

Param	Type	Description
personId	number	Required

people.latest ⇒ Promise

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

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

Param	Type
options	Object
options.language	string

people.movieCredits ⇒ Promise

Get the movie credits for a person.

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

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

people.popular ⇒ Promise

Get the list of popular people on TMDb. This list updates daily.

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

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

people.taggedImages ⇒ Promise

Get the images that this person has been tagged in.

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

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

people.translations ⇒ Promise

Get a list of the translations that exist for a person.

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

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

people.tvCredits ⇒ Promise

Get the TV show credits for a person. You can query for some extra details about the credit with the credit.details method.

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

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

review

review.details ⇒ Promise

Get details of a review.

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

Param	Type
reviewId	string

search

• search
  • .collections ⇒ Promise
  • .companies ⇒ Promise
  • .keywords ⇒ Promise
  • .movies ⇒ Promise
  • .multi ⇒ Promise
  • .people ⇒ Promise
  • .tv ⇒ Promise

search.collections ⇒ Promise

Search for collections.

Kind: static constant of search
See: https://developers.themoviedb.org/3/search/search-collections

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

search.companies ⇒ Promise

Search for companies.

Kind: static constant of search
See: https://developers.themoviedb.org/3/search/search-companies

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

search.keywords ⇒ Promise

Search for keywords.

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

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

search.movies ⇒ Promise

Search for movies.

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

Param	Type
options	Object
options.language	string
options.query	string
options.page	number
options.include_adult	boolean
options.region	string
option.year	number
option.primary_release_year	number

search.multi ⇒ Promise

Search multiple models in a single request. Multi search currently supports searching for movies, tv shows and people in a single request.

Kind: static constant of search
See: https://developers.themoviedb.org/3/search/multi-search

Param	Type
options	Object
options.language	string
options.query	string
options.page	number
options.include_adult	boolean
options.region	string

search.people ⇒ Promise

Search for people.

Kind: static constant of search
See: https://developers.themoviedb.org/3/search/search-people

Param	Type
options	Object
options.language	string
options.query	string
options.page	number
options.include_adult	boolean
options.region	string

search.tv ⇒ Promise

Search for a TV show.

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

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

trending

trending.items ⇒ Promise

Get the daily or weekly trending items. The daily trending list tracks items over the period of a day while items have a 24 hour half life. The weekly list tracks items over a 7 day period, with a 7 day half life.

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

Param	Type	Description
options	Object
options.media_type	'all' | 'movie' | 'tv' | 'person'	Allowed values: all, movie, tv, person
options.time_window	'day' | 'week'	Allowed values: day, week

tvEpisodeGroup

tvEpisodeGroup.details ⇒ Promise

Get the details of a TV episode group. Groups support 7 different types which are enumerated as the following: 1 - Original air date, 2- Absolute, 3 - DVD, 4 - Digital, 5 - Story arc, 6 - Production, 7 - TV

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

Param	Type
id	string
options	Object
options.language	string

tvEpisode

• tvEpisode
  • .accountStates ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .rate ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise

tvEpisode.accountStates ⇒ Promise

Get your rating for a episode.

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

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

tvEpisode.changes ⇒ Promise

Get the changes for a TV episode. By default only the last 24 hours are returned.

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

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

tvEpisode.credits ⇒ Promise

Get the credits (cast, crew and guest stars) for a TV episode.

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

Param	Type	Description
tvId	number	Required
seasonNumber	number	Required
episodeNumber	number	Required

tvEpisode.deleteRating ⇒ Promise

Remove your rating for a TV episode.

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

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

tvEpisode.details ⇒ Promise

Get the TV episode details by id.

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

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

tvEpisode.externalIds ⇒ Promise

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

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

Param	Type	Description
tvId	number	Required
seasonNumber	number	Required
episodeNumber	number	Required

tvEpisode.images ⇒ Promise

Get the images that belong to a TV episode. 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 tvEpisode
See: https://developers.themoviedb.org/3/tv-episodes/get-tv-episode-images

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

tvEpisode.rate ⇒ Promise

Rate a TV episode.

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

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

tvEpisode.translations ⇒ Promise

Get the translation data for an episode.

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

Param	Type	Description
tvId	number	Required
seasonNumber	number	Required
episodeNumber	number	Required

tvEpisode.videos ⇒ Promise

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

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

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

tvSeason

• tvSeason
  • .accountStates ⇒ Promise
  • .aggregateCredits ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .accountStates ⇒ Promise
  • .aggregateCredits ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise

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

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
  • .aggregateCredits ⇒ Promise
  • .airingToday ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .contentRatings ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .episodeGroups ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .onTheAir ⇒ Promise
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .reviews ⇒ Promise
  • .screenedTheatrically ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise
  • .accountStates ⇒ Promise
  • .aggregateCredits ⇒ Promise
  • .airingToday ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .contentRatings ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .episodeGroups ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .onTheAir ⇒ Promise
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .reviews ⇒ Promise
  • .screenedTheatrically ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise

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

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
  • .movie ⇒ Promise
  • .tv ⇒ Promise
  • .availableRegions ⇒ Promise
  • .movie ⇒ Promise
  • .tv ⇒ Promise

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

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

movie

• movie
  • .accountStates ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .lists ⇒ Promise
  • .nowPlaying
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .releaseDates ⇒ Promise
  • .reviews ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .upcoming ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise
  • .accountStates ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .lists ⇒ Promise
  • .nowPlaying
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .releaseDates ⇒ Promise
  • .reviews ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .upcoming ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise

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

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
  • .aggregateCredits ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .accountStates ⇒ Promise
  • .aggregateCredits ⇒ Promise
  • .changes ⇒ Promise
  • .credits ⇒ Promise
  • .details ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise

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

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
  • .aggregateCredits ⇒ Promise
  • .airingToday ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .contentRatings ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .episodeGroups ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .onTheAir ⇒ Promise
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .reviews ⇒ Promise
  • .screenedTheatrically ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise
  • .accountStates ⇒ Promise
  • .aggregateCredits ⇒ Promise
  • .airingToday ⇒ Promise
  • .alternativeTitles ⇒ Promise
  • .changes ⇒ Promise
  • .contentRatings ⇒ Promise
  • .credits ⇒ Promise
  • .deleteRating ⇒ Promise
  • .details ⇒ Promise
  • .episodeGroups ⇒ Promise
  • .externalIds ⇒ Promise
  • .images ⇒ Promise
  • .keywords ⇒ Promise
  • .latest ⇒ Promise
  • .onTheAir ⇒ Promise
  • .popular ⇒ Promise
  • .rate ⇒ Promise
  • .recommendations ⇒ Promise
  • .reviews ⇒ Promise
  • .screenedTheatrically ⇒ Promise
  • .similar ⇒ Promise
  • .topRated ⇒ Promise
  • .translations ⇒ Promise
  • .videos ⇒ Promise
  • .watchProviders ⇒ Promise

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

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
  • .movie ⇒ Promise
  • .tv ⇒ Promise
  • .availableRegions ⇒ Promise
  • .movie ⇒ Promise
  • .tv ⇒ Promise

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

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