tRakt helps you to retrieve data from trakt.tv, a site similar to IMDb with a wider focus, yet smaller user base. The site also enables media-center integration, so you can automatically sync your collection and watch progress, as well as scrobble playback and ratings via Plex, Kodi and the likes.
And, most importantly, trakt.tv has a publicly available API – which makes this package possible and allows you to collect all that nice data people have contributed.
Please note that while this package is basically an API-client, it is a little more opinionated and might deliver results that do not exactly match the data delivered by the API. The primary motivation for this package is to retrieve data that is easily processable for data analysis and display, which is why it tries hard to coerce most data into tabular form instead of using nested lists, which is what the direct translation of the API results would look like.
Installation
Get it from GitHub:
if (!("remotes" %in% installed.packages())) {
install.packages("remotes")
}
remotes::install_github("jemus42/tRakt")
library("tRakt")Usage
Search for a show, get basic info:
show_info <- search_query("Utopia", type = "show")
glimpse(show_info)
#> Rows: 1
#> Columns: 9
#> $ type <chr> "show"
#> $ score <dbl> 1000
#> $ title <chr> "Utopia"
#> $ year <int> 2013
#> $ trakt <chr> "46241"
#> $ slug <chr> "utopia"
#> $ tvdb <chr> "264991"
#> $ imdb <chr> "tt2384811"
#> $ tmdb <chr> "46511"Get season information for the show using its trakt ID:
seasons_summary(show_info$trakt, extended = "full") |>
glimpse()
#> Rows: 2
#> Columns: 13
#> $ season <int> 1, 2
#> $ rating <dbl> 8.56154, 8.01047
#> $ votes <int> 260, 191
#> $ episode_count <int> 6, 6
#> $ aired_episodes <int> 6, 6
#> $ title <chr> "Season 1", "Season 2"
#> $ overview <chr> "When a group of strangers find themselves in possessio…
#> $ first_aired <dttm> 2013-01-15 21:00:00, 2014-07-14 20:00:00
#> $ updated_at <dttm> 2022-08-28 14:32:07, 2022-08-28 14:31:03
#> $ network <chr> "Channel 4", "Channel 4"
#> $ trakt <chr> "56008", "56009"
#> $ tvdb <chr> "507598", "524149"
#> $ tmdb <chr> "54695", "54696"Get episode data for the first season, this time using the show’s URL slug:
seasons_season("utopia", seasons = 1, extended = "full") |>
glimpse()
#> Rows: 6
#> Columns: 16
#> $ season <int> 1, 1, 1, 1, 1, 1
#> $ episode <int> 1, 2, 3, 4, 5, 6
#> $ title <chr> "Episode 1", "Episode 2", "Episode 3", "Episode…
#> $ episode_abs <int> 1, 2, 3, 4, 5, 6
#> $ overview <chr> "When five strangers from an online comic book…
#> $ rating <dbl> 8.19613, 8.07093, 8.07795, 8.05150, 8.21902, 8.…
#> $ votes <int> 1239, 1001, 898, 835, 799, 825
#> $ comment_count <int> 7, 0, 1, 1, 1, 1
#> $ first_aired <dttm> 2013-01-15 21:00:00, 2013-01-22 21:00:00, 2013-…
#> $ updated_at <dttm> 2022-08-28 12:29:01, 2022-08-28 07:29:46, 2022-…
#> $ available_translations <list> <"de", "en", "es", "fr", "he", "nl", "pl", "ru"…
#> $ runtime <int> 50, 50, 50, 50, 50, 50
#> $ trakt <chr> "1405053", "1405054", "1405055", "1405056", "14…
#> $ tvdb <chr> "4471351", "4477746", "4477747", "4477748", "44…
#> $ imdb <chr> "tt2618234", "tt2618232", "tt2618236", "tt2618…
#> $ tmdb <chr> "910003", "910004", "910005", "910006", "91000…You cann also get episode data for all seasons, but note that episodes will be included as a list-column and need further unpacking:
seasons_summary("utopia", episodes = TRUE, extended = "full") |>
pull(episodes) |>
bind_rows() |>
glimpse()
#> Rows: 12
#> Columns: 16
#> $ season <int> 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2
#> $ episode <int> 1, 2, 3, 4, 5, 6, 1, 2, 3, 4, 5, 6
#> $ title <chr> "Episode 1", "Episode 2", "Episode 3", "Episode…
#> $ episode_abs <int> 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
#> $ overview <chr> "When five strangers from an online comic book…
#> $ rating <dbl> 8.19613, 8.07093, 8.07795, 8.05150, 8.21902, 8.…
#> $ votes <int> 1239, 1001, 898, 835, 799, 825, 822, 723, 692, …
#> $ comment_count <int> 7, 0, 1, 1, 1, 1, 3, 1, 1, 1, 2, 4
#> $ first_aired <dttm> 2013-01-15 21:00:00, 2013-01-22 21:00:00, 2013-…
#> $ updated_at <dttm> 2022-08-28 12:29:01, 2022-08-28 07:29:46, 2022-…
#> $ available_translations <list> <"de", "en", "es", "fr", "he", "nl", "pl", "ru"…
#> $ runtime <int> 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50
#> $ trakt <chr> "1405053", "1405054", "1405055", "1405056", "14…
#> $ tvdb <chr> "4471351", "4477746", "4477747", "4477748", "4…
#> $ imdb <chr> "tt2618234", "tt2618232", "tt2618236", "tt2618…
#> $ tmdb <chr> "910003", "910004", "910005", "910006", "91000…Or alternatively, get the trending shows:
shows_trending()
#> # A tibble: 10 × 8
#> watchers title year trakt slug tvdb imdb tmdb
#> <int> <chr> <int> <chr> <chr> <chr> <chr> <chr>
#> 1 47 Better Call Saul 2015 59660 better-… 2731… tt30… 60059
#> 2 41 Game of Thrones 2011 1390 game-of… 1213… tt09… 1399
#> 3 40 The Sandman 2022 149786 the-san… 3662… tt17… 90802
#> 4 31 House of the Dragon 2022 154574 house-o… 3715… tt11… 94997
#> 5 30 Breaking Bad 2008 1388 breakin… 81189 tt09… 1396
#> 6 28 See 2019 145781 see 3615… tt79… 80752
#> 7 27 Westworld 2016 99718 westwor… 2967… tt04… 63247
#> 8 22 She-Hulk: Attorney at Law 2022 151854 she-hul… 3686… tt10… 92783
#> 9 21 The Orville 2017 119017 the-orv… 3284… tt56… 71738
#> 10 21 Only Murders in the Building 2021 165314 only-mu… 3999… tt12… 1071…Maybe you just want to know how long it would take you to binge through these shows:
shows_trending(extended = "full") |>
transmute(
show = glue::glue("{title} ({year})"),
runtime_hms = hms::hms(minutes = runtime),
aired_episodes = aired_episodes,
runtime_aired = hms::hms(minutes = runtime * aired_episodes)
) |>
knitr::kable(
col.names = c("Show", "Episode Runtime", "Aired Episodes", "Total Runtime (aired)")
)| Show | Episode Runtime | Aired Episodes | Total Runtime (aired) |
|---|---|---|---|
| House of the Dragon (2022) | 01:00:00 | 1 | 01:00:00 |
| Better Call Saul (2015) | 00:45:00 | 63 | 47:15:00 |
| Game of Thrones (2011) | 01:00:00 | 73 | 73:00:00 |
| The Sandman (2022) | 00:48:00 | 11 | 08:48:00 |
| See (2019) | 01:00:00 | 17 | 17:00:00 |
| Westworld (2016) | 01:00:00 | 36 | 36:00:00 |
| For All Mankind (2019) | 01:00:00 | 30 | 30:00:00 |
| Stranger Things (2016) | 00:50:00 | 34 | 28:20:00 |
| Breaking Bad (2008) | 00:45:00 | 62 | 46:30:00 |
| The Big Bang Theory (2007) | 00:22:00 | 279 | 102:18:00 |
Please note though that episode runtime data may be inaccurate. In my experience, recent shows have fairly accurate runtime data, which is often not the case for older shows.
Credentials
The API requires at least a client id for the API calls.
Loading the package (or calling its functions via tRakt:: wil automatically set the app’s client id (see trakt_credentials()) – for extended use you should set your own credentials via environment variables in your .Renviron like this:
# tRakt
trakt_client_id=12fc1de7[...]3d629afdf2
trakt_client_secret=justabunchofstuffhere
trakt_username=jemus42-
trakt_client_idRequired. It’s used in the HTTP headers for the API calls, which is kind of a biggie. -
trakt_client_secret: Optional(ish). This is only required if you intend to make an authenticated request, which is only required by a small number of implemented API methods] (seevignette("Implemented-API-methods")). You can use this package perfectly fine for basic data collection without registering an application on trakt.tv. -
trakt_usernameOptional. For functions that retrieve a user’s watched shows or stats, this just sets the default value so you don’t have to keep supplying it in individual function calls when you’re just looking at your own data anyway.
To get your credentials, you have to have an (approved) app over at trakt.tv.
You theoretically never need to supply your own credentials. However, if you want to actually use this package for some project, I do not recommend relying on my credentials.
That would make me a sad panda. As of now, the trakt.tv API does not have any rate-limiting, but it’s not guaranteed to stay like this in the future. Be nice to their servers.
Code of Conduct
Please note that the tRakt project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.