Skip to contents

Get a user's watchlist

Source: R/user_watchlist.R
user_watchlist.Rd

Get a user's watchlist

Usage

user_watchlist(user = "me", type = c("movies", "shows"), extended = "min")

Source

user_watchlist() wraps endpoint /users/:id/watchlist/:type/:sort.

Arguments

user

character(1): Target username (or slug). Defaults to "me", the OAuth user. Can also be of length greater than 1, in which case the function is called on all user values separately and the result is combined.

type

character(1): Either "shows" or "movies". For season/episode-specific functions, values seasons or episodes are also allowed.

extended

character: Level of detail for the API response.

  • "min" (default): Minimal info (title, year, IDs). Omits the extended query param.

  • "full": Complete info including overview, ratings, runtime, etc.

  • "images": Minimal info plus image URLs (returned as a list-column).

  • "full,images": Complete info plus images.

  • "metadata": Collection endpoints only; adds video/audio metadata.

Multiple values can be combined as a comma-separated string (e.g. "full,images") or a character vector (e.g. c("full", "images")).

Value

A tibble(). If the function has a limit parameter (defaulting to 10), this will be the (maximum) number of rows of the tibble. If there are no results (or the API is unreachable), an empty tibble() is returned.

See also

Other user data: user_collection(), user_comments(), user_history(), user_likes(), user_network(), user_profile(), user_ratings(), user_stats(), user_watched()

Examples

if (FALSE) { # \dontrun{
# Defaults to movie watchlist and minimal info
user_watchlist(user = "sean")
} # }