R/search.R

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

#' Search channels
#'
#' Returns a list of channels (users who have streamed within the past 6 months) that match the query via channel name or description either entirely or partially. Results include both live and offline channels. Online channels will have additional metadata (e.g. started_at, tag_ids).
#'
#' @param query A character. URl encoded search query.
#' @param first A numeric. Maximum number of objects to return. Maximum: 100 Default: 20
#' @param after A character. Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
#' @param live_only A logical. Filter results for live streams only. Default: false
#' @inheritParams get_cheermotes
#'
#' @family Search
#' @export
#'
#' @return A tibble data frame of search channel data.
#'
#' @references <https://dev.twitch.tv/docs/api/reference#search-channels>
#' @examples
#' \dontrun{
#' library(twitchr)
#'
#' twitch_auth()
#'
#' search_results <- search_channels("KowAndToilet")
#' }
search_channels <- function(
  query = NULL,
  first = FALSE,
  after = NULL,
  live_only = NULL,
  clean_json = TRUE
) {
  d <- make_request(
    end_point = "search/channels",
    clean_json = clean_json,
    query = query
  )

  return(d)
}

#' Search for games or categories
#'
#' Returns a list of games or categories that match the query via name either entirely or partially.
#'
#' @param query A character. URL encoded search query.
#' @param first A numeric. Maximum number of objects to return. Maximum: 100. Default: 20.
#' @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
#' @inheritParams get_cheermotes
#'
#' @family Search
#' @export
#'
#' @return A tibble data frame of search categories data.
#'
#' @references <https://dev.twitch.tv/docs/api/reference#search-categories>
#' @examples
#' \dontrun{
#' library(twitchr)
#'
#' twitch_auth()
#'
#' search_results <- search_channels("fort")
#' }
search_categories <- function(
  query = NULL,
  first = NULL,
  after = NULL,
  clean_json = TRUE
) {
  d <- make_request(
    end_point = "search/categories",
    clean_json = clean_json,
    query = query,
    first = first,
    after = after
  )

  return(d)
}