get_all_clips: Get all clips

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

Get all clips

Description

Gets clip information by broadcaster ID (one only), or game ID (one only). This function will handle pagination with get_clips automatically. Using at least one of the following parameters is required; broadcaster_id or game_id.

Usage

get_all_clips(
  broadcaster_id = NULL,
  game_id = NULL,
  ended_at = NULL,
  started_at = NULL
)

Arguments

broadcaster_id	A numeric. ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
game_id	A numeric. ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
ended_at	A character. Ending date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.) If this is specified, started_at also must be specified; otherwise, the time period is ignored.
started_at	A character. Starting date/time for returned clips, in RFC3339 format. (The seconds value is ignored.) If this is specified, ended_at also should be specified; otherwise, the ended_at date/time will be 1 week after the started_at value.

Value

A tibble data frame of clip data.

References

https://dev.twitch.tv/docs/api/reference#get-clips

See Also

Other Clips: get_clips()

Examples

## Not run: 
twitch_auth()

user <- get_users(login = "KowAndToilet")

all_clips <- get_all_clips(broadcaster_id = user$id)

## End(Not run)

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