R/bits.R

In KoderKow/twitchr: R Interface for the 'Twitch API'

#' Retrieves the list of available Cheermotes
#'
#' Retrieves the list of available Cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat. Cheermotes returned are available throughout Twitch, in all Bits-enabled channels.
#'
#' @param broadcaster_id A numeric. ID for the broadcaster who might own specialized Cheermotes.
#' @param clean_json A logical. If `TRUE`, clean and tidy the data. If `FALSE`, return the result of `httr::content`.
#'
#' @family Bits
#' @export
#'
#' @return A tibble data frame of cheermote data.
#'
#' @references <https://dev.twitch.tv/docs/api/reference#get-cheermotes>
#' @examples
#' \dontrun{
#' twitch_auth()
#'
#' user <- get_users(login = "KowAndToilet")
#'
#' cheermotes <- get_cheermotes(broadcaster_id = user$id)
#' }
get_cheermotes <- function(broadcaster_id = NULL, clean_json = TRUE) {
  d <- make_request(
    end_point = "bits/cheermotes",
    clean_json = clean_json,
    broadcaster_id = broadcaster_id
  )

  return(d)
}