Skip to content

Latest commit

 

History

History
195 lines (153 loc) · 12.1 KB

Trakt-Builders.md

File metadata and controls

195 lines (153 loc) · 12.1 KB

You can build different collections using the features of Trakt.tv (Trakt).

Configuring Trakt in the config is required for any of these builders.

Name Attribute Description Works with Movies Works with Shows
Trakt List trakt_list Gets every movie/show in the Trakt List ✔️ ✔️
Trakt List Details trakt_list_details Gets every movie/show in the Trakt List and updates the collection summary with the list description ✔️ ✔️
Trakt User Watchlist trakt_watchlist Gets every movie/show in a Users Watchlist ✔️ ✔️
Trakt User Collection trakt_collection Gets every movie/show in a Users Collection ✔️ ✔️
Trakt Trending trakt_trending Gets the movies/shows in Trakt's Trending Movies/Shows list ✔️ ✔️
Trakt Popular trakt_popular Gets the movies/shows in Trakt's Popular Movies/Shows list ✔️ ✔️
Trakt Recommended Daily trakt_recommended_daily Gets the movies/shows in Trakt's Daily Recommended Movies/Shows list ✔️ ✔️
Trakt Recommended Weekly trakt_recommended_weekly Gets the movies/shows in Trakt's Weekly Recommended Movies/Shows list ✔️ ✔️
Trakt Recommended Monthly trakt_recommended_monthly Gets the movies/shows in Trakt's Monthly Recommended Movies/Shows list ✔️ ✔️
Trakt Recommended Yearly trakt_recommended_yearly Gets the movies/shows in Trakt's Yearly Recommended Movies/Shows list ✔️ ✔️
Trakt Recommended All-Time trakt_recommended_all Gets the movies/shows in Trakt's All-Time Recommended Movies/Shows list ✔️ ✔️
Trakt Watched Daily trakt_watched_daily Gets the movies/shows in Trakt's Daily Watched Movies/Shows list ✔️ ✔️
Trakt Watched Weekly trakt_watched_weekly Gets the movies/shows in Trakt's Weekly Watched Movies/Shows list ✔️ ✔️
Trakt Watched Monthly trakt_watched_monthly Gets the movies/shows in Trakt's Monthly Watched Movies/Shows list ✔️ ✔️
Trakt Watched Yearly trakt_watched_yearly Gets the movies/shows in Trakt's Yearly Watched Movies/Shows list ✔️ ✔️
Trakt Watched All-Time trakt_watched_all Gets the movies/shows in Trakt's All-Time Watched Movies/Shows list ✔️ ✔️
Trakt Collected Daily trakt_collected_daily Gets the movies/shows in Trakt's Daily Collected Movies/Shows list ✔️ ✔️
Trakt Collected Weekly trakt_collected_weekly Gets the movies/shows in Trakt's Weekly Collected Movies/Shows list ✔️ ✔️
Trakt Collected Monthly trakt_collected_monthly Gets the movies/shows in Trakt's Monthly Collected Movies/Shows list ✔️ ✔️
Trakt Collected Yearly trakt_collected_yearly Gets the movies/shows in Trakt's Yearly Collected Movies/Shows list ✔️ ✔️
Trakt Collected All-Time trakt_collected_all Gets the movies/shows in Trakt's All-Time Collected Movies/Shows list ✔️ ✔️
Trakt Box Office trakt_boxoffice Gets the 10 movies in Trakt's Top Box Office Movies list ✔️

Trakt List

Gets every movie/show in the Trakt List.

The expected input is a Trakt List URL. Multiple values are supported as either a list or a comma-separated string.

collections:
  Christmas:
    trakt_list:
      - https://trakt.tv/users/movistapp/lists/christmas-movies
      - https://trakt.tv/users/2borno2b/lists/christmas-movies-extravanganza
collections:
  Reddit Top 250:
    trakt_list: https://trakt.tv/users/jay-greene/lists/reddit-top-250-2019-edition
  • You can update the collection details with the Trakt List's description by using trakt_list_details.
  • You can specify multiple collections in trakt_list_details but it will only use the first one to update the collection summary.
collections:
  Reddit Top 250:
    trakt_list_details: https://trakt.tv/users/jay-greene/lists/reddit-top-250-2019-edition

Trakt User Watchlist

Gets every movie/show in a Users Watchlist.

The expected input is a user's Trakt Username or me. Multiple values are supported as either a list or a comma-separated string.

The sync_mode: sync option is also recommended since the Trakt Watchlists are continuously updated.

collections:
  Trakt Watchlist:
    trakt_watchlist:
      - me
      - traktbuddy
    sync_mode: sync

Trakt User Collection

Gets every movie/show in a Users Collection.

The expected input is a user's Trakt Username or me. Multiple values are supported as either a list or a comma-separated string.

The sync_mode: sync option is also recommended since the Trakt Watchlists are continuously updated.

collections:
  Trakt Collection:
    trakt_collection:
      - me
      - traktbuddy
    sync_mode: sync

Trakt Trending

Gets the movies/shows in Trakt's Trending Movies/Shows list.

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync option is also recommended since the Trakt Trending lists are continuously updated.

collections:
  Trakt Trending:
    trakt_trending: 30
    sync_mode: sync

Trakt Popular

Gets the movies/shows in Trakt's Popular Movies/Shows list.

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync option is also recommended since the Trakt Popular lists are continuously updated.

collections:
  Trakt Popular:
    trakt_popular: 30
    sync_mode: sync

Trakt Recommended

Gets the movies/shows in Trakt's Recommended lists.

Builder Period Movie List Show List
trakt_recommended_daily Daily Daily Movies Daily Shows
trakt_recommended_weekly Weekly Weekly Movies Weekly Shows
trakt_recommended_monthly Monthly Monthly Movies Monthly Shows
trakt_recommended_yearly Yearly Yearly Movies Yearly Shows
trakt_recommended_all All-Time All-Time Movies All-Time Shows

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync option is also recommended since the Trakt Recommended lists are continuously updated.

collections:
  Trakt Recommended:
    trakt_recommended_weekly: 30
    sync_mode: sync

Trakt Watched

Gets the movies/shows in Trakt's Watched lists.

Builder Period Movie List Show List
trakt_watched_daily Daily Daily Movies Daily Shows
trakt_watched_weekly Weekly Weekly Movies Weekly Shows
trakt_watched_monthly Monthly Monthly Movies Monthly Shows
trakt_watched_yearly Yearly Yearly Movies Yearly Shows
trakt_watched_all All-Time All-Time Movies All-Time Shows

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync option is also recommended since the Trakt Watched lists are continuously updated.

collections:
  Trakt Watched:
    trakt_watched_weekly: 30
    sync_mode: sync

Trakt Collected

Gets the movies/shows in Trakt's Collected Movies/Shows list.

Builder Period Movie List Show List
trakt_collected_daily Daily Daily Movies Daily Shows
trakt_collected_weekly Weekly Weekly Movies Weekly Shows
trakt_collected_monthly Monthly Monthly Movies Monthly Shows
trakt_collected_yearly Yearly Yearly Movies Yearly Shows
trakt_collected_all All-Time All-Time Movies All-Time Shows

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync option is also recommended since the Trakt Collected lists are continuously updated.

collections:
  Trakt Collected:
    trakt_collected_weekly: 30
    sync_mode: sync

Trakt Box Office

Gets the 10 movies in Trakt's Top Box Office Movies list.

The expected input is true.

The sync_mode: sync option is also recommended since the Trakt Box Office list is continuously updated.

collections:
  Trakt Collected:
    trakt_boxoffice: true
    sync_mode: sync