TMDb: Access to TMDb API
Package ‘TMDb’
October 12, 2022
Type Package
Title Access to TMDb API
Version 1.1
Date 2022-03-15
Author Rami Kay <support@drama-turk.online> Maintainer Rami Koy <support@drama-turk.online>
Description Provides an R-
interface to the TMDb API (see TMDb API on <https://developers.themoviedb.org/3/ getting-started/introduction>). The Movie Database (TMDb) is a popular user ed- itable database for movies and TV shows (see <https://www.themoviedb.org>).
License Artistic-2.0
LazyData true
Depends R (>= 3.6), httr(>= 1.4.1), jsonlite(>= 1.6.1), stringi(>= 1.4.6)
Collate ‘certification_movie_list.R’ ‘certification_tv_list.R’ ‘changes_movie.R’ ‘changes_person.R’ ‘changes_tv.R’ ‘collection.R’ ‘collection_images.R’ ‘company.R’ ‘company_movies.R’ ‘configuration.R’ ‘credit.R’ ‘discover_movie.R’ ‘discover_tv.R’ ‘find_tmdb.R’ ‘genres_movie_list.R’ ‘genres_movies.R’ ‘genres_tv_list.R’ ‘is.wholenumber.R’ ‘jobs.R’ ‘keyword.R’ ‘keyword_movies.R’ ‘list_get.R’ ‘list_item_status.R’ ‘movie.R’ ‘movie_alternative_title.R’ ‘movie_changes.R’ ‘movie_credits.R’ ‘movie_images.R’ ‘movie_keywords.R’ ‘movie_latest.R’ ‘movie_lists.R’ ‘movie_now_playing.R’ ‘movie_popular.R’ ‘movie_releases.R’ ‘movie_reviews.R’ ‘movie_similar.R’ ‘movie_top_rated.R’ ‘movie_translations.R’ ‘movie_upcoming.R’ ‘movie_videos.R’ ‘network.R’ ‘person_tmdb.R’ ‘person_changes.R’ ‘person_combined_credits.R’ ‘person_external_ids.R’ ‘person_images.R’ ‘person_latest.R’ ‘person_movie_credits.R’ ‘person_popular.R’ ‘person_tagged_images.R’ ‘person_tv_credits.R’ ‘review.R’ ‘search_collection.R’ ‘search_company.R’ ‘search_keyword.R’ ‘search_list.R’
1
2
R topics documented:
‘search_movie.R’ ‘search_multi.R’ ‘search_person.R’ ‘search_tv.R’ ‘timezone.R’ ‘tv.R’ ‘tv_airing_today.R’ ‘tv_alternative_title.R’ ‘tv_changes.R’ ‘tv_content_ratings.R’ ‘tv_credits.R’ ‘tv_episode.R’ ‘tv_episode_changes.R’ ‘tv_episode_credits.R’ ‘tv_episode_external_ids.R’ ‘tv_episode_images.R’ ‘tv_episode_videos.R’ ‘tv_external_ids.R’ ‘tv_images.R’ ‘tv_keywords.R’ ‘tv_latest.R’ ‘tv_on_the_air.R’ ‘tv_popular.R’ ‘tv_season.R’ ‘tv_season_changes.R’ ‘tv_season_credits.R’ ‘tv_season_external_ids.R’ ‘tv_season_images.R’ ‘tv_season_videos.R’ ‘tv_similar.R’ ‘tv_top_rated.R’ ‘tv_translations.R’ ‘tv_videos.R’
NeedsCompilation no
Repository CRAN
Date/Publication 2020-03-16 20:30:02 UTC
R topics documented:
certification_movie_list…………………………….. 4 certification_tv_list ………………………………. 5 changes_movie ………………………………… 6 changes_person………………………………… 7 changes_tv ………………………………….. 8 collection …………………………………… 10 collection_images……………………………….. 11 company……………………………………. 12 company_movies ……………………………….. 13 configuration …………………………………. 14 credit …………………………………….. 15 discover_movie………………………………… 16 discover_tv ………………………………….. 19 find_tmdb…………………………………… 21 genres_movies ………………………………… 22 genres_movie_list……………………………….. 23 genres_tv_list…………………………………. 24 jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 keyword……………………………………. 26 keyword_movies ……………………………….. 27 list_get…………………………………….. 28 list_item_status ………………………………… 29 movie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 movie_alternative_title …………………………….. 32 movie_changes ………………………………… 33 movie_credits…………………………………. 34 movie_images…………………………………. 35 movie_keywords ……………………………….. 36 movie_latest………………………………….. 37 movie_lists ………………………………….. 38
R topics documented: 3
movie_now_playing………………………………. 39 movie_popular ………………………………… 40 movie_releases ………………………………… 41 movie_reviews ………………………………… 42 movie_similar…………………………………. 43 movie_top_rated ……………………………….. 44 movie_translations ………………………………. 45 movie_upcoming ……………………………….. 46 movie_videos…………………………………. 47 network……………………………………. 48 person_changes………………………………… 49 person_combined_credits……………………………. 50 person_external_ids………………………………. 51 person_images ………………………………… 52 person_latest …………………………………. 53 person_movie_credits……………………………… 55 person_popular ………………………………… 56 person_tagged_images …………………………….. 57 person_tmdb …………………………………. 58 person_tv_credits……………………………….. 59 review…………………………………….. 60 search_collection ……………………………….. 61 search_company ……………………………….. 62 search_keyword………………………………… 63 search_list…………………………………… 64 search_movie…………………………………. 65 search_multi………………………………….. 66 search_person…………………………………. 67 search_tv …………………………………… 68 timezone……………………………………. 70 tv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 tv_airing_today………………………………… 72 tv_alternative_title ………………………………. 74 tv_changes ………………………………….. 75 tv_content_ratings……………………………….. 76 tv_credits …………………………………… 77 tv_episode…………………………………… 78 tv_episode_changes………………………………. 79 tv_episode_credits ………………………………. 80 tv_episode_external_ids ……………………………. 81 tv_episode_images ………………………………. 82 tv_episode_videos……………………………….. 83 tv_external_ids ………………………………… 84 tv_images…………………………………… 85 tv_keywords………………………………….. 86 tv_latest……………………………………. 87 tv_on_the_air…………………………………. 89 tv_popular…………………………………… 90
4 certification_movie_list
tv_season …………………………………… 91 tv_season_changes ………………………………. 92 tv_season_credits……………………………….. 93 tv_season_external_ids …………………………….. 94 tv_season_images……………………………….. 95 tv_season_videos ……………………………….. 96 tv_similar…………………………………… 97 tv_top_rated………………………………….. 98 tv_translations…………………………………. 99 tv_videos ……………………………………100
Index
certification_movie_list
Get the list of supported certifications for movies.
Description
This method provides the certifications for movies in the following countries: Australia, Canada, Great Britain, USA, France, Germany, New Zeland, India.
Usage
certification_movie_list(api_key)
Arguments
api_key Your TMDb Consumer Key. Details
These can be used in conjunction with the certification_country and certification.lte parameters when using discover.
Value
A list of the supported movie certifications in the following countries:
AU Australia
CA Canada
GB Great Britain US USA
FR France
DE Germany
NZ New Zeland IN India
102
certification_tv_list 5 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
certification_movie_list(api_key = api_key)
## End(Not run)
certification_tv_list Get the list of supported certifications for TV shows.
Description
This method provides the certifications for TV shows in the following country: Australia, Canada, Great Britain, USA, France, Germany, Russia, Thailandia, Brazil, South Korea
Usage
certification_tv_list(api_key)
Arguments
api_key Your TMDb Consumer Key.
Value
A list of the supported TV show certifications in the following countries:
AU Australia
CA Canada
GB Great Britain US USA
FR France
DE Germany
NZ Russia
6
TH BR KR
changes_movie
Author(s)
Andrea Capozio
References
Thailandia Brazil South Korea
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
certification_tv_list(api_key = api_key)
## End(Not run)
changes_movie Get a list of movie ids that have been edited.
Description
By default TMDb shows the last 24 hours and only 100 items per page. The maximum number of days that can be returned in a single request is 14.
Usage
changes_movie(api_key, page = 1, start_date = NA, end_date = NA)
Arguments
api_key
page
start_date
end_date
Details
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
The change log system to support this was changed on October 5, 2012 and will only show movies that have been edited since.
changes_person 7
Value
A list with the following fields:
results
page
total_pages
total_results
Author(s)
Andrea Capozio
References
The IDs of the changed movies. The current page for the results. The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
changes_movie(api_key = api_key, page = 2)
## End(Not run)
changes_person Get a list of people ids that have been edited.
Description
By default TMDb shows the last 24 hours and only 100 items per page. The maximum number of days that can be returned in a single request is 14.
Usage
changes_person(api_key, page = 1, start_date = NA, end_date = NA)
Arguments
api_key
page
start_date
end_date
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
8 changes_tv Details
The change log system to support this was changed on October 5, 2012 and will only show people that have been edited since.
Value
A list with the following fields:
results
page
total_pages
total_results
Author(s)
Andrea Capozio
References
The IDs of the changed people.
The current page for the results. The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
changes_movie(api_key = api_key, page = 2)
## End(Not run)
changes_tv Get a list of TV show ids that have been edited.
Description
By default TMDb shows the last 24 hours and only 100 items per page. The maximum number of days that can be returned in a single request is 14.
Usage
changes_tv(api_key, page = 1, start_date = NA, end_date = NA)
changes_tv
Arguments
api_key
page
start_date
end_date
Details
9
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
The change log system to properly support TV was updated on May 13, 2014. You’ll likely only find the edits made since then to be useful in the change log system.
Value
A list with the following fields:
results
page
total_pages
total_results
Author(s)
Andrea Capozio
References
The IDs of the changed TV shows. The current page for the results. The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
changes_tv(api_key = api_key, page = 2)
## End(Not run)
10 collection
collection Retrieve informations of a collection.
Description
Get the basic collection information for a specific collection id.
Usage
collection(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The collection ID.
A ISO 639-1 code.
Value
language append_to_response
A list with the following fields:
id
name
overview
poster_path
backdrop_path
parts
Author(s)
Andrea Capozio
References
The ID collection.
The name of the collection. The content of the collection. The poster of the collection. The backdrop of the collection. The items of the collection.
Comma separated, any collection method.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
collection_images 11
collection(api_key, 10, language = "it", append_to_response = "images")
## End(Not run)
collection_images Retrieve images of a collection.
Description
Get all of the images for a particular collection by collection id.
Usage
collection_images(api_key, id, language = NA, append_to_response = NA,
include_image_language = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The collection ID.
A ISO 639-1 code.
language append_to_response
Comma separated, any collection method.
include_image_language
Comma separated, a valid ISO 69-1. Maximum 5 per request.
Details
When include_image_language is present, the API will make an additional request behind the scenes to fetch the data you’re asking for.
Value
A list with the following fields:
id
backdrops
posters
Author(s)
Andrea Capozio
References
The collection ID.
The backdrops of the collection.
Heigth, width, votes of the images of the collection.
12 company Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
collection_images(api_key = api_key, id = 10, language = “it”, include_image_language = “it”) ## End(Not run)
company Retrieve informations of a company.
Description
This method is used to retrieve all of the basic information about a company.
Usage
company(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The company ID. append_to_response
Comma separated, any company method.
Value
A list with the following fields:
description
headquarters
homepage
id
logo_path
name
parent_company
Author(s)
Andrea Capozio
A brief description about the company. The headquarters of the company.
The homepage of the company.
The company ID.
The path of company’s logo The company’s name.
The associated companies.
company_movies 13 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
company(api_key = api_key , id = 1, append_to_response = "movies")
## End(Not run)
company_movies Retrieve movies of a company.
Description
Get the list of movies associated with a particular company.
Usage
company_movies(api_key, id, page = 1, language = NA, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The company ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. append_to_response
Comma separated, any company method.
Value
A list with the following fields:
id page results total_pages total_results
The company ID.
The current page for the results. The company’s movies.
The number of pages for the results. The number of results.
14 configuration Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
company_movies(api_key = api_key, id = 1, page = 1, language = "it",
append_to_response = "movies")
## End(Not run)
configuration Get the system wide configuration information.
Description
This method currently holds the data relevant to building image URLs as well as the change key map.
Usage
configuration(api_key)
Arguments
api_key Your TMDb Consumer Key. Details
To build an image URL, you will need 3 pieces of data. The base_url, size and file_path. Simply combine them all and you will have a fully qualified URL.
Value
The data provided with this method is required for building full image URLs, or getting a list of available image sizes.
credit 15 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
configuration(api_key = api_key)
## End(Not run)
credit Retrieve credits.
Description
Get the detailed information about a particular credit record.
Usage
credit(api_key, credit_id, language = NA)
Arguments
api_key
credit_id
language
Details
Your TMDb Consumer Key. The credit ID.
A ISO 639-1 code.
This is currently only supported with the new credit model found in TV. These ids can be found from any TV credit response as well as the tv_credits and combined_credits methods for people.
16 discover_movie
Value
A list with the following fields:
credit_type
department
job
media
media_type
id
person
Note
The credit’s type.
The section to which a person belongs.
The job of a person.
Name, ID and character associated with the person.
The media’s type.
The credit ID.
Name and ID of the character associated with the person.
The episodes object returns a list of episodes and are generally going to be guest stars. The season array will return a list of season numbers. Season credits are credits that were marked with the “add to every season” option in the editing interface and are assumed to be “season regulars”.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
credit(api_key = api_key, credit_id = "52542282760ee313280017f9", language = "it")
## End(Not run)
discover_movie Retrieve the TMDb movies list.
Description
Discover movies by different types of data like average rating, number of votes, genres and certifi- cations.
discover_movie 17 Usage
discover_movie(api_key, certification_country = NA, certification = NA, certification.lte = NA, include_adult = FALSE, include_video = TRUE,
language = NA, page = 1, primary_release_year = NA, primary_release_date.gte = NA, primary_release_date.lte = NA, release_date.gte = NA, release_date.lte = NA, sort_by = NA, vote_count.gte = NA, vote_count.lte = NA, vote_average.gte = NA, vote_average.lte = NA, with_cast = NA, with_crew = NA, with_companies = NA, with_genres = NA, with_keywords = NA, with_people = NA, year = NA)
Arguments
api_key Your TMDb Consumer Key. certification_country
Only include movies with certifications for a specific country. When this value is specified, ’certification.lte’ is required. A ISO 3166-1 is expected.
certification Only include movies with this certification. Expected value is a valid certifica- tion for the specificed ’certification_country’.
certification.lte
include_adult include_video
language
Only include movies with this certification and lower. Expected value is a valid certification for the specificed ’certification_country’.
Toggle the inclusion of adult titles. Expected value is a boolean, true or false. Default is false.
Toggle the inclusion of items marked as a video. Expected value is a boolean, true or false. Default is true.
A ISO 639-1 code.
The number of the page to show. Minimum 1, maximum 1000.
page primary_release_year
Filter the results so that only the primary release date year has this value. Ex-
pected value is a year.
primary_release_date.gte
Filter by the primary release date and only include those which are greater than
or equal to the specified value. Expected format is YYYY-MM-DD.
primary_release_date.lte
Filter by the primary release date and only include those which are greater than
or equal to the specified value. Expected format is YYYY-MM-DD.
release_date.gte
Filter by all available release dates and only include those which are greater or
equal to the specified value. Expected format is YYYY-MM-DD.
release_date.lte
sort_by
Filter by all available release dates and only include those which are less or equal to the specified value. Expected format is YYYY-MM-DD.
Available options are: popularity.asc, popularity.desc, release_date.asc, release_date.desc, revenue.asc, revenue.desc, primary_release_date.asc, primary_release_date.desc, original_title.asc, original_title.desc, vote_average.asc, vote_average.desc, vote_count.asc, vote_count.desc
18
discover_movie
Filter movies by their vote count and only include movies that have a vote count that is equal to or lower than the specified value.
Filter movies by their vote count and only include movies that have a vote count
that is equal to or lower than the specified value. Expected value is an integer.
Value
vote_count.gte
vote_count.lte
vote_average.gte
Filter movies by their vote average and only include those that have an average rating that is equal to or higher than the specified value. Expected value is a float.
vote_average.lte
with_cast
with_crew
with_companies
with_genres
with_keywords
with_people
year
Filter movies by their vote average and only include those that have an average rating that is equal to or lower than the specified value. Expected value is a float.
Only include movies that have this person id added as a cast member. Expected value is an integer (the id of a person). Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Only include movies that have this person id added as a crew member. Expected value is an integer (the id of a person). Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Filter movies to include a specific company. Expected value is an integer (the id of a company). Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple values can be specified. Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple values can be specified. Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Only include movies that have these person id’s added as a cast or crew mem- ber. Expected value is an integer (the id or ids of a person). Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Filter the results by all available release dates that have the specified value added as a year. Expected value is an integer (year).
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
The current page for the results.
A list of movies that match the query’s parameters. The number of pages for the results.
The number of results.
discover_tv 19 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
discover_movie(api_key = api_key, certification_country = "IT", certification.lte = 16)
## End(Not run)
discover_tv Retrieve the TMDb TV shows list.
Description
Discover TV shows by different types of data like average rating, number of votes, genres, the network they aired on and air dates.
Usage
discover_tv(api_key, page = 1, language = NA, sort_by = NA, first_air_date_year = NA, vote_count.gte = NA, vote_average.gte = NA, with_genres = NA, with_networks = NA, first_air_date.gte = NA, first_air_date.lte = NA)
Arguments
api_key
page
language
sort_by
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000.
A ISO 639-1 code.
Available options are: vote_average.desc, vote_average.asc, first_air_date.desc, first_air_date.asc, popularity.desc, popularity.asc
first_air_date_year
Filter the results release dates to matches that include this value. Expected value is a year.
vote_count.gte Only include TV shows that are equal to, or have a vote count higher than this value. Expected value is an integer.
vote_average.gte
Only include TV shows that are equal to, or have a higher average rating than this value. Expected value is a float.
20
discover_tv
Only include TV shows with the specified genres. Expected value is an integer (the id of a genre). Multiple values can be specified. Comma separated indicates an ’AND’ query, while a pipe (|) separated value indicates an ’OR’.
Filter TV shows to include a specific network. Expected value is an integer (the id of a network). They can be comma separated to indicate an ’AND’ query.
Value
with_genres
with_networks first_air_date.gte
The minimum release to include. Expected format is YYYY-MM-DD.
first_air_date.lte
The maximum release to include. Expected format is YYYY-MM-DD.
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
A list of TV shows that match the query’s parameters. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
discover_tv(api_key = api_key, first_air_date.gte = "2005-01-01", with_networks = 49)
## End(Not run)
find_tmdb 21
find_tmdb Retrieve objects in TMDb database by an external id.
Description
The find method makes it easy to search for objects in our database by an external id. For instance, an IMDB ID. This will search all objects (movies, TV shows and people) and return the results in a single response. TV season and TV episode searches will be supported shortly.
Usage
find_tmdb(api_key, id, external_source, language = NA)
Arguments
api_key id
external_source
language
Value
Your TMDb Consumer Key.
The supported external sources for each object are as follows:
– Movies: imdb_id
– People: imdb_id, freebase_mid, freebase_id, tvrage_id
– Series: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id – TV Seasons: freebase_mid, freebase_id, tvdb_id, tvrage_id
– TV Episodes: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
An external ID, like an IMDB ID. A ISO 639-1 code.
A list with the following fields:
movie_results person_results
The results in the movies department.
The results in the person department.
The results in the tv department.
tv_results tv_episode_results
The results in the tv_episode department.
tv_season_results
Author(s)
Andrea Capozio
References
The results in the tv_season department.
22 genres_movies Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
find_tmdb(api_key = api_key, id = "tt0266543", external_source = "imdb_id")
## End(Not run)
genres_movies Get the list of movies for a particular genre by id.
Description
By default, only movies with 10 or more votes are included.
Usage
genres_movies(api_key, id, page = 1, language = NA, include_all_movies = NA,
include_adult = NA)
Arguments
api_key Your TMDb Consumer Key.
id The movie genre ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. include_all_movies
Toggle the inclusion of all movies and not just those with 10 or more ratings. Expected value is: true or false.
include_adult Toggle the inclusion of adult titles. Expected value is: true or false.
Value
A list with the following fields:
id page results total_pages total_results
The ID genre.
The current page for the results.
The movies belonging to the id genre. The number of pages for the results. The number of results.
genres_movie_list 23 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
genres_movies(api_key = api_key, id = 18, page = 1, include_all_movies = TRUE,
include_adult = TRUE)
## End(Not run)
genres_movie_list Retrieve the available genres for movies.
Description
Get the list of movie genres.
Usage
genres_movie_list(api_key, language = NA)
Arguments
api_key Your TMDb Consumer Key. language A ISO 639-1 code.
Value
A single list item, with the following fields: id The ID of a movie genre.
name The name of a movie genre.
Author(s)
Andrea Capozio
24 genres_tv_list References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
genres_movie_list(api_key = api_key, language = "it")
## End(Not run)
genres_tv_list Retrieve the available genres for TV shows.
Description
Get the list of TV genres.
Usage
genres_tv_list(api_key, language = NA)
Arguments
api_key Your TMDb Consumer Key. language A ISO 639-1 code.
Value
A single list item, with the following fields: id The ID of a TV genre.
name The name of a TV genre. Author(s)
Andrea Capozio
References
jobs 25 Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
genres_tv_list(api_key = api_key, language = "it")
## End(Not run)
jobs Get a list of valid jobs.
Description
Retrieve all the jobs for movies and TV shows splitted by department.
Usage
jobs(api_key)
Arguments
api_key Your TMDb Consumer Key. Value
A single list item, with the following fields:
department The departments involving for a movie/TV show.
job_list The jobs for each department. Author(s)
Andrea Capozio
References
26 keyword Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
jobs(api_key = api_key)
## End(Not run)
keyword Get the basic information for a specific keyword id.
Description
Get the basic information for a specific keyword id.
Usage
keyword(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The keyword ID.
Value
A list with the following fields:
id The keyword ID.
name The text associated with the ID keyword. Author(s)
Andrea Capozio
References
keyword_movies 27 Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
keyword(api_key = api_key, id = "1721")
## End(Not run)
keyword_movies Retrieve movies for keyword.
Description
Get the list of movies for a particular keyword by id.
Usage
keyword_movies(api_key, id, page = 1, language = NA)
Arguments
api_key Your TMDb Consumer Key.
id The keyword ID.
page The number of the page to show. Minimum 1, maximum 1000. language A ISO 639-1 code.
Value
A list with the following fields:
id
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The keyword ID.
The current page for the results.
The movies associated with the keyword ID. The number of pages for the results.
The number of results.
28 list_get Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
keyword_movies(api_key = api_key, id = "1721", page = 9, language = "it")
## End(Not run)
list_get Get a list by id.
Description
Retrieve all the basic information about a list searched by ID.
Usage
list_get(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The list ID.
Value
A list with the following fields:
created_by
description
favorite_count
id
items
item_count
iso_639_1
name
poster_path
Author(s)
Andrea Capozio
The author of the list.
A brief description about the list. The number of favorites.
The list ID.
The elements of the list.
The number of list’s elements. The language of the list.
The name of the list.
The poster of the list.
list_item_status 29 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
list_get(api_key = api_key, id = "509ec17b19c2950a0600050d")
## End(Not run)
list_item_status Verify the presence of a movie in a list.
Description
Check to see if a movie ID is already added to a list.
Usage
list_item_status(api_key, id, movie_id)
Arguments
api_key
id
movie_id
Value
Your TMDb Consumer Key. The list ID.
The movie ID to check.
A list with the following fields: id The list ID.
item_present A logical value that indicates if a movie belongs (TRUE) or not (FALSE) to the list.
Author(s)
Andrea Capozio
References
30 movie Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
list_item_status(api_key = api_key, id = "509ec17b19c2950a0600050d", movie_id = "279")
## End(Not run)
movie Retrieve movie informations.
Description
Get the basic movie information for a specific movie id.
Usage
movie(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The movie ID.
A ISO 639-1 code.
Value
language append_to_response
Comma separated, any movie method.
A list with the following fields:
adult A logical value that indicates if a movie is only for adult people (TRUE) or not (FALSE).
backdrop_path The backdrop of the movie. belong_to_collection
budget genres homepage id imdb_id
The collections to which the movie belongs. The budget for the movie.
The movie’s genre.
The movie’s homepage.
The movie ID.
The movie imdb ID.
movie 31 original_language
original_title overview popularity
The original language of the movie. The original title of the movie.
A brief plot.
An index of the movie’s popularity.
The poster of the movie.
poster_path production_companies
The producer companies.
production_countries
release_data
revenue
runtime
spoken_language
status
tagline
title
video
vote_average
vote_count
Author(s)
Andrea Capozio
References
The countries involved in the production. The data of the release.
The movie’s income.
The length of the movie.
The language spoken in the movie. The movie’s status.
The movie’s tagline.
The movie’s title.
The videos associated to the movie. The average of the votes.
The number of votes.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie(api_key = api_key, id = 550, language = "it")
## End(Not run)
32
Description
movie_alternative_title
movie_alternative_title
Value
Retrieve alternative titles for movies.
Get the alternative titles for a specific movie id.
Usage
movie_alternative_title(api_key, id, country = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The movie ID.
A ISO 3166-1 code.
country append_to_response
Comma separated, any movie method.
A list with the following fields: id The movie ID.
titles The alternative titles of the movie. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_alternative_title(api_key = api_key, id = 550, country = "TW")
## End(Not run)
movie_changes 33
movie_changes Retrieve movie changes.
Description
Get the changes for a specific movie id.
Usage
movie_changes(api_key, id, start_date = NA, end_date = NA)
Arguments
api_key
id
start_date
end_date
Details
Your TMDb Consumer Key.
The movie ID.
The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.
Value
A list with the following field:
changes The type and the object of the change.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_changes(api_key = api_key, id = 28)
34 movie_credits
## End(Not run)
movie_credits Retrieve credits for a movie.
Description
Get the cast and crew information for a specific movie id.
Usage
movie_credits(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key. id The movie ID.
append_to_response
Comma separated, any movie method.
Value
A list with the following fields:
id The movie ID.
cast The cast of the movie. crew The crew of the movie.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_credits(api_key = api_key, id = 550)
## End(Not run)
movie_images 35
movie_images Retrieve movie images.
Description
Get the images (posters and backdrops) for a specific movie id.
Usage
movie_images(api_key, id, language = NA, append_to_response = NA,
include_image_language = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The movie ID.
A ISO 639-1 code.
language append_to_response
A comma separated, any movie method.
include_image_language
A comma separated, a valid ISO 69-1. Maximum 5 per request.
Value
A list with the following fields:
id
backdrops
posters
Author(s)
Andrea Capozio
References
The movie ID.
The backdrops of the movie.
Heigth, width, votes of the images of the movie.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
36
movie_keywords
movie_images(api_key = api_key, id = 550, language = "it") ## End(Not run)
movie_keywords Retrieve the keywords associated with a movie.
Description
Get the plot keywords for a specific movie id.
Usage
movie_keywords(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key. id The movie ID.
append_to_response
Comma separated, any movie method.
Value
A list with the following fields: id The movie ID.
keywords The keywords associated to the movie. Author(s)
Andrea Capozio
References
Examples
## Not run: ## An example of an authenticated request, ## where api_key is fictitious. ## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key" movie_keywords(api_key = api_key, id = 550) ## End(Not run)
movie_latest
movie_latest
Description
Get the latest movie ID.
Usage
movie_latest(api_key)
Arguments
37
budget genres homepage id
The collections to which the movie belongs. The budget for the movie.
The movie’s genre.
The movie’s homepage.
The movie ID.
The movie imdb ID.
imdb_id original_language
original_title overview popularity
The original language of the movie. The original title of the movie.
A brief plot.
An index of the movie’s popularity.
The poster of the movie.
poster_path production_companies
The producer companies.
production_countries
release_data revenue runtime
The countries involved in the production. The data of the release.
The movie’s income.
The length of the movie.
Retrieve the latest movie inserted in TMDb.
api_key Your TMDb Consumer Key.
Value
A list with the following fields:
adult A logical value that indicates if a movie is only for adult people (TRUE) or not (FALSE).
backdrop_path The backdrop of the movie. belong_to_collection
38
movie_lists
spoken_language
status tagline title video vote_average vote_count
The language spoken in the movie. The movie’s status.
The movie’s tagline.
The movie’s title.
The videos associated to the movie. The average of the votes.
The number of votes.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_latest(api_key = api_key)
## End(Not run)
movie_lists Retrieve the lists that the movie belongs to.
Description
Get the lists in which there is a particular movie.
Usage
movie_lists(api_key, id, page = 1, language = NA, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The movie ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. append_to_response
A comma separated, any movie method.
movie_now_playing 39
Value
A list with the following fields:
id
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The movie ID.
The current page for the results. The lists containing the movie.
The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_lists(api_key = api_key, id = 578)
## End(Not run)
movie_now_playing Retrieve movies in theatres in the current week.
Description
Get the list of movies playing that have been, or are being released this week. This list refreshes every day.
Usage
movie_now_playing(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
40 movie_popular
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The movies now in theaters, with a brief description. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_now_playing(api_key = api_key, page = 2, language = "it")
## End(Not run)
movie_popular Retrieve the popular movies.
Description
Get the list of popular movies on The Movie Database. This list refreshes every day.
Usage
movie_popular(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
movie_releases 41
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The most popular movies, with a brief description. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_popular(api_key = api_key, page = 2, language = "en")
## End(Not run)
movie_releases Retrieve the release informations for a movie.
Description
Get the release date and certification information by country for a specific movie id.
Usage
movie_releases(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The movie ID. append_to_response
Comma separated, any movie method.
42 movie_reviews
Value
A list with the following fields: id The movie ID.
countries The release dates in several countries. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_releases(api_key = api_key, id = 578, append_to_response = "credits")
## End(Not run)
movie_reviews Retrieve movie reviews.
Description
Get the reviews for a particular movie id.
Usage
movie_reviews(api_key, id, page = 1, language = NA, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The movie ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. append_to_response
A comma separated, any movie method.
movie_similar 43
Value
A list with the following fields:
id
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The movie ID.
The current page for the results. The reviews about the movie.
The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
movie_reviews(api_key, id = 578, page = 2, language = “de”, append_to_response = “credits”) ## End(Not run)
movie_similar Retrieve similar movies.
Description
Get the similar movies for a specific movie id.
Usage
movie_similar(api_key, id, page = 1, language = NA, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The movie ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. append_to_response
A comma separated, any movie method.
44 movie_top_rated
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The similar movies, with a brief description. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
movie_similar(api_key = api_key, id = 578, language = “de”, append_to_response = “credits”) ## End(Not run)
movie_top_rated Retrieve top rated movies.
Description
Get the list of top rated movies. By default, this list will only include movies that have 10 or more votes. This list refreshes every day.
Usage
movie_top_rated(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
movie_translations 45
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
A list of top-rated movies, with a brief description. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_top_rated(api_key = api_key, page = 155, language = "en")
## End(Not run)
movie_translations Retrieve the available translations for a movie.
Description
Get the translations for a specific movie id.
Usage
movie_translations(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The movie ID.
A ISO 639-1 code.
language append_to_response
Comma separated, any movie method.
46 movie_upcoming Value
A list with the following fields: id The movie ID.
translations The available translations of the movie. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
movie_translations(api_key = api_key, id = 578, language = “en”, append_to_response = “credits”) ## End(Not run)
movie_upcoming Retrieve upcoming movies.
Description
Get the list of upcoming movies by release date. This list refreshes every day.
Usage
movie_upcoming(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
movie_videos 47
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The upcoming movies now in theaters, with the basic informations. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
movie_upcoming(api_key = api_key, page = 6, language = "it")
## End(Not run)
movie_videos Retrieve movie videos.
Description
Get the videos (trailers, teasers, clips, etc…) for a specific movie id.
Usage
movie_videos(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The movie ID.
A ISO 639-1 code.
language append_to_response
Comma separated, any movie method.
48 network
Value
A list with the following fields: id The movie ID.
results The videos associated with the movie. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
movie_videos(api_key = api_key, id = 578, language = “en”, append_to_response = “credits”) ## End(Not run)
network Get the name of a TV network by ID.
Description
Retrieve the name of a TV network.
Usage
network(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The network ID.
Value
A list with the following fields:
id The network ID. name The name of network.
person_changes 49 Note
Use this ID to search for TV shows with the discover method.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
network(api_key = api_key, id = 49)
## End(Not run)
person_changes Retrieve the changes for a person.
Description
Get the changes for a specific person id.
Usage
person_changes(api_key, id, start_date = NA, end_date = NA)
Arguments
api_key
id
start_date
end_date
Details
Your TMDb Consumer Key.
The person ID.
The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.
50 person_combined_credits Value
A list with the following fields:
changes The type and the object of the change.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_changes(api_key = api_key, id = 1245)
## End(Not run)
person_combined_credits
Retrieve credits for a person.
Description
Get the combined (movie and TV) credits for a specific person id.
Usage
person_combined_credits(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The person ID.
A ISO 639-1 code.
language append_to_response
Comma separated, any person method.
person_external_ids 51 Details
To get the expanded details for each TV record, call the /credit method with the provided credit_id. This will provide details about which episode and/or season the credit is for.
Value
A list with the following fields:
cast The movies/tv shows in which the person has played.
crew The movies/tv shows in which the person has had crew roles. id The person ID.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_combined_credits(api_key = api_key, id = 287)
## End(Not run)
person_external_ids Retrieve external ids for a person.
Description
Get the external ids for a specific person id.
Usage
person_external_ids(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The person ID.
52 person_images
Value
A list with the following fields:
imdb_id
freebase_mid
freebase_id
tvrage_id
id
Author(s)
Andrea Capozio
References
The person imdb ID.
The person freebase_mid ID. The person freebsae ID.
The person tvrage ID.
The person TMDb ID.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_external_ids(api_key = api_key, id = 287)
## End(Not run)
person_images Retrieve person images.
Description
Get the images for a specific person id.
Usage
person_images(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The person ID.
person_latest 53 Value
A list with the following fields: id The person ID.
profiles The images of the person. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_images(api_key = api_key, id = 287)
## End(Not run)
person_latest Retrieve new entry people on TMDb.
Description
Get the latest person id.
Usage
person_latest(api_key, page = 1)
Arguments
api_key Your TMDb Consumer Key.
page The number of the page to show. Minimum 1, maximum 1000.
54 person_latest
Value
A list with the following fields:
adult
also_known_as
biography
birthday
deathday
homepage
id
imdb_id
name
place_of_birth
popularity
profile_path
Author(s)
Andrea Capozio
References
A logical value that indicates if a person plays movie for adult (TRUE) or not (FALSE).
The artistic name.
The person’s biography.
The person’s birthday.
The person’s (eventual) deathday. The person’s homepage.
The person ID.
The person imdb id.
The person’s name.
Where the person was born.
An index of the person’s popularity. The person’s profile path.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_latest(api_key = api_key)
## End(Not run)
person_movie_credits 55
person_movie_credits Retrieve person movie credits.
Description
Get the movie credits for a specific person id.
Usage
person_movie_credits(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The person ID.
A ISO 639-1 code.
Value
language append_to_response
Comma separated, any person method.
A list with the following fields:
cast The movies in which the person has played.
crew The movies in which the person has had crew roles. id The person ID.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_movie_credits(api_key = api_key, id = 287)
## End(Not run)
56 person_popular
person_popular Retrieve the popular people.
Description
Get the list of popular people on TMDb.
Usage
person_popular(api_key, page = 1)
Arguments
api_key Your TMDb Consumer Key.
page The number of the page to show. Minimum 1, maximum 1000.
Details
This list refreshes every day.
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The most popular people, with a brief description. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_popular(api_key = api_key)
## End(Not run)
person_tagged_images 57
person_tagged_images Retrieve images related to a person.
Description
Get the images that have been tagged with a specific person id.
Usage
person_tagged_images(api_key, id, page = 1, language = NA)
Arguments
api_key Your TMDb Consumer Key.
id The person ID.
page The number of the page to show. Minimum 1, maximum 1000. language A ISO 639-1 code.
Details
Return all of the image results with a media object mapped for each image.
Value
A list with the following fields:
id
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The person ID.
The current page for the results.
Heigth, width, voted of the images related to the person, with a brief description. The number of pages for the results.
The number of results.
58 person_tmdb Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_tagged_images(api_key = api_key, id = 287)
## End(Not run)
person_tmdb Retrieve person information.
Description
Get the general person information for a specific id.
Usage
person_tmdb(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The person ID. append_to_response
Comma separated, any person method.
Value
A list with the following fields:
adult
also_known_as biography birthday deathday homepage
id imdb_id name place_of_birth popularity profile_path
A logical value that indicates if a person plays movie for adult (TRUE) or not (FALSE).
The artistic name.
The person’s biography.
The person’s birthday.
The person’s (eventual) deathday. The person’s homepage.
The person ID.
The person imdb id.
The person’s name.
Where the person was born.
An index of the person’s popularity. The person’s profile path.
person_tv_credits 59 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_tmdb(api_key = api_key, id = 287, append_to_response = "latest")
## End(Not run)
person_tv_credits Retrieve person TV credits.
Description
Get the TV credits for a specific person id.
Usage
person_tv_credits(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The person ID.
A ISO 639-1 code.
Value
language append_to_response
Comma separated, any person method.
A list with the following fields:
cast The tv shows in which the person has played.
crew The tv shows in which the person has had crew roles. id The person ID.
60 review Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
person_tv_credits(api_key = api_key, id = 287)
## End(Not run)
review Retrieve basic informations about a review.
Description
Get the full details of a review by ID.
Usage
review(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The review ID.
Value
A list with the following fields:
id author content iso_639_1 media_id media_title media_type url
The review ID.
The review’s author.
The review’text.
The review’s language.
The ID of the reviewed object. The object’s title.
The type of the reviewed object. The url of the review.
search_collection 61 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
review(api_key = api_key, id = "5013bc76760ee372cb00253e")
## End(Not run)
search_collection Search for lists by name and description.
Description
Retrieve all the company ID that match (entirely or partially) the query.
Usage
search_collection(api_key, query, page = 1, language = NA)
Arguments
api_key
query
page
language
Value
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
A list with the following fields:
page results total_pages total_results
The current page for the results.
The collections that match the query. The number of pages for the results. The number of results.
62 search_company Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_collection(api_key = api_key, query = "Marvel", language = "it")
## End(Not run)
search_company Search for companies by name.
Description
Retrieve all the company ID that match (entirely or partially) the query.
Usage
search_company(api_key, query, page = 1)
Arguments
api_key
query
page
Value
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000.
A list with the following fields:
page results total_pages total_results
The current page for the results.
The companies that match the query. The number of pages for the results. The number of results.
search_keyword 63 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_company(api_key = api_key, query = "Fox")
## End(Not run)
search_keyword Search for keywords by name.
Description
Retrieve all the TMDb ID that match (entirely or partially) the query.
Usage
search_keyword(api_key, query, page = 1)
Arguments
api_key
query
page
Value
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000.
A list with the following fields:
page results total_pages total_results
The current page for the results. The keywords that match the query. The number of pages for the results. The number of results.
64 search_list Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_keyword(api_key = api_key, query = "furious")
## End(Not run)
search_list Search for lists by name and description.
Description
Retrieve all the list ID that match (entirely or partially) the query.
Usage
search_list(api_key, query, page = 1, include_adult = NA)
Arguments
api_key
query
page
include_adult
Value
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. Toggle the inclusion of adult titles. Expected value is: true or false
A list with the following fields:
page results total_pages total_results
The current page for the results. The lists that match the query.
The number of pages for the results. The number of results.
search_movie 65 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_list(api_key = api_key, query = "marvel")
## End(Not run)
search_movie Search for movies by title.
Description
Retrieve all the movie ID that match the query.
Usage
search_movie(api_key, query, page = 1, include_adult = NA, language = NA, year = NA, primary_release_year = NA, search_type = “phrase”)
Arguments
api_key
query
page
include_adult
language
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. Toggle the inclusion of adult titles. Expected value is: true or false. A ISO 639-1 code.
Filter the results release dates to matches that include this value. Filter the results so that only the primary release dates have this value.
search_type By default, the search type is ’phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ’ngram’.
year primary_release_year
66 search_multi
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results. The movies that match the query. The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_movie(api_key = api_key, query = "star wars")
## End(Not run)
search_multi Search the movie, TV show and person collections with a single query.
Description
Each item returned in the result array has a media_type field that maps to either movie, TV show or person. Each mapped result is the same response you would get from each independent search.
Usage
search_multi(api_key, query, page = 1, include_adult = NA, language = NA)
Arguments
api_key
query
page
include_adult
language
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. Toggle the inclusion of adult titles. Expected value is: true or false. A ISO 639-1 code.
search_person 67
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The movies, TV shows and people that match the query. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_multi(api_key = api_key, query = "star wars")
## End(Not run)
search_person Search for people by name.
Description
Retrieve all the person IDs that match (entirely or partially) the query.
Usage
search_person(api_key, query, page = 1, include_adult = NA, search_type = “phrase”)
Arguments
api_key
query
page
include_adult
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. Toggle the inclusion of adult titles. Expected value is: true or false
68
search_tv
By default, the search type is ’phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ’ngram’.
Value
search_type
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results. The people that match the query. The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_person(api_key = api_key, query = "Megan Fox")
## End(Not run)
search_tv Search for TV shows by title.
Description
Retrieve all the TV shows ID that match (entirely or partially) the query.
Usage
search_tv(api_key, query, page = 1, language = NA, first_air_date_year = NA,
search_type = "phrase")
search_tv
Arguments
api_key
query
page
69
language first_air_date_year
search_type
Value
By default, the search type is ’phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ’ngram’.
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results. The TV shows that match the query. The number of pages for the results. The number of results.
Your TMDb Consumer Key.
A CGI escaped string.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
Filter the results to only match shows that have a air date with with value.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
search_tv(api_key = api_key, query = "Game of Thrones")
## End(Not run)
70 timezone
timezone Retrieve the supported timezones.
Description
Get the list of supported timezones for the API methods that support them.
Usage
timezone(api_key)
Arguments
api_key Your TMDb Consumer Key. Value
A data.frame with the supported timezones.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
timezone(api_key = api_key)
## End(Not run)
tv 71
tv Retrieve TV informations.
Description
Get the primary information about a TV series by id.
Usage
tv(api_key, id, language = NA, append_to_response = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The TV series ID.
A ISO 639-1 code.
Value
language append_to_response
first_air_date genres homepage id in_production
languages last_air_date name
The length of an episode.
The first day when TV show begun.
The TV show’s genre.
The TV show’s homepage.
The TV show ID.
A logical value that indicates if a TV shows is in production (TRUE) or not (FALSE).
A list of available languages.
The last day when TV show ended. The TV show name.
The companies involved with the TV show.
networks number_of_episodes
Comma separated, any TV series method.
A list with the following fields:
backdrop_path The backdrop of the TV show.
created_by The author of the TV show. episode_run_time
The number of episodes of the TV show.
number_of_seasons
The number of seasons of the TV show. origin_country The country where TV show is produced.
72
tv_airing_today
original_language
original_name overview popularity
The original language of the TV show. The original name of the TV show.
A brief plot.
An index of the TV show’s popularity.
The poster of the TV show.
poster_path production_companies
seasons status type vote_average vote_count
The producer companies. The TV show’s seasons. The TV show’s status. The TV show’s type. The average of the votes. The number of votes.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv(api_key = api_key, id = 1396)
## End(Not run)
tv_airing_today Retrieve TV shows on air.
Description
Get the list of TV shows that air today.
Usage
tv_airing_today(api_key, page = 1, language = NA, timezone = NA)
tv_airing_today
Arguments
api_key
page
language
timezone
Details
73
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
Valid value from the list of timezones.
Without a specified timezone, this query defaults to EST (Eastern Time UTC-05:00).
Value
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results.
The TV shows that are on air in the current day. The number of pages for the results.
The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_on_the_air(api_key = api_key)
## End(Not run)
74 tv_alternative_title
tv_alternative_title Retrieve alternative titles for TV series.
Description
Get the alternative titles for a specific TV show id.
Usage
tv_alternative_title(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The TV series ID.
Value
A list with the following fields:
id The TV series ID.
results The alternative titles of the TV show. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_alternative_title(api_key = api_key, id = 1396)
## End(Not run)
tv_changes 75
tv_changes Retrieve TV series changes.
Description
Get the changes for a specific TV show id.
Usage
tv_changes(api_key, id, start_date = NA, end_date = NA)
Arguments
api_key
id
start_date
end_date
Details
Your TMDb Consumer Key.
The TV show ID.
The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.
Value
A list with the following field:
changes The type and the object of the change.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_changes(api_key = api_key, id = 1396)
76 tv_content_ratings
## End(Not run)
tv_content_ratings Retrieve rating for a TV series.
Description
Get the content ratings for a specific TV show id.
Usage
tv_content_ratings(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The TV show ID.
Value
A list with the following fields:
results The available ratings for the TV show.
id The TV shows ID. Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_content_ratings(api_key = api_key, id = 1396)
## End(Not run)
tv_credits 77
tv_credits Retrieve credits for a TV series.
Description
Get the cast & crew information about a TV series. Just like the website, TMDb pulls this informa- tion from the last season of the series.
Usage
tv_credits(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The TV show ID. append_to_response
Comma separated, any TV series method.
Value
A list with the following fields:
id The TV show ID.
cast The cast of the TV show. crew The crew of the TV show.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_credits(api_key = api_key, id = 1396)
## End(Not run)
78 tv_episode
tv_episode Retrieve basic informations about a TV episode.
Description
Get the primary information about a TV episode by combination of a season and episode number.
Usage
tv_episode(api_key, id, season_number, episode_number, language = NA,
append_to_response = NA)
Arguments
api_key
id
season_number
episode_number
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the TV show ID. The episode number refered to the TV show ID.
Value
language append_to_response
A list with the following fields:
air_date
crew
episode_number
guest_stars
name
overview
id
production_code
season_number
still_path
vote_average
vote_count
Author(s)
Andrea Capozio
when an episode is aired.
The crew of the TV episode.
The episode number of the TV episode. The guest stars of the TV episode.
The TV episode title.
A brief plot.
The TV episode ID.
The production code.
The season number of the TV episode. The image’s path.
The average of the votes.
The number of votes.
A ISO 639-1 code.
Comma separated, any TV series method.
tv_episode_changes 79 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_episode(api_key = api_key, id = 1396, season_number = 4, episode_number = 4)
## End(Not run)
tv_episode_changes Retrieve the changes for an episode TV show.
Description
Look up a TV episode’s changes by episode ID.
Usage
tv_episode_changes(api_key, id, start_date = NA, end_date = NA)
Arguments
api_key
id
start_date
end_date
Details
Your TMDb Consumer Key.
The TV show ID.
The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
This method is used in conjunction with the /tv/id/changes method. This method uses the episode_id value found in the change entries.
Value
A list with the following fields:
changes The type and the object of the change.
Author(s)
Andrea Capozio
80 tv_episode_credits References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_episode_changes(api_key = api_key, id = 63080)
## End(Not run)
tv_episode_credits Retrieve TV episode credits.
Description
Get the TV episode credits by combination of season and episode number.
Usage
tv_episode_credits(api_key, id, season_number, episode_number)
Arguments
api_key
id
season_number
episode_number
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the TV show ID. The episode number refered to the TV show ID.
A list with the following fields:
cast The cast of the TV episode.
crew The crew of the TV episode. guest_stars The guest stars of the TV episode. id The TV episode ID.
Author(s)
Andrea Capozio
tv_episode_external_ids 81 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_episode_credits(api_key = api_key, id = 1396, season_number = 4, episode_number = 4)
## End(Not run)
tv_episode_external_ids
Retrieve external ids for a TV episode.
Description
Get the external ids for a TV episode by comabination of a season and episode number.
Usage
tv_episode_external_ids(api_key, id, season_number, episode_number, language = NA)
Arguments
api_key
id
season_number
episode_number
language
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the TV show ID. The episode number refered to the TV show ID. A ISO 639-1 code.
A list with the following fields:
imdb_id freebase_mid freebase_id tvdb_id tvrage_id
id
The TV episode imdb ID.
The TV episode freebase_mid ID. The TV episode freebsae ID.
The TV episode tvdb ID.
The TV episode tvrage ID.
The TV episode TMDb ID.
82 tv_episode_images Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- “key”
tv_episode_external_ids(api_key = api_key, id = 1396, season_number = 4, episode_number = 4) ## End(Not run)
tv_episode_images Retrieve TV episode images.
Description
Get the images (episode stills) for a TV episode by combination of a season and episode number. Since episode stills don’t have a language, this call will always return all images.
Usage
tv_episode_images(api_key, id, season_number, episode_number)
Arguments
api_key
id
season_number
episode_number
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the TV show ID. The episode number refered to the TV show ID.
A list with the following fields:
id The TV episode ID.
stills Heigth, width, votes of the images of the TV episode.
tv_episode_videos 83 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_episode_images(api_key = api_key, id = 1396, season_number = 1, episode_number = 1)
## End(Not run)
tv_episode_videos Retrieve TV show videos related.
Description
Get the videos that have been added to a TV episode (teasers, clips, etc…)
Usage
tv_episode_videos(api_key, id, season_number, episode_number, language = NA)
Arguments
api_key
id
season_number
episode_number
language
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the TV show ID. The episode number refered to the TV show ID. A ISO 639-1 code.
A list with the following fields:
id The TV episode ID.
results The videos associated with the TV episode.
84 tv_external_ids Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_episode_videos(api_key = api_key, id = 62161, season_number = 1, episode_number = 2)
## End(Not run)
tv_external_ids Retrieve external ids for a TV series.
Description
Get the external ids stored in TMDb for a TV series.
Usage
tv_external_ids(api_key, id, language = NA)
Arguments
api_key
id
language
Value
Your TMDb Consumer Key. The tv show ID.
A ISO 639-1 code.
A list with the following fields:
imdb_id freebase_mid freebase_id tvdb_id tvrage_id
id
The TV show imdb ID.
The TV show freebase_mid ID. The TV show freebsae ID.
The TV show tvdb ID.
The TV show tvrage ID.
The TV show TMDb ID.
tv_images 85 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_external_ids(api_key = api_key, id = 1396)
## End(Not run)
tv_images Retrieve TV series images.
Description
Get the images (posters and backdrops) for a TV series.
Usage
tv_images(api_key, id, language = NA, include_image_language = NA)
Arguments
api_key id
Your TMDb Consumer Key.
The TV series ID.
A ISO 639-1 code.
Value
language include_image_language
A list with the following fields:
id backdrops posters
The TV show ID.
The backdrops of the TV show.
Heigth, width, votes of the images of the TV show.
A comma separated, a valid ISO 69-1. Maximum 5 per request.
86 tv_keywords Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_images(api_key = api_key, id = 1396)
## End(Not run)
tv_keywords Retrieve the keywords associated with a TV show.
Description
Get the plot keywords for a specific TV show id.
Usage
tv_keywords(api_key, id, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The TV series ID. append_to_response
Comma separated, any TV series method.
Value
A list with the following fields:
id The TV show ID.
results The keywords associated to the TV show.
Author(s)
Andrea Capozio
tv_latest 87 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_keywords(api_key = api_key, id = 1396)
## End(Not run)
tv_latest
Description
Get the latest TV show id.
Usage
tv_latest(api_key)
Arguments
Retrieve the latest TV show inserted in TMDb.
api_key Your TMDb Consumer Key.
Value
A list with the following fields:
backdrop_path The backdrop of the TV show.
created_by The author of the TV show. episode_run_time
first_air_date genres homepage id in_production
languages
The length of an episode.
the first time that TV show is aired
The TV show’s genre.
The TV show’s homepage.
The TV show ID.
A logical value that indicates if a TV shows is in production (TRUE) or not (FALSE).
A list of available languages.
88
tv_latest
last_air_date name
The last day when TV show ended.
The TV show name.
The companies involved with the TV show.
networks number_of_episodes
The number of episodes of the TV show.
number_of_seasons
The number of seasons of the TV show.
origin_country The country where TV show is produced. original_language
original_name overview popularity
The original language of the TV show. The original name of the TV show.
A brief plot.
An index of the TV show’s popularity.
The poster of the TV show.
poster_path production_companies
seasons status type vote_average vote_count
The producer companies. The TV show’s seasons. The TV show’s status. The TV show’s type. The average of the votes. The number of votes.
Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_latest(api_key = api_key)
## End(Not run)
tv_on_the_air 89
tv_on_the_air Get the list of TV shows that are currently on the air.
Description
This query looks for any TV show that has an episode with an air date in the next 7 days.
Usage
tv_on_the_air(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Value
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results. The TV shows that are on air.
The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_on_the_air(api_key = api_key)
## End(Not run)
90 tv_popular
tv_popular Retrieve the popular TV series.
Description
Get the list of popular TV shows. This list refreshes every day.
Usage
tv_popular(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Value
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
A list with the following fields:
page
results
total_pages
total_results
Author(s)
Andrea Capozio
References
The current page for the results. The most popular TV shows.
The number of pages for the results. The number of results.
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_popular(api_key = api_key)
## End(Not run)
tv_season 91
tv_season Retrieve basic informations about a TV season.
Description
Get the primary information about a TV season by its season number.
Usage
tv_season(api_key, id, season_number, language = NA, append_to_response = NA)
Arguments
api_key
id
season_number
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the ID. A ISO 639-1 code.
Comma separated, any tv season method.
language
append_to_response
Value
A list with the following fields:
air_date
episodes
name
overview
id
poster_path
season_number
Author(s)
Andrea Capozio
References
when a season is aired.
A list with the season episodes: dates, crews, guest stars, overviews, titles. The TV season title.
A brief plot.
The season ID.
The image’s path.
The season number.
92 tv_season_changes Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season(api_key = api_key, id = 1396, season_number = 3)
## End(Not run)
tv_season_changes Retrieve the changes for a season TV show.
Description
Look up a TV season’s changes by season ID.
Usage
tv_season_changes(api_key, id, start_date = NA, end_date = NA)
Arguments
api_key
id
start_date
end_date
Details
Your TMDb Consumer Key.
The TV show ID.
The date starting from which to search. Format YYYY-MM-DD. The date until which to search. Format YYYY-MM-DD.
This method is used in conjunction with the /tv/id/changes method. This method uses the season_id value found in the change entries.
Value
A list with the following fields:
changes The type and the object of the change.
Author(s)
Andrea Capozio
References
tv_season_credits 93 Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season_changes(api_key = api_key , id = 3626)
## End(Not run)
tv_season_credits Retrieve TV season credits.
Description
Get the cast & crew credits for a TV season by season number.
Usage
tv_season_credits(api_key, id, season_number)
Arguments
api_key
id
season_number
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the ID.
A list with the following fields:
cast The cast of the TV season. crew The crew of the TV season. id The TV season ID.
Author(s)
Andrea Capozio
References
94 tv_season_external_ids Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season_credits(api_key = api_key, id = 1396, season_number = 3)
## End(Not run)
tv_season_external_ids
Description
Retrieve external ids for a TV season.
Get the external ids that we have stored for a TV season by season number.
Usage
tv_season_external_ids(api_key, id, season_number, language = NA)
Arguments
api_key
id
season_number
language
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the ID. A ISO 639-1 code.
A list with the following fields:
freebase_mid
freebase_id
tvdb_id
tvrage_id
id
Author(s)
Andrea Capozio
The TV season freebase_mid ID. The TV season freebsae ID.
The TV season tvdb ID.
The TV season tvrage ID.
The TV season TMDb ID.
tv_season_images 95 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season_external_ids(api_key = api_key, id = 1396, season_number = 3)
## End(Not run)
tv_season_images Retrieve TV season images.
Description
Get the images (posters) stored for a TV season by season number.
Usage
tv_season_images(api_key, id, season_number, language = NA, include_image_language = NA)
Arguments
api_key
id
season_number
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the ID.
Value
language include_image_language
A ISO 639-1 code.
Comma separated, a valid ISO 69-1. Maximum 5 per request.
A list with the following fields:
id The TV season ID.
posters Heigth, width, votes of the images of the TV season.
Author(s)
Andrea Capozio
96 tv_season_videos References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season_images(api_key = api_key, id = 1396, season_number = 2, language = "en",
include_image_language = "en")
## End(Not run)
tv_season_videos Retrieve TV show videos related.
Description
Get the videos that have been added to a TV season (trailers, teasers, etc…)
Usage
tv_season_videos(api_key, id, season_number, language = NA)
Arguments
api_key
id
season_number
language
Value
Your TMDb Consumer Key.
The TV show ID.
The season number refered to the ID. A ISO 639-1 code.
A list with the following fields:
id The TV season ID.
results The videos associated with the TV season.
Author(s)
Andrea Capozio
tv_similar 97 References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_season_videos(api_key = api_key, id = 1396, season_number = 5, language = "en")
## End(Not run)
tv_similar Retrieve similar TV show.
Description
Get the similar TV shows for a specific tv id.
Usage
tv_similar(api_key, id, page = 1, language = NA, append_to_response = NA)
Arguments
api_key Your TMDb Consumer Key.
id The TV series ID.
page The number of the page to show. Minimum 1, maximum 1000.
language A ISO 639-1 code. append_to_response
A comma separated, any TV series method.
Value
A list with the following fields:
page results total_pages total_results
The current page for the results. The similar TV shows.
The number of pages for the results. The number of results.
98 tv_top_rated Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_similar(api_key = api_key, id = 1396)
## End(Not run)
tv_top_rated Retrieve top rated TV series.
Description
Get the list of top rated TV shows. By default, this list will only include TV shows that have 2 or more votes. This list refreshes every day.
Usage
tv_top_rated(api_key, page = 1, language = NA)
Arguments
api_key
page
language
Value
Your TMDb Consumer Key.
The number of the page to show. Minimum 1, maximum 1000. A ISO 639-1 code.
A list with the following fields:
page results total_pages total_results
The current page for the results. The top rated TV shows.
The number of pages for the results. The number of results.
tv_translations 99 Author(s)
Andrea Capozio
References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_top_rated(api_key = api_key)
## End(Not run)
tv_translations Retrieve the available translations for a TV series.
Description
Get the list of translations that exist for a TV series. These translations cascade down to the episode level.
Usage
tv_translations(api_key, id)
Arguments
api_key Your TMDb Consumer Key. id The TV series ID.
Value
A list with the following fields:
id The TV show ID.
translations The available translations of the TV show.
Author(s)
Andrea Capozio
100 tv_videos References
Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_translations(api_key = api_key, id = 1396)
## End(Not run)
tv_videos Retrieve TV series videos.
Description
Get the videos that have been added to a TV series (trailers, opening credits, etc…).
Usage
tv_videos(api_key, id, language = NA)
Arguments
api_key
id
language
Value
Your TMDb Consumer Key. The TV series ID.
A ISO 639-1 code.
A list with the following fields:
id The TV show ID.
results The videos associated with the TV show. Author(s)
Andrea Capozio
References
tv_videos 101 Examples
## Not run:
## An example of an authenticated request,
## where api_key is fictitious.
## You can obtain your own at https://www.themoviedb.org/documentation/api
api_key <- "key"
tv_videos(api_key = api_key, id = 1396)
## End(Not run)
Index
∗ certification_movies certification_movie_list, 4
∗ certification_tv_shows certification_tv_list, 5
∗ changes_movie changes_movie, 6
∗ changes_person changes_person, 7
∗ changes_tv changes_tv, 8
∗ collection_images collection_images, 11
∗ collection collection, 10
∗ company_movies company_movies, 13
∗ company company, 12
∗ configuration configuration, 14
∗ credit credit, 15
∗ discover_movie discover_movie, 16
∗ discover_tv discover_tv, 19
∗ find_tmdb find_tmdb, 21
∗ genres_movie_list genres_movie_list, 23
∗ genres_movie genres_movies, 22
∗ genres_tv_list genres_tv_list, 24
∗ jobs
jobs, 25
∗ keyword_movies keyword_movies, 27
∗ keyword
keyword, 26 ∗ list_get
list_get, 28 ∗ list_item_status
list_item_status, 29 ∗ movie_alternative_title
movie_alternative_title, 32 ∗ movie_changes
movie_changes, 33 ∗ movie_credits
movie_credits, 34 ∗ movie_images
movie_images, 35 ∗ movie_keyword
movie_keywords, 36 ∗ movie_latest
movie_latest, 37 ∗ movie_lists
movie_lists, 38 ∗ movie_now_playing
movie_now_playing, 39 ∗ movie_popular
movie_popular, 40 ∗ movie_releases
movie_releases, 41 ∗ movie_reviews
movie_reviews, 42 ∗ movie_similar
movie_similar, 43 ∗ movie_top_rated
movie_top_rated, 44 ∗ movie_translations
movie_translations, 45 ∗ movie_upcoming
movie_upcoming, 46 ∗ movie_videos
movie_videos, 47 ∗ movie
movie, 30
102
INDEX
∗ network network, 48
∗ person_changes person_changes, 49
∗ person_combined_credits person_combined_credits, 50
∗ person_external_ids person_external_ids, 51
∗ person_images person_images, 52
∗ person_latest person_latest, 53
∗ person_movie_credits person_movie_credits, 55
∗ person_popular person_popular, 56
∗ person_tagged_images person_tagged_images, 57
∗ person_tmdb person_tmdb, 58
∗ person_tv_credits person_tv_credits, 59
∗ review review, 60
∗ search_collection search_collection, 61
∗ search_company search_company, 62
∗ search_keyword search_keyword, 63
∗ search_list search_list, 64
∗ search_movie search_movie, 65
∗ search_multi search_multi, 66
∗ search_person search_person, 67
∗ search_tv search_tv, 68
∗ timezone timezone, 70
∗ tv_airing_today tv_airing_today, 72
∗ tv_alternative_title tv_alternative_title, 74
∗ tv_changes tv_changes, 75
103
∗ tv_content_ratings tv_content_ratings, 76
∗ tv_credits tv_credits, 77
∗ tv_episode_changes tv_episode_changes, 79
∗ tv_episode_credits tv_episode_credits, 80
∗ tv_episode_external_ids tv_episode_external_ids, 81
∗ tv_episode_images tv_episode_images, 82
∗ tv_episode_videos tv_episode_videos, 83
∗ tv_episode tv_episode, 78
∗ tv_external_ids tv_external_ids, 84
∗ tv_images tv_images, 85
∗ tv_keywords tv_keywords, 86
∗ tv_latest tv_latest, 87
∗ tv_on_the_air tv_on_the_air, 89
∗ tv_popular tv_popular, 90
∗ tv_season_changes tv_season_changes, 92
∗ tv_season_credits tv_season_credits, 93
∗ tv_season_external_ids tv_season_external_ids, 94
∗ tv_season_images tv_season_images, 95
∗ tv_season_videos tv_season_videos, 96
∗ tv_season tv_season, 91
∗ tv_similar tv_similar, 97
∗ tv_top_rated tv_top_rated, 98
∗ tv_translations tv_translations, 99
∗ tv_videos tv_videos, 100
104
∗ tv
tv, 71
certification_movie_list, 4 certification_tv_list, 5 changes_movie, 6 changes_person, 7 changes_tv, 8
collection, 10 collection_images, 11 company, 12 company_movies, 13 configuration, 14 credit, 15
discover_movie, 16 discover_tv, 19
find_tmdb, 21
genres_movie_list, 23 genres_movies, 22 genres_tv_list, 24
jobs, 25 keyword, 26
keyword_movies, 27 list_get, 28
list_item_status, 29
movie, 30 movie_alternative_title, 32 movie_changes, 33 movie_credits, 34 movie_images, 35 movie_keywords, 36 movie_latest, 37 movie_lists, 38 movie_now_playing, 39 movie_popular, 40 movie_releases, 41 movie_reviews, 42 movie_similar, 43 movie_top_rated, 44 movie_translations, 45 movie_upcoming, 46 movie_videos, 47
network, 48
INDEX
person_changes, 49 person_combined_credits, 50 person_external_ids, 51 person_images, 52 person_latest, 53 person_movie_credits, 55 person_popular, 56 person_tagged_images, 57 person_tmdb, 58 person_tv_credits, 59
review, 60
search_collection, 61 search_company, 62 search_keyword, 63 search_list, 64 search_movie, 65 search_multi, 66 search_person, 67 search_tv, 68
timezone, 70
tv, 71
tv_airing_today, 72 tv_alternative_title, 74 tv_changes, 75 tv_content_ratings, 76 tv_credits, 77
tv_episode, 78 tv_episode_changes, 79 tv_episode_credits, 80 tv_episode_external_ids, 81 tv_episode_images, 82 tv_episode_videos, 83 tv_external_ids, 84 tv_images, 85
tv_keywords, 86
tv_latest, 87 tv_on_the_air, 89 tv_popular, 90
tv_season, 91 tv_season_changes, 92 tv_season_credits, 93 tv_season_external_ids, 94 tv_season_images, 95 tv_season_videos, 96 tv_similar, 97 tv_top_rated, 98
INDEX 105
tv_translations, 99 tv_videos, 100