Plex-Meta-Manager/docs/metadata/builders/trakt.md

19 KiB

Trakt Builders

You can find items using the features of Trakt.tv (Trakt).

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

Attribute Description Works with Movies Works with Shows Works with Playlists and Custom Sort
trakt_list Finds every item in the Trakt List
trakt_list_details Finds every item in the Trakt List and updates the collection summary with the list description
trakt_watchlist Finds every item in a Users Watchlist
trakt_collection Finds every item in a Users Collection
trakt_trending Finds the movies/shows in Trakt's Trending Movies/Shows list
trakt_popular Finds the movies/shows in Trakt's Popular Movies/Shows list
trakt_recommended_personal Finds the movies/shows in Trakt's Personal Recommendations for your User Movies/Shows
trakt_recommended_daily Finds the movies/shows in Trakt's Daily Recommended Movies/Shows list
trakt_recommended_weekly Finds the movies/shows in Trakt's Weekly Recommended Movies/Shows list
trakt_recommended_monthly Finds the movies/shows in Trakt's Monthly Recommended Movies/Shows list
trakt_recommended_yearly Finds the movies/shows in Trakt's Yearly Recommended Movies/Shows list
trakt_recommended_all Finds the movies/shows in Trakt's All-Time Recommended Movies/Shows list
trakt_watched_daily Finds the movies/shows in Trakt's Daily Watched Movies/Shows list
trakt_watched_weekly Finds the movies/shows in Trakt's Weekly Watched Movies/Shows list
trakt_watched_monthly Finds the movies/shows in Trakt's Monthly Watched Movies/Shows list
trakt_watched_yearly Finds the movies/shows in Trakt's Yearly Watched Movies/Shows list
trakt_watched_all Finds the movies/shows in Trakt's All-Time Watched Movies/Shows list
trakt_collected_daily Finds the movies/shows in Trakt's Daily Collected Movies/Shows list
trakt_collected_weekly Finds the movies/shows in Trakt's Weekly Collected Movies/Shows list
trakt_collected_monthly Finds the movies/shows in Trakt's Monthly Collected Movies/Shows list
trakt_collected_yearly Finds the movies/shows in Trakt's Yearly Collected Movies/Shows list
trakt_collected_all Finds the movies/shows in Trakt's All-Time Collected Movies/Shows list
trakt_boxoffice Finds the 10 movies in Trakt's Top Box Office Movies list

Trakt List

Finds every item in the Trakt List.

The expected input is a Trakt List URL. Multiple values are supported only as a list.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Christmas:
    trakt_list:
      - https://trakt.tv/users/movistapp/lists/christmas-movies
      - https://trakt.tv/users/2borno2b/lists/christmas-movies-extravanganza
    sync_mode: sync
collections:
  Reddit Top 250:
    trakt_list: https://trakt.tv/users/jay-greene/lists/reddit-top-250-2019-edition
    collection_order: custom
    sync_mode: sync
  • 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
    collection_order: custom
    sync_mode: sync

Trakt User Watchlist

Finds every item 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Watchlist:
    trakt_watchlist: me
    collection_order: custom
    sync_mode: sync

Trakt User Collection

Finds every item 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

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

Finds 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Trending:
    trakt_trending: 30
    collection_order: custom
    sync_mode: sync

Finds 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Popular:
    trakt_popular: 30
    collection_order: custom
    sync_mode: sync

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

Builder Period Movie List Show List
trakt_recommended_personal Custom Movies Shows
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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Recommended:
    trakt_recommended_weekly: 30
    collection_order: custom
    sync_mode: sync

Trakt Watched

Finds 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Watched:
    trakt_watched_weekly: 30
    collection_order: custom
    sync_mode: sync

Trakt Collected

Finds 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 and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Collected:
    trakt_collected_weekly: 30
    collection_order: custom
    sync_mode: sync

Trakt Box Office

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

The expected input is true.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trakt Collected:
    trakt_boxoffice: true
    collection_order: custom
    sync_mode: sync