Skip to content

Latest commit

 

History

History
432 lines (386 loc) · 20.4 KB

TMDb-Builders.md

File metadata and controls

432 lines (386 loc) · 20.4 KB
Raw

You can build different collections using the features of TheMovieDb.org (TMDb).

Name Attribute Description Works with Movies Works with Shows
TMDb Collection tmdb_collection Gets every movie in the TMDb collection ✔️ ❌
TMDb Collection Details tmdb_collection_details Gets every movie in the TMDb collection and updates the collection with the summary, poster, and background from the TMDb collection ✔️ ❌
TMDb List tmdb_list Gets every movie/show in the TMDb List ✔️ ✔️
TMDb List Details tmdb_list_details Gets every movie/show in the TMDb List and updates the collection with the description of the TMDb list ✔️ ✔️
TMDb Movie tmdb_movie Gets the movie specified ✔️ ❌
TMDb Movie Details tmdb_movie_details Gets the movie specified and updates the collection with the summary, poster, and background from the TMDb movie ✔️ ❌
TMDb Show tmdb_show Gets the show specified ❌ ✔️
TMDb Show Details tmdb_show_details Gets the show specified and updates the collection with the summary, poster, and background from the TMDb show ❌ ✔️
TMDb Company tmdb_company Gets every movie/show from the TMDb company's movie/show list ✔️ ✔️
TMDb Network tmdb_network Gets every show from the TMDb network's show list ❌ ✔️
TMDb Keyword tmdb_keyword Gets every movie/show from the TMDb keyword's movie/show list ✔️ ✔️
TMDb Popular tmdb_popular Gets the movies/shows in TMDb's Popular Movies/Popular Shows list ✔️ ✔️
TMDb Now Playing tmdb_now_playing Gets the movies in TMDb's Now Playing list ✔️ ❌
TMDb Top Rated tmdb_top_rated Gets the movies/shows in TMDb's Top Rated Movies/Top Rated Shows list ✔️ ✔️
TMDb Trending Daily tmdb_trending_daily Gets the movies/shows in TMDb's Trending Daily list ✔️ ✔️
TMDb Trending Weekly tmdb_trending_weekly Gets the movies/shows in TMDb's Trending Weekly list ✔️ ✔️
TMDb Discover tmdb_discover Uses TMDb's Discover Search to get every movie/show based on the movie search parameters or show search parameters provided ✔️ ✔️

Expected Input

The builders below are expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string.

The builders below are expected 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 Discover's attributes are detailed below.

TMDb Collection

Gets every movie in the TMDb collection.

collections:
  The Lord of the Rings:
    tmdb_collection: https://www.themoviedb.org/collection/119
  The Hobbit:
    tmdb_collection: 121938
  Middle Earth:
    tmdb_collection:
      - 119
      - https://www.themoviedb.org/collection/121938
  • You can update the collection details with the TMDb collection's summary, poster, and background by using tmdb_collection_details.
  • You can specify multiple collections in tmdb_collection_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.
collections:
  The Lord of the Rings:
    tmdb_collection_details: https://www.themoviedb.org/collection/119
  The Hobbit:
    tmdb_collection_details: 121938
  Middle Earth:
    tmdb_collection_details:
      - 119
      - https://www.themoviedb.org/collection/121938

TMDb List

Gets every movie/show in the TMDb List.

collections:
  Top 50 Grossing Films of All Time (Worldwide):
    tmdb_list: https://www.themoviedb.org/list/10
collections:
  Top 50 Grossing Films of All Time (Worldwide):
    tmdb_list: 10
  • You can update the collection details with the TMDb list's description by using tmdb_list_details.
  • You can specify multiple lists in tmdb_list_details but it will only use the first one to update the collection details.
collections:
  Top 50 Grossing Films of All Time (Worldwide):
    tmdb_list_details: 10

TMDb Movie

Gets the movie specified.

collections:
  Anaconda:
    tmdb_collection: https://www.themoviedb.org/collection/105995
    tmdb_movie: https://www.themoviedb.org/movie/336560
collections:
  Anaconda:
    tmdb_collection: 105995
    tmdb_movie: 336560
  • You can update the collection details with the TMDb movie's summary, poster, and background by using tmdb_movie_details.
  • You can specify multiple movies in tmdb_movie_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.
collections:
  Anaconda:
    tmdb_collection: 105995
    tmdb_movie_details: 336560

TMDb Show

Gets the show specified.

collections:
  Star Wars (Animated Shows):
    tmdb_show:
      - https://www.themoviedb.org/tv/4194-star-wars-the-clone-wars
      - https://www.themoviedb.org/tv/60554-star-wars-rebels
collections:
  Star Wars (Animated Shows):
    tmdb_show:
      - 4194
      - 60554
  • You can update the collection details with the TMDb show's summary, poster, and background by using tmdb_show_details.
  • 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.
collections:
  Star Wars (Animated Shows):
    tmdb_show_details:
      - 4194
      - 60554

TMDb Company

Gets every movie from the TMDb company's movie list.

collections:
  Studio Ghibli:
    tmdb_company: 10342
collections:
  Studio Ghibli:
    tmdb_company: https://www.themoviedb.org/company/10342

TMDb Network

Gets every movie/show from the TMDb network's movie/show list.

collections:
  CBS:
    tmdb_network: 16
collections:
  CBS:
    tmdb_network: https://www.themoviedb.org/network/16

TMDb Keyword

Gets every movie/show from the TMDb keyword's movie/show list.

collections:
  Marvel Cinematic Universe:
    tmdb_keyword: 180547
collections:
  Marvel Cinematic Universe:
    tmdb_keyword: https://www.themoviedb.org/keyword/180547

TMDb Popular

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

collections:
  TMDb Popular:
    tmdb_popular: 30
    sync_mode: sync

TMDb Now Playing

Gets the movies in TMDb's Now Playing list.

collections:
  TMDb Now Playing:
    tmdb_now_playing: 30
    sync_mode: sync

TMDb Top Rated

Gets the movies/shows in TMDb's Top Rated Movies/Top Rated Shows list.

collections:
  TMDb Top Rated:
    tmdb_top_rated: 30
    sync_mode: sync

TMDb Trending Daily

Gets the movies/shows in TMDb's Trending Daily list.

collections:
  TMDb Daily Trending:
    tmdb_trending_daily: 30
    sync_mode: sync

TMDb Trending Weekly

Gets the movies/shows in TMDb's Trending Weekly list.

collections:
  TMDb Weekly Trending:
    tmdb_trending_weekly: 30
    sync_mode: sync

TMDb Discover

Uses TMDb's Discover Search to get every movie/show based on the movie search parameters or show search parameters provided

Type Description
String Any number of alphanumeric characters
Integer Any whole number greater than zero i.e. 2, 10, 50
Number Any number greater than 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

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 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 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 either an 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 to be 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 below
air_date.gte Filter and only include TV shows that have an 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 an 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 an 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

Sort Options

Sort Option Movie Sort Show Sort
popularity.asc ✔️ ✔️
popularity.desc ✔️ ✔️
original_title.asc ✔️ ❌
original_title.desc ✔️ ❌
revenue.asc ✔️ ❌
revenue.desc ✔️ ❌
release_date.asc ✔️ ❌
release_date.desc ✔️ ❌
primary_release_date.asc ✔️ ❌
primary_release_date.desc ✔️ ❌
first_air_date.asc ❌ ✔️
first_air_date.desc ❌ ✔️
vote_average.asc ✔️ ✔️
vote_average.desc ✔️ ✔️
vote_count.asc ✔️ ❌
vote_count.desc ✔️ ❌ 
collections:
  Movies Released in October 2020:
    tmdb_discover:
      primary_release_date.gte: 10/01/2020
      primary_release_date.lte: 10/31/2020
collections:
  Popular Movies:
    tmdb_discover:
      sort_by: popularity.desc
collections:
  Highest Rated R Movies:
    tmdb_discover:
      certification_country: US
      certification: R
      sort_by: vote_average.desc
collections:
  Most Popular Kids Movies:
    tmdb_discover:
      certification_country: US
      certification.lte: G
      sort_by: popularity.desc
collections:
  Highest Rated Movies From 2010:
    tmdb_discover:
      primary_release_year: 2010
      sort_by: vote_average.desc
collections:
  Best Dramas From 2014:
    tmdb_discover:
      with_genres: 18
      primary_release_year: 2014
      sort_by: vote_average.desc
collections:
  Highest Rated Science Fiction Movies with Tom Cruise:
    tmdb_discover:
      with_genres: 878
      with_cast: 500
      sort_by: vote_average.desc
collections:
  Highest Grossing Comedy Movies with Will Ferrell:
    tmdb_discover:
      with_genres: 35
      with_cast: 23659
      sort_by: revenue.desc
collections:
  Top Rated Movies with Brad Pitt and Edward Norton:
    tmdb_discover:
      with_people: 287,819
      sort_by: vote_average.desc
collections:
  Popular Movies with David Fincher and Rooney Mara:
    tmdb_discover:
      with_people: 108916,7467
      sort_by: popularity.desc
collections:
  Top Rated Dramas:
    tmdb_discover:
      with_genres: 18
      sort_by: vote_average.desc
      vote_count.gte: 10
collections:
  Highest Grossing R Movies with Liam Neeson:
    tmdb_discover:
      certification_country: US
      certification: R
      sort_by: revenue.desc
      with_cast: 3896