Skip to contents

Retrieve a user's media ratings

Usage

user_ratings(
  user = getOption("trakt_username"),
  type = c("movies", "seasons", "shows", "episodes"),
  rating = NULL,
  extended = c("min", "full")
)

Source

user_ratings() wraps endpoint users/:id/ratings/:type/:rating.

Arguments

user

character(1): Target username (or slug). Defaults to getOption("trakt_username"). 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.

rating

integer(1) [NULL]: Optional rating between 1 and 10 to filter by.

extended

character(1): Either "min" (API default) or "full". The latter returns more variables and should generally only be used if required. See vignette("finding-things") for more details.

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.

Examples

if (FALSE) {
user_ratings(user = "jemus42", "shows")
user_ratings(user = "sean", type = "movies")
}