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