Configuring FlickList is optional but is required for flicklist_* builders to function.
The flicklist attribute is found at the root of the config file. FlickList authentication is a single, non-expiring
API key; there is no OAuth flow, no refresh token, and no expiry to maintain. The only lifecycle event is the key
being revoked, which returns a 401 and requires minting a new key.
FlickList's own dashboard. Any FlickList account can mint a key from Developer → Your Apps, no waiting or
approval required. Read and write scopes are both selectable, and page size is configurable there (up to 500).
Kometa Utilities. A future addition to the Kometa Utilities website, the
same site used to authenticate Plex, MyAnimeList, SIMKL, and Trakt, will offer a guided device-code flow that
mints a key and hands you a paste-ready flicklist: block. Not yet available; this page will be updated once
it ships.
flicklist_list, flicklist_list_details, and flicklist_user_lists work with a read scope key (or, for public
lists, no key at all). Every other flicklist_* builder reads the authenticated user's own data and requires
read scope. A key missing the required scope returns a clear error naming which scope is missing.
FlickList allows 1,000 requests/hour per API key. Builds that page through list contents or a user's public lists
consume more requests the larger those lists are; a user with dozens of public lists will see a correspondingly
longer run and a log line naming how many lists are being processed. Kometa backs off automatically on a 429
and honors the Retry-After header when present.
Rotten Tomatoes and Metacritic scores, and structured awards data, are not available from FlickList's API and
there are no plans to add them. Kometa's existing MDBList/OMDb bridge remains the source for that data regardless
of whether FlickList is configured.
Public FlickList lists can be read without any credential at all, but Kometa currently requires the flicklist
config block to be present before any flicklist_* builder is accepted — consistent with how every other Kometa
connector works. If you only ever consume public lists and would rather skip configuring an API key, this is a
known limitation, not a bug.
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.