discover_tv {TMDb} | R Documentation |
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)