The expected input is a supported Letterboxd URL. Multiple values are supported as either a list or a comma-separated string.
Private links (which start with the URL https://boxd.it/) are also supported.
Kometa now uses letterboxdpy for Letterboxd access. Standard list URLs continue to work, and /films/... URLs remain supported.
Use the Letterboxd Discovery Builders for people, studios, genres, themes, countries, languages, film collections, and similar movies.
You can add different filters directly to this Builder.
Filter Attribute
Description
limit
Description: Max number of items per returned. Values: number greater than 1
rating
Description: Search for the specified rating range. The rating is the list owner's rating not site wide rating. Values: range of int i.e. 8-10 (convert Letterboxd stars to a 10 point scale)
year
Description: Search for the specified year range. Values: range of int i.e. 1990-1999
note
Description: Search for the specified value in the note. The note is the list owner's note not site wide note. Values: Any String
The sync_mode: sync and collection_order: custom Setting are recommended since the lists are continuously updated and in a specific order.
Using the limit filter attribute is recommended when using a Letterboxd Film Search as the number of results returned could be very large.
Filter Support Depends on URL Type
The year filter works for both standard list URLs and /films/... URLs.
The rating and note filters are only available for /films/... URLs exposed through letterboxdpy. Standard user list URLs do not expose per-item owner ratings or notes, so those filters are ignored for those URLs.
Details Builder
You can replace letterboxd_list with letterboxd_list_details if you would like to fetch and use the description from the list
collections:Vulture’s 101 Best Movie Endings:letterboxd_list:https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/collection_order:customsync_mode:sync
You can update the collection details with the Letterboxd List's description by using letterboxd_list_details.
You can specify multiple collections in letterboxd_list_details but it will only use the first one to update the collection summary.
collections:Vulture’s 101 Best Movie Endings:letterboxd_list_details:https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/collection_order:customsync_mode:sync
collections:Vulture’s 101 Best Movie Endings From the 90s:letterboxd_list_details:url:https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/year:1990-1999collection_order:customsync_mode:sync
These services do not store season or episode-level ratings, using these options will allow show ratings to be
applied at the season or episode level.
YAML Lists Explained
YAML supports different ways to define lists. Below are some common methods:
1. List Within a Mapping
fruits:
- apple
- banana
- cherry
2. Inline Style
fruits: [ apple, banana, cherry ]
Each style can be used depending on your needs. The block style is typically more readable for longer lists,
while the inline style is compact and useful for short lists.
YAML Dictionaries Explained
Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing
the indentation,
or new dictionaries can be created at the same level by resolving the previous one.
cache: true cache_expiration: 60
The "keys" are cache and cache_expiration and the "values" are true and
60 respectively.
You can use multiple score filters but the number will have to match every filter. All unrated items are considered
to have a 0 rating.
These filters only work if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL) or to an account's Reviews (i.e. it should have
/USERNAME/films/reviews/ in the URL).
This filter only works if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL).
When title is not provided and the mapping name was not specified as an ID, the default behaviour is to
use the mapping name as title for matching.
When mapping_id is not provided and the mapping name was specified as an ID, the default behaviour is
to use the mapping name as mapping_id for matching.
When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will
check the movie's filepath for {edition-...} to determine what the edition is.
Requires Plex Pass.
Must be using the New Plex Movie Agent or the New Plex TV Agent.
Each default has a key that when calling to effect a specific collection/overlay you must replace
<<key>> with when calling.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
Also is a Tag Filter and can use all of those modifiers.
Requires Template Variables to function
Designed to use the TRaSH Guides filename naming scheme
Editions overlay is designed to use the Editions field within Plex (which requires Plex Pass to use) or the TRaSH Guides filename naming scheme
Designed to use the TRaSH Guides filename naming scheme
While these overlays can technically be applied at this level, they were not designed for it. For example, a show's
season cannot have a resolution since it is not a video file, and an episode cannot have a Common Sense rating since
only Movies and Shows are rated by Common Sense.