search_person {TMDb}

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)