search_channels: Search channels

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

Search channels

Description

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).

Usage

search_channels(
  query = NULL,
  first = FALSE,
  after = NULL,
  live_only = NULL,
  clean_json = TRUE
)

Arguments

query	A character. URl encoded search query.
first	A numeric. Maximum number of objects to return. Maximum: 100 Default: 20
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.
live_only	A logical. Filter results for live streams only. Default: false
clean_json	A logical. If TRUE, clean and tidy the data. If FALSE, return the result of httr::content.

Value

A tibble data frame of search channel data.

References

https://dev.twitch.tv/docs/api/reference#search-channels

See Also

Other Search: search_categories()

Examples

## Not run: 
library(twitchr)

twitch_auth()

search_results <- search_channels("KowAndToilet")

## End(Not run)

KoderKow/twitchr documentation built on Aug. 11, 2022, 8:56 p.m.