This is a reference list of API methods available, their
endpoint URLs (with user-specified parameters indiciated by a
:
prefix) and a link to their respective implementation in
this package, if applicable.
Authenticated methods (there’s only a few) are indicated as such.
Note that not all available methods are listed here, especially those geared towards interactive apps – I highly doubt that people will want to post (or update) comments through this package.
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Text Query | search/:type?query= |
search_query()
|
Optional |
ID Lookup | search/:id_type/:id?type= |
search_id()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Trending | movies/trending |
movies_trending()
|
Optional |
Popular | movies/popular |
movies_popular()
|
Optional |
Played | movies/played/:period |
movies_played()
|
Optional |
Watched | movies/watched/:period |
movies_watched()
|
Optional |
Collected | movies/collected/:period |
movies_collected()
|
Optional |
Anticipated | movies/anticipated |
movies_anticipated()
|
Optional |
Box Office | movies/boxoffice |
movies_boxoffice()
|
Optional |
Updates | movies/updates/:start_date |
movies_updates()
|
Optional |
Summary | movies/:id |
movies_summary()
|
Optional |
Aliases | movies/:id/aliases |
movies_aliases()
|
Optional |
Releases | movies/:id/releases/:country |
movies_releases()
|
Optional |
Translations | movies/:id/translations/:language |
movies_translations()
|
Optional |
Comments | movies/:id/comments/:sort |
movies_comments()
|
Optional |
Lists | movies/:id/lists/:type/:sort |
movies_lists()
|
Optional |
People | movies/:id/people |
movies_people()
|
Optional |
Ratings | movies/:id/ratings |
movies_ratings()
|
Optional |
Related | movies/:id/related |
movies_related()
|
Optional |
Stats | movies/:id/stats |
movies_stats()
|
Optional |
Watching | movies/:id/watching |
movies_watching()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Trending | shows/trending |
shows_trending()
|
Optional |
Popular | shows/popular |
shows_popular()
|
Optional |
Played | shows/played/:period |
shows_played()
|
Optional |
Watched | shows/watched/:period |
shows_watched()
|
Optional |
Collected | shows/collected/:period |
shows_collected()
|
Optional |
Anticipated | shows/anticipated |
shows_anticipated()
|
Optional |
Updates | shows/updates/:start_date |
shows_updates()
|
Optional |
Summary | shows/:id |
shows_summary()
|
Optional |
Aliases | shows/:id/aliases |
shows_aliases()
|
Optional |
Translations | shows/:id/translations/:language |
shows_translations()
|
Optional |
Comments | shows/:id/comments/:sort |
shows_comments()
|
Optional |
Lists | shows/:id/lists/:type/:sort |
shows_lists()
|
Optional |
Collection Progress | shows/:id/progress/collection?hidden,specials,count_specials,last_activity | Required | |
Watched Progress | shows/:id/progress/watched?hidden,specials,count_specials,last_activity | Required | |
People | shows/:id/people |
shows_people()
|
Optional |
Ratings | shows/:id/ratings |
shows_ratings()
|
Optional |
Related | shows/:id/related |
shows_related()
|
Optional |
Stats | shows/:id/stats |
shows_stats()
|
Optional |
Watching | shows/:id/watching |
shows_watching()
|
Optional |
Next Episode | shows/:id/next_episode |
shows_next_episode()
|
Optional |
Last Episode | shows/:id/last_episode |
shows_last_episode()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Summary | shows/:id/seasons/:season |
seasons_summary()
|
Optional |
Season | shows/:id/seasons/:season/info |
seasons_season()
|
Optional |
Episodes | shows/:id/seasons/:season?translations= |
seasons_episodes()
|
Optional |
Comments | shows/:id/seasons/:season/comments/:sort |
seasons_comments()
|
Optional |
Lists | shows/:id/seasons/:season/lists/:type/:sort |
seasons_lists()
|
Optional |
People | shows/:id/seasons/:season/people |
seasons_people()
|
Optional |
Ratings | shows/:id/seasons/:season/ratings |
seasons_ratings()
|
Optional |
Stats | shows/:id/seasons/:season/stats |
seasons_stats()
|
Optional |
Watching | shows/:id/seasons/:season/watching |
seasons_watching()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Summary | shows/:id/seasons/:season/episodes/:episode |
episodes_summary()
|
Optional |
Translations | shows/:id/seasons/:season/episodes/:episode/translations/:language |
episodes_translations()
|
Optional |
Comments | shows/:id/seasons/:season/episodes/:episode/comments/:sort |
episodes_comments()
|
Optional |
Lists | shows/:id/seasons/:season/episodes/:episode/lists/:type/:sort |
episodes_lists()
|
Optional |
People | shows/:id/seasons/:season/episodes/:episode/people |
episodes_people()
|
Optional |
Ratings | shows/:id/seasons/:season/episodes/:episode/ratings |
episodes_ratings()
|
Optional |
Stats | shows/:id/seasons/:season/episodes/:episode/stats |
episodes_stats()
|
Optional |
Watching | shows/:id/seasons/:season/episodes/:episode/watching |
episodes_watching()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Summary | people/:id |
people_summary()
|
Optional |
Movies | people/:id/movies |
people_movies()
|
Optional |
Shows | people/:id/shows |
people_shows()
|
Optional |
Lists | people/:id/lists/:type/:sort |
people_lists()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Likes | users/:id/likes/:type |
user_likes()
|
Required |
Profile | users/:id |
user_profile()
|
Optional |
Collection | users/:id/collection/:type |
user_collection()
|
Optional |
Comments | users/:id/comments/:comment_type/:type?include_replies= |
user_comments()
|
Optional |
Lists | users/:id/lists |
user_lists()
|
Optional |
List | users/:id/lists/:list_id |
user_list()
|
Optional |
List Items | users/:id/lists/:list_id/items/:type |
user_list_items()
|
Optional |
List Comments | users/:id/lists/:list_id/comments/:sort |
user_list_comments()
|
Optional |
Followers | users/:id/followers |
user_followers()
|
Optional |
Following | users/:id/following |
user_following()
|
Optional |
Friends | users/:id/friends |
user_friends()
|
Optional |
History | users/:id/history/:type/:item_id?start_at=,end_at= |
user_history()
|
Optional |
Ratings | users/:id/ratings/:type/:rating |
user_ratings()
|
Optional |
Watchlist | users/:id/watchlist/:type/:sort |
user_watchlist()
|
Optional |
Watched | users/:id/watched/:type |
user_watched()
|
Optional |
Stats | users/:id/stats |
user_stats()
|
Optional |
Method | Endpoint | Implementation | Auth |
---|---|---|---|
Popular | lists/popular |
lists_popular()
|
Optional |
Trending | lists/trending |
lists_trending()
|
Optional |
These endpoints are used to check filter arguments. The output is cached in tidied up format as package datasets.
Section | Method | Endpoint | Implementation |
---|---|---|---|
certifications | List | certifications/:type |
?trakt_certifications
|
countries | List | countries/:type |
?trakt_countries
|
genres | List | genres/:type |
?trakt_genres
|
languages | List | languages/:type |
?trakt_languages
|
networks | List | networks |
?trakt_networks
|
Comments
comments_comment()
comments_replies()
comments_item()
comments_likes()
comments_trending()
comments_recent()
comments_updates()