Package 'TMDb'

Title: Access to TMDb API
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 editable database for movies and TV shows (see <https://www.themoviedb.org>).
Authors: Andrea Capozio <[email protected]>
Maintainer: Andrea Capozio <[email protected]>
License: Artistic-2.0
Version: 1.1
Built: 2025-02-13 04:42:31 UTC
Source: https://github.com/cran/TMDb

Help Index


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

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

TH

Thailandia

BR

Brazil

KR

South Korea

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

page

The number of the page to show. Minimum 1, maximum 1000.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

The change log system to support this was changed on October 5, 2012 and will only show movies that have been edited since.

Value

A list with the following fields:

results

The IDs of the changed movies.

page

The current page for the results.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

page

The number of the page to show. Minimum 1, maximum 1000.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

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

The IDs of the changed people.

page

The current page for the results.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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)

Arguments

api_key

Your TMDb Consumer Key.

page

The number of the page to show. Minimum 1, maximum 1000.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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

The IDs of the changed TV shows.

page

The current page for the results.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The collection ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any collection method.

Value

A list with the following fields:

id

The ID collection.

name

The name of the collection.

overview

The content of the collection.

poster_path

The poster of the collection.

backdrop_path

The backdrop of the collection.

parts

The items of the collection.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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(api_key, 10, language = "it", append_to_response = "images")

## End(Not run)

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

Your TMDb Consumer Key.

id

The collection ID.

language

A ISO 639-1 code.

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

The collection ID.

backdrops

The backdrops of the collection.

posters

Heigth, width, votes of the images of the collection.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

A brief description about the company.

headquarters

The headquarters of the company.

homepage

The homepage of the company.

id

The company ID.

logo_path

The path of company's logo

name

The company's name.

parent_company

The associated companies.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

The company ID.

page

The current page for the results.

results

The company's movies.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

Retrieve credits.

Description

Get the detailed information about a particular credit record.

Usage

credit(api_key, credit_id, language = NA)

Arguments

api_key

Your TMDb Consumer Key.

credit_id

The credit ID.

language

A ISO 639-1 code.

Details

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.

Value

A list with the following fields:

credit_type

The credit's type.

department

The section to which a person belongs.

job

The job of a person.

media

Name, ID and character associated with the person.

media_type

The media's type.

id

The credit ID.

person

Name and ID of the character associated with the person.

Note

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

https://developers.themoviedb.org/3/getting-started

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)

Retrieve the TMDb movies list.

Description

Discover movies by different types of data like average rating, number of votes, genres and certifications.

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 certification for the specificed 'certification_country'.

certification.lte

Only include movies with this certification and lower. Expected value is a valid certification for the specificed 'certification_country'.

include_adult

Toggle the inclusion of adult titles. Expected value is a boolean, true or false. Default is false.

include_video

Toggle the inclusion of items marked as a video. Expected value is a boolean, true or false. Default is true.

language

A ISO 639-1 code.

page

The number of the page to show. Minimum 1, maximum 1000.

primary_release_year

Filter the results so that only the primary release date year has this value. Expected 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

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.

sort_by

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

vote_count.gte

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.

vote_count.lte

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.

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

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.

with_cast

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'.

with_crew

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'.

with_companies

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'.

with_genres

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'.

with_keywords

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'.

with_people

Only include movies that have these person id's added as a cast or crew member. 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'.

year

Filter the results by all available release dates that have the specified value added as a year. Expected value is an integer (year).

Value

A list with the following fields:

page

The current page for the results.

results

A list of movies that match the query's parameters.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

page

The number of the page to show. Minimum 1, maximum 1000.

language

A ISO 639-1 code.

sort_by

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.

with_genres

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'.

with_networks

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.

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.

Value

A list with the following fields:

page

The current page for the results.

results

A list of TV shows that match the query's parameters.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

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

external_source

An external ID, like an IMDB ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

movie_results

The results in the movies department.

person_results

The results in the person department.

tv_results

The results in the tv department.

tv_episode_results

The results in the tv_episode department.

tv_season_results

The results in the tv_season department.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

References

https://developers.themoviedb.org/3/getting-started

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)

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

The ID genre.

page

The current page for the results.

results

The movies belonging to the id genre.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

https://developers.themoviedb.org/3/getting-started

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)

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

https://developers.themoviedb.org/3/getting-started

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)

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

https://developers.themoviedb.org/3/getting-started

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)

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

The keyword ID.

page

The current page for the results.

results

The movies associated with the keyword ID.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

The author of the list.

description

A brief description about the list.

favorite_count

The number of favorites.

id

The list ID.

items

The elements of the list.

item_count

The number of list's elements.

iso_639_1

The language of the list.

name

The name of the list.

poster_path

The poster of the list.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The list ID.

movie_id

The movie ID to check.

Value

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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The movie ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any movie method.

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

The collections to which the movie belongs.

budget

The budget for the movie.

genres

The movie's genre.

homepage

The movie's homepage.

id

The movie ID.

imdb_id

The movie imdb ID.

original_language

The original language of the movie.

original_title

The original title of the movie.

overview

A brief plot.

popularity

An index of the movie's popularity.

poster_path

The poster of the movie.

production_companies

The producer companies.

production_countries

The countries involved in the production.

release_data

The data of the release.

revenue

The movie's income.

runtime

The length of the movie.

spoken_language

The language spoken in the movie.

status

The movie's status.

tagline

The movie's tagline.

title

The movie's title.

video

The videos associated to the movie.

vote_average

The average of the votes.

vote_count

The number of votes.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

Retrieve alternative titles for movies.

Description

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

Your TMDb Consumer Key.

id

The movie ID.

country

A ISO 3166-1 code.

append_to_response

Comma separated, any movie method.

Value

A list with the following fields:

id

The movie ID.

titles

The alternative titles of the movie.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The movie ID.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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

https://developers.themoviedb.org/3/getting-started

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)

## End(Not run)

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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The movie ID.

language

A ISO 639-1 code.

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

The movie ID.

backdrops

The backdrops of the movie.

posters

Heigth, width, votes of the images of the movie.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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_images(api_key = api_key, id = 550, language = "it")

## End(Not run)

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

https://developers.themoviedb.org/3/getting-started

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)

Retrieve the latest movie inserted in TMDb.

Description

Get the latest movie ID.

Usage

movie_latest(api_key)

Arguments

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

The collections to which the movie belongs.

budget

The budget for the movie.

genres

The movie's genre.

homepage

The movie's homepage.

id

The movie ID.

imdb_id

The movie imdb ID.

original_language

The original language of the movie.

original_title

The original title of the movie.

overview

A brief plot.

popularity

An index of the movie's popularity.

poster_path

The poster of the movie.

production_companies

The producer companies.

production_countries

The countries involved in the production.

release_data

The data of the release.

revenue

The movie's income.

runtime

The length of the movie.

spoken_language

The language spoken in the movie.

status

The movie's status.

tagline

The movie's tagline.

title

The movie's title.

video

The videos associated to the movie.

vote_average

The average of the votes.

vote_count

The number of votes.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

id

The movie ID.

page

The current page for the results.

results

The lists containing the movie.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

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:

page

The current page for the results.

results

The movies now in theaters, with a brief description.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

id

The movie ID.

countries

The release dates in several countries.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

id

The movie ID.

page

The current page for the results.

results

The reviews about the movie.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

page

The current page for the results.

results

The similar movies, with a brief description.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

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:

page

The current page for the results.

results

A list of top-rated movies, with a brief description.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The movie ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any movie method.

Value

A list with the following fields:

id

The movie ID.

translations

The available translations of the movie.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

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:

page

The current page for the results.

results

The upcoming movies now in theaters, with the basic informations.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The movie ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any movie method.

Value

A list with the following fields:

id

The movie ID.

results

The videos associated with the movie.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Note

Use this ID to search for TV shows with the discover method.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The person ID.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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 fields:

changes

The type and the object of the change.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The person ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any person method.

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

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

imdb_id

The person imdb ID.

freebase_mid

The person freebase_mid ID.

freebase_id

The person freebsae ID.

tvrage_id

The person tvrage ID.

id

The person TMDb ID.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

id

The person ID.

profiles

The images of the person.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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.

Value

A list with the following fields:

adult

A logical value that indicates if a person plays movie for adult (TRUE) or not (FALSE).

also_known_as

The artistic name.

biography

The person's biography.

birthday

The person's birthday.

deathday

The person's (eventual) deathday.

homepage

The person's homepage.

id

The person ID.

imdb_id

The person imdb id.

name

The person's name.

place_of_birth

Where the person was born.

popularity

An index of the person's popularity.

profile_path

The person's profile path.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The person ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any person method.

Value

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

https://developers.themoviedb.org/3/getting-started

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)

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

The person ID.

page

The current page for the results.

results

Heigth, width, voted of the images related to the person, with a brief description.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

A logical value that indicates if a person plays movie for adult (TRUE) or not (FALSE).

also_known_as

The artistic name.

biography

The person's biography.

birthday

The person's birthday.

deathday

The person's (eventual) deathday.

homepage

The person's homepage.

id

The person ID.

imdb_id

The person imdb id.

name

The person's name.

place_of_birth

Where the person was born.

popularity

An index of the person's popularity.

profile_path

The person's profile path.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The person ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any person method.

Value

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.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

The review ID.

author

The review's author.

content

The review'text.

iso_639_1

The review's language.

media_id

The ID of the reviewed object.

media_title

The object's title.

media_type

The type of the reviewed object.

url

The url of the review.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

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:

page

The current page for the results.

results

The collections that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

Value

A list with the following fields:

page

The current page for the results.

results

The companies that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

Value

A list with the following fields:

page

The current page for the results.

results

The keywords that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

include_adult

Toggle the inclusion of adult titles. Expected value is: true or false

Value

A list with the following fields:

page

The current page for the results.

results

The lists that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

include_adult

Toggle the inclusion of adult titles. Expected value is: true or false.

language

A ISO 639-1 code.

year

Filter the results release dates to matches that include this value.

primary_release_year

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'.

Value

A list with the following fields:

page

The current page for the results.

results

The movies that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

include_adult

Toggle the inclusion of adult titles. Expected value is: true or false.

language

A ISO 639-1 code.

Value

A list with the following fields:

page

The current page for the results.

results

The movies, TV shows and people that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

include_adult

Toggle the inclusion of adult titles. Expected value is: true or false

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'.

Value

A list with the following fields:

page

The current page for the results.

results

The people that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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 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")

Arguments

api_key

Your TMDb Consumer Key.

query

A CGI escaped string.

page

The number of the page to show. Minimum 1, maximum 1000.

language

A ISO 639-1 code.

first_air_date_year

Filter the results to only match shows that have a air date with with 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'.

Value

A list with the following fields:

page

The current page for the results.

results

The TV shows that match the query.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV series ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any TV series method.

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

The length of an episode.

first_air_date

The first day when TV show begun.

genres

The TV show's genre.

homepage

The TV show's homepage.

id

The TV show ID.

in_production

A logical value that indicates if a TV shows is in production (TRUE) or not (FALSE).

languages

A list of available languages.

last_air_date

The last day when TV show ended.

name

The TV show name.

networks

The companies involved with the TV show.

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

The original language of the TV show.

original_name

The original name of the TV show.

overview

A brief plot.

popularity

An index of the TV show's popularity.

poster_path

The poster of the TV show.

production_companies

The producer companies.

seasons

The TV show's seasons.

status

The TV show's status.

type

The TV show's type.

vote_average

The average of the votes.

vote_count

The number of votes.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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)

Arguments

api_key

Your TMDb Consumer Key.

page

The number of the page to show. Minimum 1, maximum 1000.

language

A ISO 639-1 code.

timezone

Valid value from the list of timezones.

Details

Without a specified timezone, this query defaults to EST (Eastern Time UTC-05:00).

Value

A list with the following fields:

page

The current page for the results.

results

The TV shows that are on air in the current day.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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

https://developers.themoviedb.org/3/getting-started

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)

## End(Not run)

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

https://developers.themoviedb.org/3/getting-started

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)

Retrieve credits for a TV series.

Description

Get the cast & crew information about a TV series. Just like the website, TMDb pulls this information 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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the TV show ID.

episode_number

The episode number refered to the TV show ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any TV series method.

Value

A list with the following fields:

air_date

when an episode is aired.

crew

The crew of the TV episode.

episode_number

The episode number of the TV episode.

guest_stars

The guest stars of the TV episode.

name

The TV episode title.

overview

A brief plot.

id

The TV episode ID.

production_code

The production code.

season_number

The season number of the TV episode.

still_path

The image's path.

vote_average

The average of the votes.

vote_count

The number of votes.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the TV show ID.

episode_number

The episode number refered to the TV show ID.

Value

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

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the TV show ID.

episode_number

The episode number refered to the TV show ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

imdb_id

The TV episode imdb ID.

freebase_mid

The TV episode freebase_mid ID.

freebase_id

The TV episode freebsae ID.

tvdb_id

The TV episode tvdb ID.

tvrage_id

The TV episode tvrage ID.

id

The TV episode TMDb ID.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the TV show ID.

episode_number

The episode number refered to the TV show ID.

Value

A list with the following fields:

id

The TV episode ID.

stills

Heigth, width, votes of the images of the TV episode.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the TV show ID.

episode_number

The episode number refered to the TV show ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

id

The TV episode ID.

results

The videos associated with the TV episode.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The tv show ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

imdb_id

The TV show imdb ID.

freebase_mid

The TV show freebase_mid ID.

freebase_id

The TV show freebsae ID.

tvdb_id

The TV show tvdb ID.

tvrage_id

The TV show tvrage ID.

id

The TV show TMDb ID.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV series ID.

language

A ISO 639-1 code.

include_image_language

A comma separated, a valid ISO 69-1. Maximum 5 per request.

Value

A list with the following fields:

id

The TV show ID.

backdrops

The backdrops of the TV show.

posters

Heigth, width, votes of the images of the TV show.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

References

https://developers.themoviedb.org/3/getting-started

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)

Retrieve the latest TV show inserted in TMDb.

Description

Get the latest TV show id.

Usage

tv_latest(api_key)

Arguments

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

The length of an episode.

first_air_date

the first time that TV show is aired

genres

The TV show's genre.

homepage

The TV show's homepage.

id

The TV show ID.

in_production

A logical value that indicates if a TV shows is in production (TRUE) or not (FALSE).

languages

A list of available languages.

last_air_date

The last day when TV show ended.

name

The TV show name.

networks

The companies involved with the TV show.

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

The original language of the TV show.

original_name

The original name of the TV show.

overview

A brief plot.

popularity

An index of the TV show's popularity.

poster_path

The poster of the TV show.

production_companies

The producer companies.

seasons

The TV show's seasons.

status

The TV show's status.

type

The TV show's type.

vote_average

The average of the votes.

vote_count

The number of votes.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

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:

page

The current page for the results.

results

The TV shows that are on air.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the ID.

language

A ISO 639-1 code.

append_to_response

Comma separated, any tv season method.

Value

A list with the following fields:

air_date

when a season is aired.

episodes

A list with the season episodes: dates, crews, guest stars, overviews, titles.

name

The TV season title.

overview

A brief plot.

id

The season ID.

poster_path

The image's path.

season_number

The season number.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

start_date

The date starting from which to search. Format YYYY-MM-DD.

end_date

The date until which to search. Format YYYY-MM-DD.

Details

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

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the ID.

Value

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

https://developers.themoviedb.org/3/getting-started

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)

Retrieve external ids for a TV season.

Description

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

freebase_mid

The TV season freebase_mid ID.

freebase_id

The TV season freebsae ID.

tvdb_id

The TV season tvdb ID.

tvrage_id

The TV season tvrage ID.

id

The TV season TMDb ID.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the ID.

language

A ISO 639-1 code.

include_image_language

Comma separated, a valid ISO 69-1. Maximum 5 per request.

Value

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

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV show ID.

season_number

The season number refered to the ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

id

The TV season ID.

results

The videos associated with the TV season.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

The current page for the results.

results

The similar TV shows.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

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:

page

The current page for the results.

results

The top rated TV shows.

total_pages

The number of pages for the results.

total_results

The number of results.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)

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

References

https://developers.themoviedb.org/3/getting-started

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)

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

Your TMDb Consumer Key.

id

The TV series ID.

language

A ISO 639-1 code.

Value

A list with the following fields:

id

The TV show ID.

results

The videos associated with the TV show.

Author(s)

Andrea Capozio

References

https://developers.themoviedb.org/3/getting-started

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)