R/movies_boxoffice.R

In jemus42/tRakt: Get Data from 'trakt.tv'

#' Get the weekend box office
#'
#' Returns the top 10 grossing movies in the U.S. box office last weekend.
#' Updated every Monday morning.
#'
#' @inheritParams trakt_api_common_parameters
#' @inherit trakt_api_common_parameters return
#' @export
#' @family movie data
#' @eval apiurl("movies", "box office")
#' @importFrom tibble as_tibble
#' @examples
#' movies_boxoffice()
movies_boxoffice <- function(extended = c("min", "full")) {
  extended <- match.arg(extended)

  # Construct URL, make API call
  url <- build_trakt_url("movies/boxoffice", extended = extended)
  response <- trakt_get(url = url)

  response |>
    unpack_movie() |>
    fix_tibble_response()
}