@ -12,14 +12,31 @@ You can build different collections using the features of TheMovieDb.org (TMDb).
| [TMDb Show Details](#tmdb-show) | `tmdb_show_details` | Gets the show specified and updates the collection with the summary, poster, and background from the TMDb show | :x: | :heavy_check_mark: |
| [TMDb Company](#tmdb-company) | `tmdb_company` | Gets every movie from the TMDb company's movie list | :heavy_check_mark: | :x: |
| [TMDb Network](#tmdb-network) | `tmdb_network` | Gets every movie/show from the TMDb network's movie/show list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Popular](#tmdb-popular) | `tmdb_popular` | Gets the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Now Playing](#tmdb-now-playing) | `tmdb_now_playing` | Gets the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list | :heavy_check_mark: | :x: |
| [TMDb Top Rated](#tmdb-top-rated) | `tmdb_top_rated` | Gets the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Trending Daily](#tmdb-trending-daily) | `tmdb_trending_daily` | Gets the movies/shows in TMDb's Trending Daily list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Trending Weekly](#tmdb-trending-weekly) | `tmdb_trending_weekly` | Gets the movies/shows in TMDb's Trending Weekly list | :heavy_check_mark: | :heavy_check_mark: |
| [TMDb Discover](#tmdb-discover) | `tmdb_discover` | Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/discover) to get every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Now Playing | `tmdb_now_playing` | Gets the movies in the [TMDb Now Playing List](https://www.themoviedb.org/movie/now-playing) | :heavy_check_mark: | :x: |
| TMDb Popular | `tmdb_popular` | Gets the movies/shows in the [TMDb Popular Movies](https://www.themoviedb.org/movie)/[TMDb Popular Shows](https://www.themoviedb.org/tv) | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Top Rated | `tmdb_top_rated` | Gets the movies/shows in the [TMDb Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[TMDb Top Rated Shows](https://www.themoviedb.org/tv/top-rated) | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Trending Daily | `tmdb_trending_daily` | Gets the movies/shows Trending Daily on TMDb | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Trending Weekly | `tmdb_trending_weekly` | Gets the movies/shows Trending Weekly on TMDb | :heavy_check_mark: | :heavy_check_mark: |
* For `tmdb_collection`, `tmdb_list`, `tmdb_movie`, `tmdb_show`, `tmdb_company`, or `tmdb_network` you can use the full URL or just type in the TMDb ID.
### Expected Input
The builders below are expected to have the full URL to the item or the TMDb ID of the item.
* [TMDb Collection](#tmdb-collection) and [TMDb Collection Details](#tmdb-collection)
* [TMDb List](#tmdb-list) and [TMDb List Details](#tmdb-list)
* [TMDb Movie](#tmdb-movie) and [TMDb Movie Details](#tmdb-movie)
* [TMDb Show](#tmdb-show) and [TMDb Show Details](#tmdb-show)
* [TMDb Company](#tmdb-company)
* [TMDb Network](#tmdb-network)
The builders below are expected to to have a single integer value of how many movies/shows to query. The `sync_mode: sync` option is also recommended for these builders since the lists they're based on are continuously updated.
* [TMDb Popular](#tmdb-popular)
* [TMDb Now Playing](#tmdb-now-playing)
* [TMDb Top Rated](#tmdb-top-rated)
* [TMDb Trending Daily](#tmdb-trending-daily)
* [TMDb Trending Weekly](#tmdb-trending-weekly)
[TMDb Discover](#tmdb-discover)'s attributes are detailed [below](#tmdb-discover).
### TMDb Collection
Gets every movie in the TMDb collection.
@ -99,7 +116,7 @@ collections:
collections:
Anaconda:
tmdb_collection: 105995
tmdb_movie: 336560
tmdb_movie_details: 336560
```
### TMDb Show
@ -124,6 +141,14 @@ collections:
* You can specify multiple shows in `tmdb_show_details` but it will only use the first one to update the collection details.
* Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified.
```yaml
collections:
Star Wars (Animated Shows):
tmdb_show_details:
- 4194
- 60554
```
### TMDb Company
Gets every movie from the TMDb company's movie list.
Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/discover) to get every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided
### TMDb Popular
Gets the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list.
```yaml
collections:
TMDb Popular:
tmdb_popular: 30
sync_mode: sync
```
### TMDb Now Playing
Gets the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list.
### TMDb Popular
```yaml
collections:
TMDb Now Playing:
tmdb_now_playing: 30
sync_mode: sync
```
### TMDb Top Rated
Gets the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list.
```yaml
collections:
TMDb Top Rated:
tmdb_top_rated: 30
sync_mode: sync
```
### TMDb Trending Daily
Gets the movies/shows in TMDb's Trending Daily list.
```yaml
collections:
TMDb Daily Trending:
tmdb_trending_daily: 30
sync_mode: sync
```
### TMDb Trending Weekly
Gets the movies/shows in TMDb's Trending Weekly list.
```yaml
collections:
TMDb Weekly Trending:
tmdb_trending_weekly: 30
sync_mode: sync
```
### TMDb Discover
Uses [TMDb's Discover Search](https://www.themoviedb.org/documentation/api/discover) to get every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided
| Type | Description |
| :-- | :-- |
| String | Any number of alphanumeric characters |
| Integer | Any whole number greater then zero i.e. 2, 10, 50 |
| Number | Any number greater then zero i.e. 2.5, 7.4, 9 |
| Boolean | Must be `true` or `false` |
| Date: `MM/DD/YYYY` | Date that fits the specified format |
| Year: `YYYY` | Year must be a 4 digit integer i.e. 1990 |
### TMDb Trending
#### Discover Movies Parameters
| Movie Parameters | Description | Type |
| :-- | :-- | :--: |
| `limit` | Specify how many movies you want returned by the query. (default: 100) | Integer |
| `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` |
| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. | `^[A-Z]{2}$` |
| `sort_by` | Choose from one of the many available sort options. (default: `popularity.desc`) | See [sort options](#sort-options) below |
| `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification. | String |
| `certification` | Filter results with a valid certification from the `certification_country` parameter. | String |
| `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value. | String |
| `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value. | String |
| `include_adult` | A filter and include or exclude adult movies. | Boolean |
| `primary_release_year` | A filter to limit the results to a specific primary release year. | Year: YYYY |
| `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value. | Date: `MM/DD/YYYY` |
| `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value. | Date: `MM/DD/YYYY` |
| `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value. | Date: `MM/DD/YYYY` |
| `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value. | Date: `MM/DD/YYYY` |
| `year` | A filter to limit the results to a specific year (looking at all release dates). | Year: YYYY |
| `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value. | Integer |
| `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value. | Integer |
| `vote_average.gte` | Filter and only include movies that have a rating that is greater or equal to the specified value. | Number |
| `vote_average.lte` | Filter and only include movies that have a rating that is less than or equal to the specified value. | Number |
| `with_cast` | A comma separated list of person ID's. Only include movies that have one of the ID's added as an actor. | String |
| `with_crew` | A comma separated list of person ID's. Only include movies that have one of the ID's added as a crew member. | String |
| `with_people` | A comma separated list of person ID's. Only include movies that have one of the ID's added as a either a actor or a crew member. | String |
| `with_companies` | A comma separated list of production company ID's. Only include movies that have one of the ID's added as a production company. | String |
| `with_genres` | Comma separated value of genre ids that you want to include in the results. | String |
| `without_genres` | Comma separated value of genre ids that you want to exclude from the results. | String |
| `with_keywords` | A comma separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword. | String |
| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic. | String |
| `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value. | Integer |
| `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value. | Integer |
| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value. | String |
#### Discover Shows Parameters
| Show Parameters | Description | Type |
| :-- | :-- | :--: |
| `limit` | Specify how many movies you want returned by the query. (default: 100) | Integer |
| `language` | Specify a language to query translatable fields with. (default: en-US) | `([a-z]{2})-([A-Z]{2})` |
| `sort_by` | Choose from one of the many available sort options. (default: `popularity.desc`) | See [sort options](#sort-options) below |
| `air_date.gte` | Filter and only include TV shows that have a air date (by looking at all episodes) that is greater or equal to the specified value. | Date: `MM/DD/YYYY` |
| `air_date.lte` | Filter and only include TV shows that have a air date (by looking at all episodes) that is less than or equal to the specified value. | Date: `MM/DD/YYYY` |
| `first_air_date.gte` | Filter and only include TV shows that have a original air date that is greater or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date. | Date: `MM/DD/YYYY` |
| `first_air_date.lte` | Filter and only include TV shows that have a original air date that is less than or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date. | Date: `MM/DD/YYYY` |
| `first_air_date_year` | Filter and only include TV shows that have a original air date year that equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date. | Year: YYYY |
| `include_null_first_air_dates` | Use this filter to include TV shows that don't have an air date while using any of the `first_air_date` filters. | Boolean |
| `timezone` | Used in conjunction with the `air_date.gte/lte` filter to calculate the proper UTC offset. (default: America/New_York) | String |
| `vote_count.gte` | Filter and only include TV that have a vote count that is greater or equal to the specified value. | Integer |
| `vote_count.lte` | Filter and only include TV that have a vote count that is less than or equal to the specified value. | Integer |
| `vote_average.gte` | Filter and only include TV that have a rating that is greater or equal to the specified value. | Number |
| `vote_average.lte` | Filter and only include TV that have a rating that is less than or equal to the specified value. | Number |
| `with_networks` | Comma separated value of network ids that you want to include in the results. | String |
| `with_companies` | A comma separated list of production company ID's. Only include movies that have one of the ID's added as a production company. | String |
| `with_genres` | Comma separated value of genre ids that you want to include in the results. | String |
| `without_genres` | Comma separated value of genre ids that you want to exclude from the results. | String |
| `with_keywords` | A comma separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword. | String |
| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic. | String |
| `with_runtime.gte` | Filter and only include TV shows with an episode runtime that is greater than or equal to a value. | Integer |
| `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value. | Integer |
| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value. | String |
| `screened_theatrically` | Filter results to include items that have been screened theatrically. | Boolean |
meisnate12
3 years ago