Package 'tmdbR'

Description

A modern HTTPS client for The Movie Database (TMDB) API. It provides read-only v3 convenience functions compatible with the legacy TMDb package, generic v3 and v4 GET requests, bearer-token authentication, automatic pagination, retries, and structured errors.

Package provenance

Important: tmdbR was developed from the compatibility interface of Andrea Capozio's TMDb version 1.1 package, published on CRAN on 16 March 2020 under the Artistic License 2.0. tmdbR is a separately named, substantially modified package and is not an official update by the original author. See https://CRAN.R-project.org/package=TMDb.

Quick start

Configure a bearer token once with tmdb_auth(), then search for a title and request its details:

token_file <- file.path(tempdir(), "tmdbR-token.rds")
tmdb_auth(path = token_file)
hits <- search_movie(query = "Spirited Away", language = "en-AU")
film <- movie(id = hits$results$id[[1]],
              append_to_response = "credits,videos")

Authentication

Bearer authentication is recommended. Use interactive tmdb_auth() to store an encrypted cached token, or set TMDB_BEARER_TOKEN for the current process. The legacy TMDB_API_KEY mechanism remains available for compatibility. Explicit credentials take precedence over environment and cached credentials. See tmdb_auth and tmdb_credentials.

Find functions by task

• Movies: tmdb_movies

• TV series, seasons, and episodes: tmdb_tv

• People and credits: tmdb_people

• Search and discover: tmdb_search

• Configuration and general catalogue data: tmdb_catalogue

• Lists: tmdb_lists

• Pagination: tmdb_pagination

• Authentication and low-level requests: tmdb_client

Important pagination note

Important: TMDB controls page size. It does not document a supported page_size, limit, or per_page parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. Final pages can be shorter, and TMDB may change these values. The package counts each response and follows total_pages; it never assumes a fixed page size.

Pagination is opt-in and defaults to five pages, 100 results, and approximately 100 MB. Interactive retrieval reports its plan, each completed page, and whether the result is complete or truncated. See tmdb_paginate.

Return values and errors

JSON responses are converted into ordinary R lists, data frames, and vectors. Paginated calls return a tmdb_paginated list containing combined results, counts, limits, memory use, and a truncated flag. HTTP failures report TMDB's status code and message without including credentials. HTTP 429 and transient server failures are retried.

Package options and environment variables

• options(tmdbR.token_path = ...) overrides the cached-token path.

• TMDB_TOKEN_FILE supplies an explicit cached-token path.

• TMDB_BEARER_TOKEN supplies the preferred bearer token.

• TMDB_API_KEY supplies a legacy v3 API key.

Attribution

This product uses the TMDB API but is not endorsed or certified by TMDB. Downstream applications must comply with TMDB's current terms and attribution requirements.

Author(s)

Gordon Kuzet [email protected].

The compatibility interface is based on TMDb 1.1 by Andrea Capozio.

See Also

tmdb_auth, tmdb_request, tmdb_paginate, https://CRAN.R-project.org/package=TMDb, https://developer.themoviedb.org/docs/getting-started, and https://developer.themoviedb.org/docs/rate-limiting.

Examples

tmdb_config(timeout = 20, max_tries = 3)
# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
  hits <- search_movie(query = "Spirited Away", language = "en-AU")
  movie(id = hits$results$id[[1]], append_to_response = "credits,videos")
}

Description

Request the /certification/movie/list endpoint.

Usage

certification_movie_list(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
certification_movie_list()
}

Description

Request the /certification/tv/list endpoint.

Usage

certification_tv_list(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
certification_tv_list()
}

Description

Request the /movie/changes endpoint.

Usage

changes_movie(
  api_key = NULL,
  page = 1,
  start_date = NA,
  end_date = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
changes_movie(
  start_date = as.character(Sys.Date() - 6),
  end_date = as.character(Sys.Date()),
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /person/changes endpoint.

Usage

changes_person(
  api_key = NULL,
  page = 1,
  start_date = NA,
  end_date = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
changes_person(
  start_date = as.character(Sys.Date() - 6),
  end_date = as.character(Sys.Date()),
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /tv/changes endpoint.

Usage

changes_tv(
  api_key = NULL,
  page = 1,
  start_date = NA,
  end_date = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
changes_tv(
  start_date = as.character(Sys.Date() - 6),
  end_date = as.character(Sys.Date()),
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /collection/\{id\} endpoint.

Usage

collection(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
collection(
  id = 10,
  language = "en-AU"
)
}

Description

Request the /collection/\{id\}/images endpoint.

Usage

collection_images(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA,
  include_image_language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
collection_images(
  id = 10,
  language = "en-AU",
  include_image_language = c("en", "null")
)
}

Description

Request the /company/\{id\} endpoint.

Usage

company(
  api_key = NULL,
  id,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
company(
  id = 4
)
}

Description

Request the /discover/movie endpoint.

Usage

company_movies(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  append_to_response = NA,
  ...,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The legacy company-movies endpoint is replaced by /discover/movie with with_companies. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
company_movies(
  id = 4,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /configuration endpoint.

Usage

configuration(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
configuration()
}

Description

Request the /credit/\{credit_id\} endpoint.

Usage

credit(
  api_key = NULL,
  credit_id,
  language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
credit(
  credit_id = "replace-with-credit-id",
  language = "en-AU"
)
}

Description

Discover TMDB records using the /discover/movie endpoint.

Usage

discover_movie(
  api_key = NULL,
  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,
  region = NA,
  watch_region = NA,
  with_watch_providers = NA,
  with_watch_monetization_types = NA,
  ...,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
discover_movie(
  language = "en-AU",
  region = "AU",
  watch_region = "AU",
  with_watch_providers = c(8, 9),
  with_watch_monetization_types = "flatrate",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Discover TMDB records using the /discover/tv endpoint.

Usage

discover_tv(
  api_key = NULL,
  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,
  watch_region = NA,
  with_watch_providers = NA,
  with_watch_monetization_types = NA,
  ...,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
discover_tv(
  language = "en-AU",
  watch_region = "AU",
  with_watch_providers = c(8, 9),
  with_watch_monetization_types = "flatrate",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /find/\{id\} endpoint.

Usage

find_tmdb(
  api_key = NULL,
  id,
  external_source,
  language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
find_tmdb(
  id = "tt0137523",
  external_source = "imdb_id",
  language = "en-AU"
)
}

Description

Request the /genre/movie/list endpoint.

Usage

genres_movie_list(
  api_key = NULL,
  language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
genres_movie_list(
  language = "en-AU"
)
}

Description

Request the /discover/movie endpoint.

Usage

genres_movies(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  include_all_movies = NA,
  include_adult = NA,
  ...,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The legacy genre-movies endpoint is replaced by /discover/movie with with_genres. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
genres_movies(
  id = 1,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /genre/tv/list endpoint.

Usage

genres_tv_list(
  api_key = NULL,
  language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
genres_tv_list(
  language = "en-AU"
)
}

Description

Request the /configuration/jobs endpoint.

Usage

jobs(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
jobs()
}

Description

Request the /keyword/\{id\} endpoint.

Usage

keyword(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
keyword(
  id = 1721
)
}

Description

Request the /discover/movie endpoint.

Usage

keyword_movies(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  ...,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The legacy keyword-movies endpoint is deprecated; this function uses /discover/movie with with_keywords. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
keyword_movies(
  id = 1721,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /list/\{id\} endpoint.

Usage

list_get(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
list_get(
  id = "replace-with-list-id"
)
}

Description

Request the /list/\{id\}/item_status endpoint.

Usage

list_item_status(
  api_key = NULL,
  id,
  movie_id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
list_item_status(
  id = "replace-with-list-id",
  movie_id = 550
)
}

Description

Request the /movie/\{id\} endpoint.

Usage

movie(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie(
  id = 550,
  language = "en-AU",
  append_to_response = "credits,videos"
)
}

Description

Request the /movie/\{id\}/alternative_titles endpoint.

Usage

movie_alternative_title(
  api_key = NULL,
  id,
  country = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_alternative_title(
  id = 550
)
}

Description

Request the /movie/\{id\}/changes endpoint.

Usage

movie_changes(
  api_key = NULL,
  id,
  start_date = NA,
  end_date = NA,
  page = 1,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_changes(
  id = 550,
  start_date = as.character(Sys.Date() - 6),
  end_date = as.character(Sys.Date()),
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/\{id\}/credits endpoint.

Usage

movie_credits(
  api_key = NULL,
  id,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_credits(
  id = 550
)
}

Description

Request the /movie/\{id\}/images endpoint.

Usage

movie_images(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA,
  include_image_language = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_images(
  id = 550,
  language = "en-AU",
  include_image_language = c("en", "null")
)
}

Description

Request the /movie/\{id\}/keywords endpoint.

Usage

movie_keywords(
  api_key = NULL,
  id,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_keywords(
  id = 550
)
}

Description

Request the /movie/latest endpoint.

Usage

movie_latest(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_latest()
}

Description

Request the /movie/\{id\}/lists endpoint.

Usage

movie_lists(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  append_to_response = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_lists(
  id = 550,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/now_playing endpoint.

Usage

movie_now_playing(
  api_key = NULL,
  page = 1,
  language = NA,
  region = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_now_playing(
  language = "en-AU",
  region = "AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/popular endpoint.

Usage

movie_popular(
  api_key = NULL,
  page = 1,
  language = NA,
  region = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_popular(
  language = "en-AU",
  region = "AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/\{id\}/release_dates endpoint.

Usage

movie_releases(
  api_key = NULL,
  id,
  append_to_response = NA
)

Arguments

Details

This compatibility function uses the current /release_dates endpoint. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_releases(
  id = 550
)
}

Description

Request the /movie/\{id\}/reviews endpoint.

Usage

movie_reviews(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  append_to_response = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_reviews(
  id = 550,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/\{id\}/similar endpoint.

Usage

movie_similar(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  append_to_response = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_similar(
  id = 550,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/top_rated endpoint.

Usage

movie_top_rated(
  api_key = NULL,
  page = 1,
  language = NA,
  region = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_top_rated(
  language = "en-AU",
  region = "AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/\{id\}/translations endpoint.

Usage

movie_translations(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_translations(
  id = 550,
  language = "en-AU"
)
}

Description

Request the /movie/upcoming endpoint.

Usage

movie_upcoming(
  api_key = NULL,
  page = 1,
  language = NA,
  region = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_upcoming(
  language = "en-AU",
  region = "AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /movie/\{id\}/videos endpoint.

Usage

movie_videos(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
movie_videos(
  id = 550,
  language = "en-AU"
)
}

Description

Request the /network/\{id\} endpoint.

Usage

network(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
network(
  id = 213
)
}

Description

Request the /person/\{id\}/changes endpoint.

Usage

person_changes(
  api_key = NULL,
  id,
  start_date = NA,
  end_date = NA,
  page = 1,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_changes(
  id = 287,
  start_date = as.character(Sys.Date() - 6),
  end_date = as.character(Sys.Date()),
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /person/\{id\}/combined_credits endpoint.

Usage

person_combined_credits(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_combined_credits(
  id = 287,
  language = "en-AU"
)
}

Description

Request the /person/\{id\}/external_ids endpoint.

Usage

person_external_ids(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_external_ids(
  id = 287
)
}

Description

Request the /person/\{id\}/images endpoint.

Usage

person_images(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_images(
  id = 287
)
}

Description

Request the /person/latest endpoint.

Usage

person_latest(
  api_key = NULL,
  page = 1
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_latest(
  page = 1
)
}

Description

Request the /person/\{id\}/movie_credits endpoint.

Usage

person_movie_credits(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_movie_credits(
  id = 287,
  language = "en-AU"
)
}

Description

Request the /person/popular endpoint.

Usage

person_popular(
  api_key = NULL,
  page = 1,
  language = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_popular(
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /person/\{id\}/tagged_images endpoint.

Usage

person_tagged_images(
  api_key = NULL,
  id,
  page = 1,
  language = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_tagged_images(
  id = 287,
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /person/\{id\} endpoint.

Usage

person_tmdb(
  api_key = NULL,
  id,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_tmdb(
  id = 287,
  append_to_response = "combined_credits"
)
}

Description

Request the /person/\{id\}/tv_credits endpoint.

Usage

person_tv_credits(
  api_key = NULL,
  id,
  language = NA,
  append_to_response = NA
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
person_tv_credits(
  id = 287,
  language = "en-AU"
)
}

Description

Request the /review/\{id\} endpoint.

Usage

review(
  api_key = NULL,
  id
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
review(
  id = "replace-with-review-id"
)
}

Description

Search TMDB using the /search/collection endpoint.

Usage

search_collection(
  api_key = NULL,
  query,
  page = 1,
  language = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_collection(
  query = "Spirited Away",
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/company endpoint.

Usage

search_company(
  api_key = NULL,
  query,
  page = 1,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_company(
  query = "Spirited Away",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/keyword endpoint.

Usage

search_keyword(
  api_key = NULL,
  query,
  page = 1,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_keyword(
  query = "Spirited Away",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/collection endpoint.

Usage

search_list(
  api_key = NULL,
  query,
  page = 1,
  include_adult = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The removed list-search endpoint is mapped to current collection search. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_list(
  query = "Spirited Away",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/movie endpoint.

Usage

search_movie(
  api_key = NULL,
  query,
  page = 1,
  include_adult = NA,
  language = NA,
  year = NA,
  primary_release_year = NA,
  search_type = NA,
  region = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_movie(
  query = "Spirited Away",
  language = "en-AU",
  region = "AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/multi endpoint.

Usage

search_multi(
  api_key = NULL,
  query,
  page = 1,
  include_adult = NA,
  language = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_multi(
  query = "Spirited Away",
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/person endpoint.

Usage

search_person(
  api_key = NULL,
  query,
  page = 1,
  include_adult = NA,
  search_type = NA,
  language = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_person(
  query = "Tom Hanks",
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Search TMDB using the /search/tv endpoint.

Usage

search_tv(
  api_key = NULL,
  query,
  page = 1,
  language = NA,
  first_air_date_year = NA,
  search_type = NA,
  include_adult = NA,
  paginate = FALSE,
  max_pages = 5L,
  max_results = 100L,
  max_memory_mb = 100,
  simplify = TRUE,
  deduplicate_by = NULL,
  progress = interactive(),
  delay = 0.05
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

A parsed response containing page metadata and a results data frame or list.

Important pagination note

Important: TMDB controls page size and does not document a supported page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global movie, TV, and person change feeds currently return up to 100. A final page can contain fewer records. These values are observed behavior, not a contractual guarantee. This function counts the actual results in each response and uses TMDB's total_pages metadata rather than assuming a fixed page size.

See Also

tmdb_paginate, tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
search_tv(
  query = "The Last of Us",
  language = "en-AU",
  paginate = TRUE,
  max_pages = 2,
  max_results = 40,
  progress = TRUE
)
}

Description

Request the /configuration/timezones endpoint.

Usage

timezone(
  api_key = NULL
)

Arguments

Details

The response is parsed from JSON into ordinary R lists, data frames, and vectors. HTTP failures raise an error containing TMDB's status and message. Authentication can use an explicit API key or package environment variables.

Value

The parsed TMDB response as R lists, data frames, and vectors.

See Also

tmdb_request

Examples

# Live examples run only in an interactive session with a bearer token.
if (interactive() && nzchar(Sys.getenv("TMDB_BEARER_TOKEN"))) {
timezone()
}

Description

Save, locate, or remove the encrypted TMDB bearer-token cache.

Usage

tmdb_auth(bearer_token = NULL, path = NULL, overwrite = FALSE)

tmdb_token_path(path = NULL)

tmdb_forget_token(path = NULL)

Arguments

Details

No file path is selected by default. Supply path, set options(tmdbR.token_path = ...), or set TMDB_TOKEN_FILE. When a token already exists, tmdb_auth() asks whether it should be kept or replaced. Set overwrite = TRUE to replace it without asking. Explicit credentials and environment variables take precedence over the cached token.

Value

tmdb_auth() invisibly returns the token-file path. tmdb_token_path() returns the token-file path. tmdb_forget_token() invisibly returns whether the file is absent.

Examples

token_file <- file.path(tempdir(), "tmdbR-token.rds")
tmdb_token_path(token_file)
## Not run: 
tmdb_auth(path = token_file)
tmdb_forget_token(path = token_file)

## End(Not run)

Description

Configuration, certifications, genres, collections, companies, keywords, networks, credits, reviews, and global changes.

Configuration and reference data

configuration, certification_movie_list, certification_tv_list, genres_movie_list, genres_tv_list, jobs, and timezone.

Catalogue resources

collection, collection_images, company, company_movies, genres_movies, keyword, keyword_movies, network, credit, and review.

Global changes

changes_movie, changes_tv, and changes_person.

Description

Low-level requests, authentication, configuration, and pagination.

Functions

tmdb_auth, tmdb_request, tmdb_config, tmdb_credentials, tmdb_paginate, and tmdb_request_all.

See Also

tmdbR-package

Description

Create reusable authentication, timeout, and retry settings.

Usage

tmdb_config(bearer_token = NULL, api_key = NULL,
  timeout = 15, max_tries = 3)

Arguments

Details

Bearer authentication is preferred if both credential types are supplied.

Value

A configuration list accepted by tmdb_request() and tmdb_request_all().

See Also

tmdb_request, tmdb_credentials

Examples

cfg <- tmdb_config(timeout = 30, max_tries = 5)
## Not run: 
# Requires credentials in cfg or the environment.
tmdb_request("movie/550", config = cfg)

## End(Not run)

Description

Resolve and validate credentials without making a request.

Usage

tmdb_credentials(bearer_token = Sys.getenv("TMDB_BEARER_TOKEN"),
  api_key = Sys.getenv("TMDB_API_KEY"))

Arguments

Details

When neither argument nor environment variable provides a credential, the encrypted token cache created by tmdb_auth() is checked. An error is raised when no credential is available. Do not print, log, or commit the returned values.

Value

A list containing the available bearer token and API key.

See Also

tmdb_auth, tmdb_config, tmdb_request

Examples

credentials <- tmdb_credentials(bearer_token = "example-token")
names(credentials)
## Not run: 
# Requires an environment credential or a cached token.
credentials <- tmdb_credentials()

## End(Not run)

Description

Legacy v3 list-reading functions.

Details

TMDB recommends v4 for new list-management workflows. Use tmdb_request() for v4 GET endpoints.

Functions

list_get and list_item_status.

See Also

movie_lists, tmdb_request

Description

Functions for movie details, lists, media, credits, and changes.

Details and related data

movie, movie_alternative_title, movie_credits, movie_images, movie_keywords, movie_releases, movie_reviews, movie_similar, movie_translations, and movie_videos.

Lists and changes

movie_latest, movie_lists, movie_now_playing, movie_popular, movie_top_rated, movie_upcoming, and movie_changes.

See Also

search_movie, discover_movie, tmdb_paginate

Description

Fetch sequential pages from an existing TMDB wrapper and combine their results.

Usage

tmdb_paginate(.f, ..., start_page = 1L, max_pages = 5L,
  max_results = 100L, max_memory_mb = 100, simplify = TRUE, deduplicate_by = NULL,
  progress = interactive(), delay = 0.05)

Arguments

Details

Safe defaults are five pages, 100 results, and 100 MB. Pagination reuses authentication, timeouts, retries, and HTTP 429 handling. Interactive calls report their plan, each page, and completion status. Existing single-page wrappers remain unchanged.

Value

A tmdb_paginated list containing results, page and result counts, and a truncated flag.

Important pagination note

Important: TMDB controls page size and provides no documented page-size parameter. Standard search, discover, and list endpoints currently return up to 20 records per full page; global change feeds currently return up to 100. Final pages can be shorter. The implementation counts actual results and follows total_pages; it does not assume either value is fixed.

See Also

tmdb_request_all

Examples

fake_page <- function(page = 1) list(
  page = page,
  results = data.frame(id = page, title = paste("Title", page)),
  total_pages = 3,
  total_results = 3
)
tmdb_paginate(fake_page, max_pages = Inf, delay = 0, progress = FALSE)

## Not run: 
# Requires TMDB_BEARER_TOKEN or TMDB_API_KEY.
tmdb_paginate(search_movie, query = "Star Wars", max_pages = 5,
  max_results = 75, deduplicate_by = "id")

## End(Not run)

Description

Functions for collecting and combining sequential TMDB result pages.

Functions

tmdb_paginate paginates an existing wrapper. tmdb_request_all paginates a generic endpoint.

Important pagination note

Important: TMDB controls page size. Most standard result endpoints currently return up to 20 records per full page, while global change feeds return up to 100. Final pages may be shorter, and no supported page-size query parameter is documented. Pagination therefore uses actual response counts and TMDB's total_pages metadata.

See Also

tmdb_client

Description

Functions for people, credits, images, identifiers, and changes.

Functions

person_tmdb, person_changes, person_combined_credits, person_external_ids, person_images, person_latest, person_movie_credits, person_popular, person_tagged_images, and person_tv_credits.