2022-03-08 08:06:22 +00:00
# Trakt Builders
You can find items using the features of [Trakt.tv ](https://trakt.tv/ ) (Trakt).
[Configuring Trakt ](../../config/trakt ) in the config is required for any of these builders.
2022-03-27 06:26:08 +00:00
| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort |
|:--------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------:|:----------------:|:------------------------------------:|
| [`trakt_list` ](#trakt-list ) | Finds every movie/show in the Trakt List | ✅ | ✅ | ✅ |
| [`trakt_list_details` ](#trakt-list ) | Finds every movie/show in the Trakt List and updates the collection summary with the list description | ✅ | ✅ | ✅ |
| [`trakt_chart` ](#trakt-chart ) | Finds the movies/shows in the Trakt Chart | ✅ | ✅ | ✅ |
| [`trakt_userlist` ](#trakt-userlist ) | Finds every movie/show in the Trakt Userlist | ✅ | ✅ | ✅ |
| [`trakt_recommendations` ](#trakt-recommendations ) | Finds the movies/shows in Trakt's Personal Recommendations for your User [Movies ](https://trakt.docs.apiary.io/#reference/recommendations/movies/get-movie-recommendations )/[Shows](https://trakt.docs.apiary.io/#reference/recommendations/shows/get-show-recommendations) | ✅ | ✅ | ✅ |
| [`trakt_boxoffice` ](#trakt-box-office ) | Finds the 10 movies in Trakt's Top Box Office [Movies ](https://trakt.tv/movies/boxoffice ) list | ✅ | ❌ | ✅ |
2022-03-08 08:06:22 +00:00
## Trakt List
Finds every item in the Trakt List.
2022-03-09 23:59:31 +00:00
The expected input is a Trakt List URL. Multiple values are supported only as a list.
2022-03-08 08:06:22 +00:00
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
2022-03-27 06:26:08 +00:00
**Trakt Lists cannot be sorted through the API, but the list is always returned to the default list order if you own the list.**
2022-03-08 08:06:22 +00:00
```yaml
collections:
Christmas:
trakt_list:
- https://trakt.tv/users/movistapp/lists/christmas-movies
- https://trakt.tv/users/2borno2b/lists/christmas-movies-extravanganza
sync_mode: sync
```
```yaml
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.
```yaml
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
```
2022-03-27 06:26:08 +00:00
## Trakt Chart
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
Finds the movies/shows in the Trakt Chart. The options are detailed below.
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
2022-03-08 08:06:22 +00:00
2022-03-28 19:30:46 +00:00
| Attribute | Description & Values |
|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `chart` | **Description:** Which Trakt chart to query< br > **Values:**< table class = "clearTable" >< tr >< td > `trending`</ td >< td > Trakt's Trending [Movies ](https://trakt.tv/movies/trending )/[Shows](https://trakt.tv/shows/trending) list</ td ></ tr >< tr >< td > `popular`</ td >< td > Trakt's Popular [Movies ](https://trakt.tv/movies/popular )/[Shows](https://trakt.tv/shows/popular) list</ td ></ tr >< tr >< td > `recommended`</ td >< td > Trakt's Recommended [Movies ](https://trakt.tv/movies/recommended )/[Shows](https://trakt.tv/shows/recommended) list</ td ></ tr >< tr >< td > `watched`</ td >< td > Trakt's Watched [Movies ](https://trakt.tv/movies/watched )/[Shows](https://trakt.tv/shows/watched) list</ td ></ tr >< tr >< td > `collected`</ td >< td > Trakt's Collected [Movies ](https://trakt.tv/movies/collected )/[Shows](https://trakt.tv/shows/collected) list</ td ></ tr ></ table > |
| `time_period` | **Description:** Time Period for the chart. Does not work with `trending` or `popular` chart types.< br > **Default:** `weekly` < br > **Values:** `daily` , `weekly` , `monthly` , `yearly` , or `all` |
| `limit` | **Description:** Don't return more then this number< br > **Default:** `10` < br > **Values:** Number of Items to query. |
| `query` | **Description:** Search titles and descriptions for this< br > **Values:** Any String. |
| `year` | **Description:** Search for the specified years only< br > **Values:** 4 digit year or range of 4 digit years. i.e. `1950` or `1950-1959` |
| `genres` | **Description:** Search for the specified genres only< br > **Values:** Comma separated string or list of genres< br > **Movie Genres:** `action` , `adventure` , `animation` , `anime` , `comedy` , `crime` , `documentary` , `drama` , `family` , `fantasy` , `history` , `holiday` , `horror` , `music` , `musical` , `mystery` , `none` , `romance` , `science-fiction` , `short` , `sporting-event` , `superhero` , `suspense` , `thriller` , `war` , `western` < br > **Show Genres:** `action` , `adventure` , `animation` , `anime` , `biography` , `children` , `comedy` , `crime` , `documentary` , `drama` , `family` , `fantasy` , `game-show` , `history` , `holiday` , `home-and-garden` , `horror` , `mini-series` , `music` , `musical` , `mystery` , `news` , `none` , `reality` , `romance` , `science-fiction` , `short` , `soap` , `special-interest` , `sporting-event` , `superhero` , `suspense` , `talk-show` , `thriller` , `war` , `western` |
| `languages` | **Description:** Search for the specified languages only< br > **Values:** Comma separated string or list of languages< br > **Movie Languages:** `ab` , `af` , `ak` , `sq` , `am` , `ar` , `an` , `hy` , `as` , `av` , `ay` , `az` , `bm` , `ba` , `eu` , `be` , `bn` , `bi` , `nb` , `bs` , `bg` , `my` , `ca` , `km` , `ch` , `ce` , `ny` , `zh` , `kw` , `co` , `cr` , `hr` , `cs` , `da` , `dv` , `nl` , `dz` , `en` , `eo` , `et` , `fo` , `fj` , `fi` , `fr` , `ff` , `gd` , `gl` , `lg` , `ka` , `de` , `el` , `gn` , `gu` , `ht` , `ha` , `he` , `hi` , `hu` , `is` , `ig` , `id` , `ie` , `iu` , `ik` , `ga` , `it` , `ja` , `jv` , `kl` , `kn` , `ks` , `kk` , `rw` , `ky` , `kg` , `ko` , `ku` , `lo` , `la` , `lv` , `li` , `ln` , `lt` , `lb` , `mk` , `mg` , `ms` , `ml` , `mt` , `mi` , `mr` , `mh` , `mn` , `nv` , `ne` , `se` , `no` , `nn` , `oc` , `oj` , `or` , `om` , `os` , `pi` , `pa` , `fa` , `pl` , `pt` , `ps` , `qu` , `ro` , `rm` , `rn` , `ru` , `sm` , `sg` , `sa` , `sc` , `sr` , `sn` , `ii` , `sd` , `si` , `sk` , `sl` , `so` , `st` , `es` , `su` , `sw` , `ss` , `sv` , `tl` , `ty` , `tg` , `ta` , `tt` , `te` , `th` , `bo` , `ti` , `to` , `ts` , `tn` , `tr` , `tk` , `tw` , `ug` , `uk` , `ur` , `uz` , `vi` , `cy` , `fy` , `wo` , `xh` , `yi` , `yo` , `za` , `zu` < br > **Show Languages:** `ab` , `af` , `sq` , `am` , `ar` , `hy` , `eu` , `be` , `bn` , `nb` , `bs` , `bg` , `ca` , `km` , `zh` , `hr` , `cs` , `da` , `dv` , `nl` , `en` , `et` , `fi` , `fr` , `gl` , `ka` , `de` , `el` , `gu` , `he` , `hi` , `hu` , `is` , `id` , `ga` , `it` , `ja` , `kn` , `ko` , `lo` , `la` , `lv` , `lt` , `lb` , `mk` , `ms` , `ml` , `mt` , `mi` , `mr` , `ne` , `se` , `no` , `nn` , `pa` , `fa` , `pl` , `pt` , `ro` , `ru` , `sr` , `si` , `sk` , `sl` , `es` , `sv` , `tl` , `ta` , `te` , `th` , `tr` , `tw` , `uk` , `ur` , `uz` , `vi` , `cy` |
| `countries` | **Description:** Search for the specified countries only< br > **Values:** Comma separated string or list of countries< br > **Movie Countries:** `af` , `al` , `dz` , `as` , `ad` , `ao` , `ai` , `aq` , `ag` , `ar` , `am` , `aw` , `au` , `at` , `az` , `bs` , `bh` , `bd` , `bb` , `by` , `be` , `bz` , `bj` , `bm` , `bt` , `bo` , `ba` , `bw` , `bv` , `br` , `io` , `bn` , `bg` , `bf` , `bi` , `cv` , `kh` , `cm` , `ca` , `ky` , `cf` , `td` , `cl` , `cn` , `cx` , `co` , `km` , `cg` , `cd` , `ck` , `cr` , `hr` , `cu` , `cy` , `cz` , `ci` , `dk` , `dj` , `dm` , `do` , `ec` , `eg` , `sv` , `gq` , `er` , `ee` , `sz` , `et` , `fk` , `fo` , `fj` , `fi` , `fr` , `gf` , `pf` , `tf` , `ga` , `gm` , `ge` , `de` , `gh` , `gi` , `gr` , `gl` , `gd` , `gp` , `gu` , `gt` , `gn` , `gw` , `gy` , `ht` , `va` , `hn` , `hk` , `hu` , `is` , `in` , `id` , `ir` , `iq` , `ie` , `il` , `it` , `jm` , `jp` , `jo` , `kz` , `ke` , `ki` , `kp` , `kr` , `kw` , `kg` , `la` , `lv` , `lb` , `ls` , `lr` , `ly` , `li` , `lt` , `lu` , `mo` , `mg` , `mw` , `my` , `mv` , `ml` , `mt` , `mh` , `mq` , `mr` , `mu` , `yt` , `mx` , `md` , `mc` , `mn` , `me` , `ms` , `ma` , `mz` , `mm` , `na` , `nr` , `np` , `nl` , `nc` , `nz` , `ni` , `ne` , `ng` , `nf` , `mk` , `mp` , `no` , `om` , `pk` , `pw` , `ps` , `pa` , `pg` , `py` , `pe` , `ph` , `pn` , `pl` , `pt` , `pr` , `qa` , `ro` , `ru` , `rw` , `re` , `sh` , `kn` , `lc` , `vc` , `ws` , `sm` , `st` , `sa` , `sn` , `rs` , `sc` , `sl` , `sg` , `sk` , `si` , `sb` , `so` , `za` , `ss` , `es` , `lk` , `sd` , `sr` , `se` , `ch` , `sy` , `tw` , `tj` , `tz` , `th` , `tl` , `tg` , `tk` , `to` , `tt` , `tn` , `tr` , `tm` , `tc` , `tv` , `ug` , `ua` , `ae` , `gb` , `us` , `um` , `uy` , `uz` , `vu` , `ve` , `vn` , `vg` , `vi` , `wf` , `eh` , `ye` , `zm` , `zw` < br > **Show Countries:** `af` , `ad` , `ar` , `am` , `au` , `at` , `bd` , `by` , `be` , `bz` , `ba` , `bw` , `br` , `io` , `bg` , `kh` , `ca` , `td` , `cl` , `cn` , `co` , `hr` , `cu` , `cy` , `cz` , `dk` , `do` , `ec` , `eg` , `ee` , `sz` , `fi` , `fr` , `ge` , `de` , `gr` , `hn` , `hk` , `hu` , `is` , `in` , `id` , `ir` , `iq` , `ie` , `il` , `it` , `jp` , `jo` , `kz` , `kp` , `kr` , `kw` , `la` , `lv` , `lb` , `lt` , `lu` , `my` , `mv` , `mt` , `mx` , `md` , `mc` , `me` , `ma` , `np` , `nl` , `nz` , `ng` , `mk` , `mp` , `no` , `pk` , `pa` , `py` , `pe` , `ph` , `pl` , `pt` , `pr` , `qa` , `ro` , `ru` , `sa` , `sn` , `rs` , `sg` , `sk` , `si` , `za` , `es` , `lk` , `se` , `ch` , `sy` , `tw` , `th` , `tg` , `tn` , `tr` , `ua` , `ae` , `gb` , `us` , `uy` , `ve` , `vn` |
| `certifications` | **Description:** Search for the specified certifications only< br > **Values:** Comma separated string or list of certifications< br > **Movie Certifications:** `g` , `pg` , `pg-13` , `r` , `nr` < br > **Show Certifications:** `tv-y` , `tv-y7` , `tv-g` , `tv-pg` , `tv-14` , `tv-ma` , `nr` |
| `runtimes` | **Description:** Search for the specified runtime range< br > **Values:** range of int i.e. `0-60` |
| `ratings` | **Description:** Search for the specified rating range< br > **Values:** range of int i.e. `80-100` |
| `networks` | **Description:** Search for the specified networks only **Only works with shows** < br > **Values:** Comma separated string or list of networks |
| `status` | **Description:** Search for the specified status only **Only works with shows** < br > **Values:** Comma separated string or list of statuses< br > **Status:** `returning` , `production` , `planned` , `canceled` , `ended` |
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
These are the links to the trakt charts that is looked at by time period.
2022-03-08 08:06:22 +00:00
2022-03-28 19:30:46 +00:00
| Time Period | Collected | Recommended | Watched |
|:------------|:-----------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------:|
| Daily | [Movies ](https://trakt.tv/movies/collected/daily )/[Shows](https://trakt.tv/shows/collected/daily) | [Movies ](https://trakt.tv/movies/recommended/daily )/[Shows](https://trakt.tv/shows/recommended/daily) | [Movies ](https://trakt.tv/movies/watched/daily )/[Shows](https://trakt.tv/shows/watched/daily) |
| Weekly | [Movies ](https://trakt.tv/movies/collected/weekly )/[Shows](https://trakt.tv/shows/collected/weekly) | [Movies ](https://trakt.tv/movies/recommended/weekly )/[Shows](https://trakt.tv/shows/recommended/weekly) | [Movies ](https://trakt.tv/movies/watched/weekly )/[Shows](https://trakt.tv/shows/watched/weekly) |
| Monthly | [Movies ](https://trakt.tv/movies/collected/monthly )/[Shows](https://trakt.tv/shows/collected/monthly) | [Movies ](https://trakt.tv/movies/recommended/monthly )/[Shows](https://trakt.tv/shows/recommended/monthly) | [Movies ](https://trakt.tv/movies/watched/monthly )/[Shows](https://trakt.tv/shows/watched/monthly) |
| Yearly | [Movies ](https://trakt.tv/movies/collected/yearly )/[Shows](https://trakt.tv/shows/collected/yearly) | [Movies ](https://trakt.tv/movies/recommended/yearly )/[Shows](https://trakt.tv/shows/recommended/yearly) | [Movies ](https://trakt.tv/movies/watched/yearly )/[Shows](https://trakt.tv/shows/watched/yearly) |
| All-Time | [Movies ](https://trakt.tv/movies/collected/all )/[Shows](https://trakt.tv/shows/collected/all) | [Movies ](https://trakt.tv/movies/recommended/all )/[Shows](https://trakt.tv/shows/recommended/all) | [Movies ](https://trakt.tv/movies/watched/all )/[Shows](https://trakt.tv/shows/watched/all) |
2022-03-08 08:06:22 +00:00
```yaml
collections:
Trakt Trending:
2022-03-27 06:26:08 +00:00
trakt_chart:
chart: trending
limit: 30
2022-03-08 08:06:22 +00:00
collection_order: custom
sync_mode: sync
```
2022-03-27 06:26:08 +00:00
You can use multiple charts in one builder using a list.
2022-03-08 08:06:22 +00:00
```yaml
collections:
2022-03-27 06:26:08 +00:00
Trakt Trending & Popular:
trakt_chart:
- chart: trending
limit: 30
- chart: popular
limit: 30
2022-03-08 08:06:22 +00:00
collection_order: custom
sync_mode: sync
```
2022-03-27 06:26:08 +00:00
## Trakt Userlist
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
Finds every movie/show in the Trakt Userlist.
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
2022-03-08 08:06:22 +00:00
2022-04-02 14:17:47 +00:00
| Attribute | Description & Values |
|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `userlist` | **Description:** Which Trakt userlist to query< br > **Values:**< table class = "clearTable" >< tr >< td > `watchlist`</ td >< td > Trakt User's Watchlist</ td ></ tr >< tr >< td > `recommended`</ td >< td > Trakt User's Personal Recommended list</ td ></ tr >< tr >< td > `watched`</ td >< td > Trakt User's Personal Watched list</ td ></ tr >< tr >< td > `collected`</ td >< td > Trakt User's Personal Collected list</ td ></ tr ></ table > |
| `user` | **Description:** The User who's user lists you want to query.< br > **Default:** `me` < br > **Values:** Username of User or `me` for the authenticated user. |
| `sort_by` | **Description:** How to sort the results< br > **Default:** `rank` < br > **Values:** `rank` , `added` , `released` , `title` |
2022-03-08 08:06:22 +00:00
```yaml
collections:
2022-03-27 06:26:08 +00:00
Trakt Watchlist:
trakt_userlist:
userlist: watchlist
user: me
sort_by: released
2022-03-08 08:06:22 +00:00
collection_order: custom
sync_mode: sync
```
2022-03-27 06:26:08 +00:00
You can use multiple charts in one builder using a list.
2022-03-08 08:06:22 +00:00
```yaml
collections:
2022-03-27 06:26:08 +00:00
Trakt Watchlist:
trakt_userlist:
- userlist: watched
user: me
- userlist: collected
user: me
2022-03-08 08:06:22 +00:00
collection_order: custom
sync_mode: sync
```
2022-03-27 06:26:08 +00:00
## Trakt Recommendations
2022-03-08 08:06:22 +00:00
2022-03-27 06:26:08 +00:00
Finds the movies/shows in Trakt's Recommendations for [Movies ](https://trakt.docs.apiary.io/#reference/recommendations/movies/get-movie-recommendations )/[Shows](https://trakt.docs.apiary.io/#reference/recommendations/shows/get-show-recommendations)
2022-03-08 08:06:22 +00:00
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.
```yaml
collections:
2022-03-27 06:26:08 +00:00
Trakt Recommendations:
trakt_recommendations: 30
2022-03-08 08:06:22 +00:00
collection_order: custom
sync_mode: sync
```
## Trakt Box Office
Finds the 10 movies in Trakt's Top Box Office [Movies ](https://trakt.tv/movies/boxoffice ) 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.
```yaml
collections:
Trakt Collected:
trakt_boxoffice: true
collection_order: custom
sync_mode: sync
```
