README.md

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

twitchr

R wrapper for the Twitch API.

Installation

From Github

# install.packages("devtools")
devtools::install_github("koderkow/twitch")

Setup

Steps

1. Go to https://dev.twitch.tv/login
2. Login with Twitch
3. Click Register Your Application
4. Fill out the App information
   • Name: Name of the app. Something to label it for the own personal use
   • OAuth Redirect URLs: Fill this in if one if you have one. If not put http://localhost
   • Category: Pick related category such as Analytics Tool
5. Click Create
6. On the new app, click Manage
7. This page will have the Client ID and Client Secret
8. Open the .Renviron to add these values
   • Run usethis::edit_r_environ() in the RStudio R console
9. Enter the two key values into this file with the following key names
   • TWITCH_CLIENT_ID=YOUR CLIENT ID
   • TWITCH_SECRET=YOUR SECRET
10. Restart the RStudio session

More Information

Read about getting authorization tokens here.

Examples

library(twitchr)

Authorize

Get auth token by using twitch_auth(). This will be appended to future API calls

twitch_auth()

Get user information

Look up a user by their display name to get user information. This is userful to obtain broadcaster_id for other functions

user <- get_users(login = "KowAndToilet")

user
#> # A tibble: 1 x 10
#>   id        login        display~1 type  broad~2 descr~3 profi~4 offli~5 view_~6
#>   <chr>     <chr>        <chr>     <chr> <chr>   <chr>   <chr>   <chr>     <int>
#> 1 613890167 kowandtoilet kowandto~ ""    affili~ Kyle a~ https:~ https:~    4989
#> # ... with 1 more variable: created_at <dttm>, and abbreviated variable names
#> #   1: display_name, 2: broadcaster_type, 3: description, 4: profile_image_url,
#> #   5: offline_image_url, 6: view_count
#> # i Use `colnames()` to see all variable names

Get Videos

Obtain a users recent videos

videos <- get_videos(user_id = user$id)

Get Followers

Display the followers of a channel

followers <- get_follows(to_id = user$id)

Get chatters

Display who is currently in a broadcasters chat

chatters <- get_chatters("KowAndToilet")

Other functions

I have covered most of the Twitch API endpoints which can be viewed here. If there are any you would like added please create an issue! :)

Thanks to

• Freguglia for getting me started on the oauth code

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