Trakt API
At Trakt, we collect lots of interesting information about what tv shows and movies everyone is watching
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://api.trakt.tv"
}
],
"x-hasEquivalentPaths": true,
"info": {
"description": "At Trakt, we collect lots of interesting information about what tv shows and movies everyone is watching. Part of the fun with such data is making it available for anyone to mash up and use on their own site or app. The Trakt API was made just for this purpose. It is very easy to use, you basically call a URL and get some JSON back.\n\nMore complex API calls (such as adding a movie or show to your collection) involve sending us data. These are still easy to use, you simply POST some JSON data to a specific URL.\n\nMake sure to check out the [**Required Headers**](#introduction/required-headers) and [**Authentication**](#reference/authentication-oauth) sections for more info on what needs to be sent with each API call. Also check out the [**Terminology**](#introduction/terminology) section insight into the features Trakt supports.\n\n# Create an App\n\nTo use the Trakt API, you'll need to [**create a new API app**](https://trakt.tv/oauth/applications/new).\n\n# Stay Connected\n\nAPI discussion and bugs should be posted in the [**GitHub Developer Forum**](https://github.com/trakt/api-help/issues) and *watch* the repository if you'd like to get notifications. Make sure to follow our [**API Blog**](https://apiblog.trakt.tv) and [**@traktapi on Twitter**](https://twitter.com/traktapi) too.\n\n# API URL\n\nThe API should always be accessed over SSL.\n\n```\nhttps://api.trakt.tv\n```\n\nIf you would like to use our sandbox environment to not fill production with test data, use this URL over SSL. **Note:** Staging is a completely separate environment, so you'll need to [**create a new API app on staging**](https://staging.trakt.tv/oauth/applications/new).\n\n```\nhttps://api-staging.trakt.tv\n```\n\n# Verbs\n\nThe API uses restful verbs.\n\n| Verb | Description |\n|---|---|\n| `GET` | Select one or more items. Success returns `200` status code. |\n| `POST` | Create a new item. Success returns `201` status code. |\n| `PUT` | Update an item. Success returns `200` status code. |\n| `DELETE` | Delete an item. Success returns `200` or `204` status code. |\n\n# Status Codes\n\nThe API will respond with one of the following HTTP status codes.\n\n| Code | Description |\n|---|---|\n| `200` | Success\n| `201` | Success - *new resource created (POST)*\n| `204` | Success - *no content to return (DELETE)*\n| `400` | Bad Request - *request couldn't be parsed*\n| `401` | Unauthorized - *OAuth must be provided*\n| `403` | Forbidden - *invalid API key or unapproved app*\n| `404` | Not Found - *method exists, but no record found*\n| `405` | Method Not Found - *method doesn't exist*\n| `409` | Conflict - *resource already created*\n| `412` | Precondition Failed - *use application/json content type*\n| `420` | Account Limit Exceeded - *list count, item count, etc*\n| `422` | Unprocessable Entity - *validation errors*\n| `423` | Locked User Account - *have the user contact support*\n| `426` | VIP Only - *user must upgrade to VIP*\n| `429` | Rate Limit Exceeded\n| `500` | Server Error - *please open a support ticket*\n| `502` | Service Unavailable - *server overloaded (try again in 30s)*\n| `503` | Service Unavailable - *server overloaded (try again in 30s)*\n| `504` | Service Unavailable - *server overloaded (try again in 30s)*\n| `520` | Service Unavailable - *Cloudflare error*\n| `521` | Service Unavailable - *Cloudflare error*\n| `522` | Service Unavailable - *Cloudflare error*\n\n# Required Headers\n\nYou'll need to send some headers when making API calls to identify your application, set the version and set the content type to JSON.\n\n| Header | Value |\n|---|---|\n| `Content-type` <span style=\"color:red;\">*</a> | `application/json` |\n| `trakt-api-key` <span style=\"color:red;\">*</a> | Your `client_id` listed under your Trakt applications. |\n| `trakt-api-version` <span style=\"color:red;\">*</a> | `2` | API version to use.\n\nAll `POST`, `PUT`, and `DELETE` methods require a valid OAuth `access_token`. Some `GET` calls require OAuth and others will return user specific data if OAuth is sent. Methods that 🔒 **require** or have 🔓 **optional** OAuth will be indicated.\n\nYour OAuth library should take care of sending the auth headers for you, but for reference here's how the Bearer token should be sent.\n\n| Header | Value |\n|---|---|\n| `Authorization` | `Bearer [access_token]` |\n\n# Rate Limiting\n\nAll API methods are rate limited. A `429` HTTP status code is returned when the limit has been exceeded. Check the headers for detailed info, then try your API call in `Retry-After` seconds.\n\n| Header | Value |\n|---|---|\n| `X-Ratelimit` | `{\"name\":\"UNAUTHED_API_GET_LIMIT\",\"period\":300,\"limit\":1000,\"remaining\":0,\"until\":\"2020-10-10T00:24:00Z\"}` |\n| `Retry-After` | `10` |\n\nHere are the current limits. There are separate limits for authed (user level) and unauthed (application level) calls. We'll continue to adjust these limits to optimize API performance for everyone. The goal is to prevent API abuse and poor coding, but allow users to use apps normally.\n\n| Name | Verb | Methods | Limit |\n|---|---|---|---|\n| `AUTHED_API_POST_LIMIT` | `POST`, `PUT`, `DELETE` | all | 1 call per second |\n| `AUTHED_API_GET_LIMIT` | `GET` | all | 1000 calls every 5 minutes |\n| `UNAUTHED_API_GET_LIMIT` | `GET` | all | 1000 calls every 5 minutes |\n\n# Locked User Account\n\nA `423` HTTP status code is returned when the OAuth user has a locked user account. Please instruct the user to [**contact Trakt support**](https://support.trakt.tv) so we can fix their account. API access will be suspended for the user until we fix their account.\n\n# VIP Methods\n\nSome API methods are tagged 🔥 **VIP Only**. A `426` HTTP status code is returned when the user isn't a VIP, indicating they need to sign up for [**Trakt VIP**](https://trakt.tv/vip) in order to use this method. In your app, please open a browser to `X-Upgrade-URL` so the user can sign up for Trakt VIP.\n\n| Header | Value |\n|---|---|\n| `X-Upgrade-URL` | `https://trakt.tv/vip` |\n\nSome API methods are tagged 🔥 **VIP Enhanced**. A `420` HTTP status code is returned when the user has exceeded their account limit. Signing up for [**Trakt VIP**](https://trakt.tv/vip) will increase these limits. If the user isn't a VIP, please open a browser to `X-Upgrade-URL` so the user can sign up for Trakt VIP. If they are already VIP and still exceeded the limit, please display a message indicating this.\n\n| Header | Value |\n|---|---|\n| `X-Upgrade-URL` | `https://trakt.tv/vip` |\n| `X-VIP-User` | `true` or `false` |\n| `X-Account-Limit` | Limit allowed. |\n\n# Pagination\n\nSome methods are paginated. Methods with 📄 **Pagination** will load 1 page of 10 items by default. Methods with 📄 **Pagination Optional** will load all items by default. In either case, append a query string like `?page={page}&limit={limit}` to the URL to influence the results.\n\n| Parameter | Type | Default | Value |\n|---|---|---|---|\n| `page` | integer | `1` | Number of page of results to be returned. |\n| `limit` | integer | `10` | Number of results to return per page. |\n\nAll paginated methods will return these HTTP headers.\n\n| Header | Value |\n|---|---|\n| `X-Pagination-Page` | Current page. |\n| `X-Pagination-Limit` | Items per page. |\n| `X-Pagination-Page-Count` | Total number of pages. |\n| `X-Pagination-Item-Count` | Total number of items. |\n\n# Extended Info\n\nBy default, all methods will return minimal info for movies, shows, episodes, people, and users. Minimal info is typically all you need to match locally cached items and includes the `title`, `year`, and `ids`. However, you can request different extended levels of information by adding `?extended={level}` to the URL. Send a comma separated string to get multiple types of extended info.\n\n**Note:** This returns a lot of extra data, so please only use extended parameters if you actually need them!\n\n| Level | Description |\n|---|---|\n| `full` | Complete info for an item.\n| `metadata` | **Collection only.** Additional video and audio info.\n\n# Filters\n\nSome `movies`, `shows`, `calendars`, and `search` methods support additional filters and will be tagged with 🎚 **Filters**. Applying these filters refines the results and helps your users to more easily discover new items.\n\nAdd a query string (i.e. `?years=2016&genres=action`) with any filters you want to use. Some filters allow multiples which can be sent as comma delimited parameters. For example, `?genres=action,adventure` would match the `action` OR `adventure` genre.\n\n**Note:** Make sure to properly URL encode the parameters including spaces and special characters.\n\n#### Common Filters\n\n| Parameter | Multiples | Example | Value |\n|---|---|---|---|\n| `query` | | `batman` | Search titles and descriptions. |\n| `years` | | `2016` | 4 digit year or range of years. |\n| `genres` | ✓ | `action` | [Genre slugs.](#reference/genres) |\n| `languages` | ✓ | `en` | [2 character language code.](#reference/languages) |\n| `countries` | ✓ | `us` | [2 character country code.](#reference/countries) |\n| `runtimes` | | `30-90` | Range in minutes. |\n| `studios` | ✓ | `marvel-studios` | Studio slugs. |\n\n#### Rating Filters\n\nTrakt, TMDB, and IMDB ratings apply to `movies`, `shows`, and `episodes`. Rotten Tomatoes and Metacritic apply to `movies`.\n\n| Parameter | Multiples | Example | Value |\n|---|---|---|---|\n| `ratings` | | `75-100` | Trakt rating range between `0` and `100`. |\n| `votes` | | `5000-10000` | Trakt vote count between `0` and `100000`. |\n| `tmdb_ratings` | | `5.5-10.0` | TMDB rating range between `0.0` and `10.0`. |\n| `tmdb_votes` | | `5000-10000` | TMDB vote count between `0` and `100000`. |\n| `imdb_ratings` | | `5.5-10.0` | IMDB rating range between `0.0` and `10.0`. |\n| `imdb_votes` | | `5000-10000` | IMDB vote count between `0` and `3000000`. |\n| `rt_meters` | | `5.5-10.0` | Rotten Tomatoes meter range between `0` and `100`. |\n| `metascores` | | `5.5-10.0` | Metacritic score range between `0` and `100`. |\n\n#### Movie Filters\n\n| Parameter | Multiples | Example | Value |\n|---|---|---|---|\n| `certifications` | ✓ | `pg-13` | US content certification. |\n\n#### Show Filters\n\n| Parameter | Multiples | Example | Value |\n|---|---|---|---|\n| `certifications` | ✓ | `tv-pg` | US content certification. |\n| `networks` | ✓ | `HBO` | Network name. |\n| `status` | ✓ | `ended` | Set to `returning series`, `continuing`, `in production`, `planned`, `upcoming`, `pilot`, `canceled`, or `ended`. |\n\n# CORS\n\nWhen creating your API app, specify the JavaScript (CORS) origins you'll be using. We use these origins to return the headers needed for CORS.\n\n# Dates\n\nAll dates will be GMT and returned in the ISO 8601 format like `2014-09-01T09:10:11.000Z`. Adjust accordingly in your app for the user's local timezone.\n\n# Emojis\n\nWe use short codes for emojis like `:smiley:` and `:raised_hands:` and render them on the Trakt website using [**JoyPixels**](https://www.joypixels.com/) _(verion 6.6.0)_. Methods that support emojis are tagged with 😁 **Emojis**. For POST methods, you can send standard unicode emojis and we'll automatically convert them to short codes. For GET methods, we'll return the short codes and it's up to your app to convert them back to unicode emojis.\n\n# Standard Media Objects\n\nAll methods will accept or return standard media objects for `movie`, `show`, `season`, `episode`, `person`, and `user` items. Here are examples for all minimal objects.\n\n#### movie\n\n```\n{\n \"title\": \"Batman Begins\",\n \"year\": 2005,\n \"ids\": {\n \"trakt\": 1,\n \"slug\": \"batman-begins-2005\",\n \"imdb\": \"tt0372784\",\n \"tmdb\": 272\n }\n}\n```\n\n#### show\n\n```\n{\n \"title\": \"Breaking Bad\",\n \"year\": 2008,\n \"ids\": {\n \"trakt\": 1,\n \"slug\": \"breaking-bad\",\n \"tvdb\": 81189,\n \"imdb\": \"tt0903747\",\n \"tmdb\": 1396\n }\n}\n```\n\n#### season\n\n```\n{\n \"number\": 0,\n \"ids\": {\n \"trakt\": 1,\n \"tvdb\": 439371,\n \"tmdb\": 3577\n }\n}\n```\n\n#### episode\n\n```\n{\n \"season\": 1,\n \"number\": 1,\n \"title\": \"Pilot\",\n \"ids\": {\n \"trakt\": 16,\n \"tvdb\": 349232,\n \"imdb\": \"tt0959621\",\n \"tmdb\": 62085\n }\n}\n```\n\n#### person\n\n```\n{\n \"name\": \"Bryan Cranston\",\n \"ids\": {\n \"trakt\": 142,\n \"slug\": \"bryan-cranston\",\n \"imdb\": \"nm0186505\",\n \"tmdb\": 17419\n }\n}\n```\n\n#### user\n\n```\n{\n \"username\": \"sean\",\n \"private\": false,\n \"name\": \"Sean Rudford\",\n \"vip\": true,\n \"vip_ep\": true,\n \"ids\": {\n \"slug\": \"sean\"\n }\n}\n```\n\n# Images\n\nThe standard media objects for all `movie`, `show`, `season`, `episode`, and `person` items include an `ids` object. These `ids` map to other services like [TMDB](https://www.themoviedb.org), [TVDB](https://thetvdb.com), [Fanart.tv](https://fanart.tv), [IMDB](https://www.imdb.com), and [OMDB](https://www.omdbapi.com/).\n\nMost of these services have free APIs you can use to grab lots of great looking images. Here’s a chart to help you find the best artwork for your app. [**We also wrote an article to help with this.**](https://apiblog.trakt.tv/how-to-find-the-best-images-516045bcc3b6)\n\n| Media | Type | [TMDB](https://developers.themoviedb.org/3) | [TVDB](https://api.thetvdb.com/swagger) | [Fanart.tv](http://docs.fanarttv.apiary.io) | [OMDB](https://www.omdbapi.com) |\n|---|---|---|---|---|---|\n| `shows` | `poster` | ✓ | ✓ | ✓ | ✓ |\n| | `fanart` | ✓ | ✓ | ✓ | |\n| | `banner` | | ✓ | ✓ | |\n| | `logo` | | | ✓ | |\n| | `clearart` | | | ✓ | |\n| | `thumb` | | | ✓ | |\n| `seasons` | `poster` | ✓ | ✓ | ✓ | |\n| | `banner` | | ✓ | ✓ | |\n| | `thumb` | | | ✓ | |\n| `episodes` | `screenshot` | ✓ | ✓ | | |\n| `movies` | `poster` | ✓ | | ✓ | ✓ |\n| | `fanart` | ✓ | | ✓ | |\n| | `banner` | | | ✓ | |\n| | `logo` | | | ✓ | |\n| | `clearart` | | | ✓ | |\n| | `thumb` | | | ✓ | |\n| `person` | `headshot` | ✓ | | | |\n| | `character` | | ✓ | | |\n\n# Website Media Links\n\nThere are several ways to construct direct links to media on the Trakt website. The website itself uses slugs so the URLs are more readable.\n\n| Type | URL |\n|---|---|\n| `movie` | `/movies/:slug` |\n| `show` | `/shows/:slug` |\n| `season` | `/shows/:slug/seasons/:num` |\n| `episode` | `/shows/:slug/seasons/:num/episodes/:num` |\n| `person` | `/people/:slug` |\n| `comment` | `/comments/:id` |\n| `list` | `/lists/:id` |\n\nYou can also create links using the Trakt, IMDB, TMDB, or TVDB IDs. We recommend using the Trakt ID if possible since that will always have full coverage. If you use the search url without an `id_type` it will return search results if multiple items are found.\n\n| Type | URL |\n|---|---|\n| `trakt` | `/search/trakt/:id` |\n| | `/search/trakt/:id?id_type=movie` |\n| | `/search/trakt/:id?id_type=show` |\n| | `/search/trakt/:id?id_type=season` |\n| | `/search/trakt/:id?id_type=episode` |\n| | `/search/trakt/:id?id_type=person` |\n| `imdb` | `/search/imdb/:id` |\n| `tmdb` | `/search/tmdb/:id` |\n| | `/search/tmdb/:id?id_type=movie` |\n| | `/search/tmdb/:id?id_type=show` |\n| | `/search/tmdb/:id?id_type=episode` |\n| | `/search/tmdb/:id?id_type=person` |\n| `tvdb` | `/search/tvdb/:id` |\n| | `/search/tvdb/:id?id_type=show` |\n| | `/search/tvdb/:id?id_type=episode` |\n\n# Third Party Libraries\n\nAll of the libraries listed below are user contributed. If you find a bug or missing feature, please contact the developer directly. These might help give your project a head start, but we can't provide direct support for any of these libraries. Please help us keep this list up to date.\n\n| Language | Name | Repository |\n|---|---|---|\n| `C#` | `Trakt.NET` | https://github.com/henrikfroehling/Trakt.NET |\n| | `TraktSharp` | https://github.com/wwarby/TraktSharp |\n| `C++` | `libtraqt` | https://github.com/RobertMe/libtraqt |\n| `Clojure` | `clj-trakt` | https://github.com/niamu/clj-trakt |\n| `Java` | `trakt-java` | https://github.com/UweTrottmann/trakt-java |\n| `Node.js` | `Trakt.tv` | https://github.com/vankasteelj/trakt.tv |\n| | `TraktApi2` | https://github.com/PatrickE94/traktapi2 |\n| `Python` | `trakt.py` | https://github.com/fuzeman/trakt.py |\n| | `pyTrakt` | https://github.com/moogar0880/PyTrakt |\n| `R` | `tRakt` | https://github.com/jemus42/tRakt |\n| `React Native` | `nodeless-trakt` | https://github.com/kdemoya/nodeless-trakt |\n| `Ruby` | `omniauth-trakt` | https://github.com/wafcio/omniauth-trakt |\n| | `omniauth-trakt` | https://github.com/alextakitani/omniauth-trakt |\n| `Swift` | `TraktKit` | https://github.com/MaxHasADHD/TraktKit |\n| | `AKTrakt` | https://github.com/arsonik/AKTrakt |\n\n# Terminology\n\nTrakt has a lot of features and here's a chart to help explain the differences between some of them.\n\n| Term | Description |\n|---|---|\n| `scrobble` | Automatic way to track what a user is watching in a media center. |\n| `checkin` | Manual action used by mobile apps allowing the user to indicate what they are watching right now. |\n| `history` | All watched items (scrobbles, checkins, watched) for a user. |\n| `collection` | Items a user has available to watch including Blu-Rays, DVDs, and digital downloads. |\n| `watchlist` | Items a user wants to watch in the future. Once watched, they are auto removed from this list. |\n| `list` | Personal list for any purpose. Items are not auto removed from any personal lists. |\n| `recommendations` | Movies and TV shows a user personally recommends to others. |",
"title": "Trakt API",
"version": "1.0.0",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_walter.trakt.tv_hotlink-ok_public_apple-touch-icon.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://trakt.docs.apiary.io/api-description-document",
"version": "2.0"
}
],
"x-providerName": "trakt.tv"
},
"tags": [
{
"description": "The API uses OAuth2. If you know what's up with OAuth2, grab your library and starting rolling. If you have access to a web browser (mobile app, desktop app, website), use standard **OAuth**. If you don't have web browser access (media center plugins, smart watches, smart TVs, command line scripts, system services), use **Device** authentication.\n\nTo obtain a `client_id` and `client_secret`, create an application on the Trakt website. Here are some helpful links to get your started:\n\n- [Create a new API app](https://trakt.tv/oauth/applications/new)\n\n- [View your API apps](https://trakt.tv/oauth/applications)\n\n---\n\n#### Application Flow\n\n1. **Redirect to request Trakt access.** Using the [**/oauth/authorize**](/reference/authentication-oauth/authorize) method, construct then redirect to this URL. The Trakt website will request permissions for your app and the user will have the opportunity to sign up for a new Trakt account or sign in with their existing account.\n\n2. **Trakt redirects back to your site.** If the user accepts your request, Trakt redirects back to your site with a temporary code in a `code` GET parameter as well as the state (if provided) in the previous step in a `state` parameter. If the states don’t match, the request has been created by a third party and the process should be aborted.\n\n3. **Exchange the code for an access token.** If everything looks good in step 2, exchange the `code` for an access token using the [**/oauth/token**](reference/authentication-oauth/get-token/) method. Save the `access_token` so your app can authenticate the user by sending the `Authorization` header as indicated below or in any example code. The `access_token` is valid for 3 months. Save and use the `refresh_token` to get a new `access_token` without asking the user to re-authenticate.",
"name": "Authentication - OAuth"
},
{
"description": "Device authentication is for apps and services with limited input or display capabilities. This include media center plugins, smart watches, smart TVs, command line scripts, and system services.\n\nYour app displays an alphanumeric code (typically 8 characters) to the user. They are then instructed to visit the verification URL on their computer or mobile device. After entering the code, the user will be prompted to grant permission for your app. After your app gets permissions, the device receives an `access_token` and works like standard OAuth from that point on. More details below.\n\n---\n\n#### Application Flow\n\n1. **Generate codes.** Your app calls [**/oauth/device/code**](/reference/authentication-devices/code) to generate new codes. Save this entire response for later use.\n\n2. **Display the code.** Display the `user_code` and instruct the user to visit the `verification_url` on their computer or mobile device.\n\n3. **Poll for authorization.** Poll the [**/oauth/device/token**](/reference/authentication-devices/token) method to see if the user successfully authorizes your app. Use the `device_code` and poll at the `interval` (in seconds) to check if the user has authorized your app. Check the docs below for the specific error codes you need to handle. Use `expires_in` to stop polling after that many seconds, and gracefully instruct the user to restart the process. **It is important to poll at the correct interval and also stop polling when expired.**\n\n4. **Successful authorization.** When you receive a `200` success response, save the `access_token` so your app can authenticate the user in methods that require it. The `access_token` is valid for 3 months. Save and use the `refresh_token` to get a new `access_token` without asking the user to re-authenticate. It's normal OAuth from this point.\n\n---\n\n#### User Flow\n\n1. **Call to action.** Consider your user experience when asking a user to connect their Trakt account. For some devices this will be right away, and for others it might be later in the experience.\n\n2. **Display the code.** When a user clicks the call to action, your app calls [**/oauth/device/code**](/reference/authentication-devices/code) to generate new codes. In your UI, display the `user_code` and instruct the user to visit the `verification_url` on their computer or mobile device. The `user_code` is typically 8 characters, so make sure there is enough room to display the full code.\n\n3. **Authorizing your app.** When the user visits the `verification_url` it first checks to make sure they're signed in. If not signed in, they'll be able to or can sign up for a new account. After entering the code, the user will be prompted to grant permission for your app. Once approved, the user will see a success message indicating their device is connected.\n\n4. **Confirm successful authorization.** Your app will be polling to see if the user successfully authorizes your app. Once they have, refresh your UI to indicate a successful connection has been made.",
"name": "Authentication - Devices"
},
{
"description": "By default, the calendar will return all shows or movies for the specified time period and can be global or user specific. The `start_date` defaults to today and `days` to 7. The maximum amount of `days` you can send is `33`. All dates (including the `start_date` and `first_aired`) are in UTC, so it's up to your app to handle any offsets based on the user's time zone.\n\nThe `my` calendar displays episodes for all shows that have been watched, collected, or watchlisted plus individual episodes on the watchlist. It will remove any shows that have been hidden from the calendar. The `all` calendar displays info for all shows airing during the specified period.",
"name": "Calendars"
},
{
"description": "Checking in is a manual action used by mobile apps allowing the user to indicate what they are watching right now. While not as effortless as scrobbling, checkins help fill in the gaps. You might be watching live tv, at a friend's house, or watching a movie in theaters. You can simply checkin from your phone or tablet in those situations. The item will display as *watching* on the site, then automatically switch to *watched* status once the duration has elapsed.",
"name": "Checkin"
},
{
"name": "Certifications"
},
{
"description": "Comments are attached to any movie, show, season, episode, or list and can be a quick shout or a more detailed review. Each comment can have replies and can be liked. These likes are used to determine popular comments. Comments must follow these rules and your app should indicate these to the user. Failure to adhere to these rules could suspend the user's commenting abilities.\n\n- Comments must be at least 5 words.\n\n- Comments 200 words or longer will be automatically marked as a review.\n\n- Correctly indicate if the comment contains spoilers.\n\n- Only write comments in English - **This is important!**\n\n- **Do not include** app specific text like (via App Name) or #apphashtag. This clutters up the comments and failure to clean the comment text could get your app blacklisted from commenting.\n\n#### Possible Error Responses\n\n| Code | Description |\n|---|---|\n| `401` | Invalid user\n| `401` | User banned from commenting\n| `404` | Item not found or doesn't allow comments\n| `409` | Comment can't be deleted\n| `422` | Validation errors\n\n#### Validation Errors\n\nIf a comment doesn't pass validation, it returns a `422` HTTP error code and an array of validation errors in the response. The validation errors could include:\n\n| Error Message |\n|---|\n| `must be at least 5 words` |\n| `must be written in English` |\n\n#### Comment Formatting\n\nComments support [**markdown**](https://en.wikipedia.org/wiki/Markdown) formatting so you'll want to render this in your app so it matches what the website does. In addition, we support inline spoiler tags like `[spoiler]text[/spoiler]` which you should also handle independent of the top level `spoiler` attribute.",
"name": "Comments"
},
{
"name": "Countries"
},
{
"name": "Genres"
},
{
"name": "Languages"
},
{
"name": "Lists"
},
{
"name": "Movies"
},
{
"name": "Networks"
},
{
"name": "People"
},
{
"description": "Trakt social recommendations use all the `Recommendations` lists from the users you follow. The more users you follow with similar tastes, the better your recommendations will be. We also use other factors for the algorithm to further personalize what gets recommended.",
"name": "Recommendations"
},
{
"description": "Scrobbling is an automatic way to track what a user is watching in a media center. The media center should send events that correspond to starting, pausing, and stopping (or finishing) watching a movie or episode.",
"name": "Scrobble"
},
{
"description": "Searches can use queries or ID lookups. Queries will search text fields like the title and overview. ID lookups are helpful if you have an external ID and want to get the Trakt ID and info. These methods can search for movies, shows, episodes, people, and lists.",
"name": "Search"
},
{
"name": "Shows"
},
{
"name": "Seasons"
},
{
"name": "Episodes"
},
{
"description": "Syncing with trakt opens up quite a few cool features. Most importantly, trakt can serve as a cloud based backup for the data in your app. This is especially useful when rebuilding a media center or installing a mobile app on your new phone. It can also be nice to sync up multiple media centers with a central trakt account. If everything is in sync, your media can be managed from trakt and be reflected in your apps.\n\n### Media objects for syncing\n\nAs a baseline, all *add* and *remove* sync methods accept arrays of `movies`, `shows`, and `episodes`. Each of these top level array elements should themselves be an array of standard `movie`, `show`, or `episode` objects. Full examples are in the intro section called **Standard Media Objects**. Keep in mind that `episode` objects really only need the `ids` so it can find an exact match. This is useful for absolute ordered shows. Some methods also have optional metadata you can attach, so check the docs for each specific method.\n\nMedia objects will be matched by ID first, then fall back to title and year. IDs will be matched in this order `trakt`, `imdb`, `tmdb`, `tvdb`, and `slug`. If nothing is found, it will match on the `title` and `year`. If still nothing, it would use just the `title` (or `name` for people) and find the most current object that exists.\n\n### Watched History Sync\n\nThis is a 2 way sync that will get items from trakt to sync locally, plus find anything new and sync back to trakt. Perform this sync on startup or at set intervals (i.e. once every day) to keep everything in sync. *This will only send data to trakt and not remove it.*\n\n### Collection Sync\n\nIt's very handy to have a snapshot on trakt of everything you have available to watch locally. Syncing your local connection will do just that. *This will only send data to trakt and not remove it.*\n\n### Clean Collection\n\nCleaning a collection involves comparing the trakt collection to what exists locally. This will remove items from the trakt collection if they don't exist locally anymore. You should make this clear to the user that data might be removed from trakt.",
"name": "Sync"
},
{
"description": "User's with public data will return info with all GET methods. Private user's (including yourself) require valid OAuth and a friend relationship to return data.\n\n### Username vs. Slug\n\nAll `users` methods should use the `slug` to identify the user. The `slug` is a URL safe and globally unique version of the `username`.\n\n### Special ID for the OAuth user\n\nIf you send valid OAuth, you can use `me` to identify the OAuth user instead of needing their actual slug. You can of course still use their actual slug, it's up to you.\n\n### Extra Headers\n\nIf valid OAuth is sent, additional headers will be sent to better determine it is a data permissions issue (they aren't friends) and not bad OAuth. For example, you might try and access a private user's list you aren't friends with. This will return a `401` HTTP status code and the additional headers. This means the OAuth is valid, but authorization ultimately failed because there is no friend relationship.\n\n| Header | Value |\n|---|---|\n| `X-Private-User` | `true` or `false` |\n\n### Creating New Users\n\nSince the API uses OAuth, users can create a new account during that flow if they need to. As far as your app is concerned, you'll still receive OAuth tokens no matter if they sign in with an existing account or create a new one.",
"name": "Users"
}
],
"paths": {
"/calendars/all/dvd/{start_date}/{days}": {
"get": {
"description": "#### ✨ Extended Info 🎚 Filters\n\nReturns all movies with a DVD release date during the time period specified.",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt2473602",
"slug": "get-on-up-2014",
"tmdb": 239566,
"trakt": 29
},
"title": "Get On Up",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt1291150",
"slug": "teenage-mutant-ninja-turtles-2014",
"tmdb": 98566,
"trakt": 30
},
"title": "Teenage Mutant Ninja Turtles",
"year": 2014
},
"released": "2014-08-08"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get DVD releases",
"tags": [
"Calendars"
]
}
},
"/calendars/all/movies/{start_date}/{days}": {
"get": {
"description": "#### ✨ Extended Info 🎚 Filters\n\nReturns all movies with a release date during the time period specified.",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt2473602",
"slug": "get-on-up-2014",
"tmdb": 239566,
"trakt": 29
},
"title": "Get On Up",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt1291150",
"slug": "teenage-mutant-ninja-turtles-2014",
"tmdb": 98566,
"trakt": 30
},
"title": "Teenage Mutant Ninja Turtles",
"year": 2014
},
"released": "2014-08-08"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get movies",
"tags": [
"Calendars"
]
}
},
"/calendars/all/shows/new/{start_date}/{days}": {
"get": {
"description": "#### ✨ Extended Info 🎚 Filters\n\nReturns all new show premieres (season 1, episode 1) airing during the time period specified.",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3203968",
"tmdb": 983732,
"trakt": 497,
"tvdb": null
},
"number": 1,
"season": 1,
"title": "Pilot"
},
"first_aired": "2014-06-30T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get new shows",
"tags": [
"Calendars"
]
}
},
"/calendars/all/shows/premieres/{start_date}/{days}": {
"get": {
"description": "#### ✨ Extended Info 🎚 Filters\n\nReturns all show premieres (any season, episode 1) airing during the time period specified.",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3203968",
"tmdb": 983732,
"trakt": 497,
"tvdb": null
},
"number": 1,
"season": 1,
"title": "Pilot"
},
"first_aired": "2014-06-30T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
},
{
"episode": {
"ids": {
"imdb": "",
"tmdb": 975949,
"trakt": 163,
"tvdb": null
},
"number": 1,
"season": 5,
"title": "5x1"
},
"first_aired": "2014-10-13T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get season premieres",
"tags": [
"Calendars"
]
}
},
"/calendars/all/shows/{start_date}/{days}": {
"get": {
"description": "#### ✨ Extended Info 🎚 Filters\n\nReturns all shows airing during the time period specified.",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3500614",
"tmdb": 988123,
"trakt": 443,
"tvdb": 4851180
},
"number": 4,
"season": 7,
"title": "Death is Not the End"
},
"first_aired": "2014-07-14T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt0844441",
"slug": "true-blood",
"tmdb": 10545,
"trakt": 5,
"tvdb": 82283
},
"title": "True Blood",
"year": 2008
}
},
{
"episode": {
"ids": {
"imdb": "tt3631218",
"tmdb": 988346,
"trakt": 499,
"tvdb": 4854797
},
"number": 3,
"season": 1,
"title": "Two Boats and a Helicopter"
},
"first_aired": "2014-07-14T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
},
{
"episode": {
"ids": {
"imdb": "tt3500616",
"tmdb": 988124,
"trakt": 444,
"tvdb": 4851181
},
"number": 5,
"season": 7,
"title": "Return to Oz"
},
"first_aired": "2014-07-21T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt0844441",
"slug": "true-blood",
"tmdb": 10545,
"trakt": 5,
"tvdb": 82283
},
"title": "True Blood",
"year": 2008
}
},
{
"episode": {
"ids": {
"imdb": "tt3594942",
"tmdb": 988347,
"trakt": 500,
"tvdb": 4854798
},
"number": 4,
"season": 1,
"title": "B.J. and the A.C."
},
"first_aired": "2014-07-21T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get shows",
"tags": [
"Calendars"
]
}
},
"/calendars/my/dvd/{start_date}/{days}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info 🎚 Filters\n\nReturns all movies with a DVD release date during the time period specified.",
"operationId": "Get DVD releases",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt2473602",
"slug": "get-on-up-2014",
"tmdb": 239566,
"trakt": 29
},
"title": "Get On Up",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt1291150",
"slug": "teenage-mutant-ninja-turtles-2014",
"tmdb": 98566,
"trakt": 30
},
"title": "Teenage Mutant Ninja Turtles",
"year": 2014
},
"released": "2014-08-08"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get DVD releases",
"tags": [
"Calendars"
]
}
},
"/calendars/my/movies/{start_date}/{days}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info 🎚 Filters\n\nReturns all movies with a release date during the time period specified.",
"operationId": "Get movies",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt2473602",
"slug": "get-on-up-2014",
"tmdb": 239566,
"trakt": 29
},
"title": "Get On Up",
"year": 2014
},
"released": "2014-08-01"
},
{
"movie": {
"ids": {
"imdb": "tt1291150",
"slug": "teenage-mutant-ninja-turtles-2014",
"tmdb": 98566,
"trakt": 30
},
"title": "Teenage Mutant Ninja Turtles",
"year": 2014
},
"released": "2014-08-08"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get movies",
"tags": [
"Calendars"
]
}
},
"/calendars/my/shows/new/{start_date}/{days}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info 🎚 Filters\n\nReturns all new show premieres (season 1, episode 1) airing during the time period specified.",
"operationId": "Get new shows",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3203968",
"tmdb": 983732,
"trakt": 497,
"tvdb": null
},
"number": 1,
"season": 1,
"title": "Pilot"
},
"first_aired": "2014-06-30T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get new shows",
"tags": [
"Calendars"
]
}
},
"/calendars/my/shows/premieres/{start_date}/{days}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info 🎚 Filters\n\nReturns all show premieres (any season, episode 1) airing during the time period specified.",
"operationId": "Get season premieres",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3203968",
"tmdb": 983732,
"trakt": 497,
"tvdb": null
},
"number": 1,
"season": 1,
"title": "Pilot"
},
"first_aired": "2014-06-30T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
},
{
"episode": {
"ids": {
"imdb": "",
"tmdb": 975949,
"trakt": 163,
"tvdb": null
},
"number": 1,
"season": 5,
"title": "5x1"
},
"first_aired": "2014-10-13T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get season premieres",
"tags": [
"Calendars"
]
}
},
"/calendars/my/shows/{start_date}/{days}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info 🎚 Filters\n\nReturns all shows airing during the time period specified.",
"operationId": "Get shows",
"parameters": [
{
"description": "Start the calendar on this date.",
"example": "2014-09-01",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Number of days to display.",
"example": "7",
"in": "path",
"name": "days",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt3500614",
"tmdb": 988123,
"trakt": 443,
"tvdb": 4851180
},
"number": 4,
"season": 7,
"title": "Death is Not the End"
},
"first_aired": "2014-07-14T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt0844441",
"slug": "true-blood",
"tmdb": 10545,
"trakt": 5,
"tvdb": 82283
},
"title": "True Blood",
"year": 2008
}
},
{
"episode": {
"ids": {
"imdb": "tt3631218",
"tmdb": 988346,
"trakt": 499,
"tvdb": 4854797
},
"number": 3,
"season": 1,
"title": "Two Boats and a Helicopter"
},
"first_aired": "2014-07-14T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
},
{
"episode": {
"ids": {
"imdb": "tt3500616",
"tmdb": 988124,
"trakt": 444,
"tvdb": 4851181
},
"number": 5,
"season": 7,
"title": "Return to Oz"
},
"first_aired": "2014-07-21T01:00:00.000Z",
"show": {
"ids": {
"imdb": "tt0844441",
"slug": "true-blood",
"tmdb": 10545,
"trakt": 5,
"tvdb": 82283
},
"title": "True Blood",
"year": 2008
}
},
{
"episode": {
"ids": {
"imdb": "tt3594942",
"tmdb": 988347,
"trakt": 500,
"tvdb": 4854798
},
"number": 4,
"season": 1,
"title": "B.J. and the A.C."
},
"first_aired": "2014-07-21T02:00:00.000Z",
"show": {
"ids": {
"imdb": "tt2699128",
"slug": "the-leftovers",
"tmdb": 54344,
"trakt": 7,
"tvdb": 269689
},
"title": "The Leftovers",
"year": 2014
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-End-Date": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get shows",
"tags": [
"Calendars"
]
}
},
"/certifications/{type}": {
"get": {
"description": "Get a list of all certifications, including names, slugs, and descriptions.",
"operationId": "Get certifications",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"us": [
{
"description": "All Ages",
"name": "G",
"slug": "g"
},
{
"description": "Parental Guidance Suggested",
"name": "PG",
"slug": "pg"
},
{
"description": "Parents Strongly Cautioned - Ages 13+ Recommended",
"name": "PG-13",
"slug": "pg-13"
},
{
"description": "Mature Audiences - Ages 17+ Recommended",
"name": "R",
"slug": "r"
},
{
"description": "Not Rated",
"name": "Not Rated",
"slug": "nr"
}
]
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get certifications",
"tags": [
"Certifications"
]
}
},
"/checkin": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nRemoves any active checkins, no need to provide a specific item.",
"operationId": "Delete any active checkins",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Delete any active checkins",
"tags": [
"Checkin"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nCheck into a movie or episode. This should be tied to a user action to manually indicate they are watching something. The item will display as *watching* on the site, then automatically switch to *watched* status once the duration has elapsed. A unique history `id` (64-bit integer) will be returned and can be used to reference this checkin directly.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie` or `episode` object. (see examples →) |\n| `sharing` | object | Control sharing to any connected social networks. (see below ↓) |\n| `message` | string | Message used for sharing. If not sent, it will use the watching string in the user settings. |\n| `venue_id` | string | Foursquare venue ID. |\n| `venue_name` | string | Foursquare venue name. |\n| `app_version` | string | Version number of the app. |\n| `app_date` | string | Build date of the app. |\n\n#### Sharing\n\nThe `sharing` object is optional and will apply the user's settings if not sent. If `sharing` is sent, each key will override the user's setting for that social network. Send `true` to post or `false` to not post on the indicated social network. You can see which social networks a user has connected with the [**/users/settings**](/reference/users/settings) method.\n\n| Key | Type |\n|---|---|\n| `twitter` | boolean |\n| `tumblr` | boolean |\n\n**Note:** If a checkin is already in progress, a `409` HTTP status code will returned. The response will contain an `expires_at` timestamp which is when the user can check in again.",
"operationId": "Check into an item",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"app_date": "2014-09-22",
"app_version": "1.0",
"message": "Guardians of the Galaxy FTW!",
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"sharing": {
"tumblr": false,
"twitter": true
}
},
"properties": {
"app_date": {
"type": "string"
},
"app_version": {
"type": "string"
},
"message": {
"type": "string"
},
"movie": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"sharing": {
"properties": {
"tumblr": {
"type": "boolean"
},
"twitter": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 856373,
"tvdb": 362082
},
"number": 21,
"season": 9,
"title": "Light the Fire of Shandia! Wiper the Warrior"
},
"id": 3373536622,
"sharing": {
"tumblr": false,
"twitter": true
},
"show": {
"ids": {
"imdb": "tt0388629",
"slug": "one-piece",
"tmdb": 37854,
"trakt": 37696,
"tvdb": 81797
},
"title": "One Piece",
"year": 1999
},
"watched_at": "2019-01-20T06:54:36.859Z"
}
}
}
}
},
"description": "Created",
"headers": {}
},
"409": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"expires_at": "2014-10-15T22:21:29.000Z"
}
}
}
}
},
"description": "There is already a checkin in progress.",
"headers": {}
}
},
"security": [
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
}
],
"summary": "Check into an item",
"tags": [
"Checkin"
]
}
},
"/comments": {
"post": {
"description": "#### 🔒 OAuth Required 😁 Emojis\n\nAdd a new comment to a movie, show, season, episode, or list. Make sure to allow and encourage *spoilers* to be indicated in your app and follow the rules listed above.\n\n#### JSON POST Data\n\n| Key | Type | Default | Value |\n|---|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | | `movie`, `show`, `season`, `episode`, or `list` object. (see examples →) |\n| `comment` <span style=\"color:red;\">*</a> | string | | Text for the comment. |\n| `spoiler` | boolean | `false` | Is this a spoiler? |\n| `sharing` | object | | Control sharing to any connected social networks. (see below ↓) |\n\n#### Sharing\n\nThe `sharing` object is optional and will apply the user's settings if not sent. If `sharing` is sent, each key will override the user's setting for that social network. Send `true` to post or `false` to not post on the indicated social network. You can see which social networks a user has connected with the [**/users/settings**](/reference/users/settings) method.\n\n| Key | Type |\n|---|---|\n| `twitter` | boolean |\n| `tumblr` | boolean |\n| `medium` | boolean |",
"operationId": "Post a comment",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"comment": "Oh, I wasn't really listening.",
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"sharing": {
"medium": true,
"tumblr": false,
"twitter": true
},
"spoiler": false
},
"properties": {
"comment": {
"type": "string"
},
"movie": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"sharing": {
"properties": {
"medium": {
"type": "boolean"
},
"tumblr": {
"type": "boolean"
},
"twitter": {
"type": "boolean"
}
},
"type": "object"
},
"spoiler": {
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"comment": "I want candy.",
"created_at": "2014-08-04T06:46:01.000Z",
"id": 190,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-08-04T06:46:01.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
}
],
"summary": "Post a comment",
"tags": [
"Comments"
]
}
},
"/comments/recent/{comment_type}/{type}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 😁 Emojis\n\nReturns the most recently written comments across all of Trakt. You can optionally filter by the `comment_type` and media `type` to limit what gets returned. If you want to `include_replies` that will return replies in place alongside top level comments.",
"operationId": "Get recently created comments",
"parameters": [
{
"description": "",
"example": "all",
"in": "path",
"name": "comment_type",
"required": true,
"schema": {
"enum": [
"all",
"reviews",
"shouts"
],
"type": "string"
}
},
{
"description": "",
"example": "all",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"movies",
"shows",
"seasons",
"episodes",
"lists"
],
"type": "string"
}
},
{
"description": "include comment replies",
"example": "false",
"in": "query",
"name": "include_replies",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": {
"comment": "Great kickoff to a new Batman trilogy!",
"created_at": "2015-04-25T00:14:57.000Z",
"id": 267,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-25T00:14:57.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
"type": "movie"
},
{
"comment": {
"comment": "Skyler, I AM THE DANGER.",
"created_at": "2015-02-18T06:02:30.000Z",
"id": 199,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-02-18T06:02:30.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"comment": {
"comment": "Kicking off season 1 for a new Batman show.",
"created_at": "2015-04-21T06:53:25.000Z",
"id": 220,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T06:53:25.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
},
"season": {
"ids": {
"tmdb": 60394,
"trakt": 3958,
"tvdb": 274431
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "season"
},
{
"comment": {
"comment": "Is this the OC?",
"created_at": "2015-04-21T15:42:31.000Z",
"id": 229,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T15:42:31.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 7
}
},
"episode": {
"ids": {
"imdb": "tt3216414",
"tmdb": 975968,
"trakt": 63958,
"tvdb": 4768720
},
"number": 1,
"season": 1,
"title": "Jim Gordon"
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "episode"
},
{
"comment": {
"comment": "May the 4th be with you!",
"created_at": "2014-12-08T17:34:51.000Z",
"id": 268,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-12-08T17:34:51.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
},
"list": {
"allow_comments": true,
"comment_count": 0,
"description": "The complete Star Wars saga!",
"display_numbers": false,
"ids": {
"slug": "star-wars",
"trakt": 51
},
"item_count": 8,
"likes": 0,
"name": "Star Wars",
"privacy": "public",
"updated_at": "2015-04-22T22:01:39.000Z"
},
"type": "list"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently created comments",
"tags": [
"Comments"
]
}
},
"/comments/trending/{comment_type}/{type}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 😁 Emojis\n\nReturns all comments with the most likes and replies over the last 7 days. You can optionally filter by the `comment_type` and media `type` to limit what gets returned. If you want to `include_replies` that will return replies in place alongside top level comments.",
"operationId": "Get trending comments",
"parameters": [
{
"description": "",
"example": "all",
"in": "path",
"name": "comment_type",
"required": true,
"schema": {
"enum": [
"all",
"reviews",
"shouts"
],
"type": "string"
}
},
{
"description": "",
"example": "all",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"movies",
"shows",
"seasons",
"episodes",
"lists"
],
"type": "string"
}
},
{
"description": "include comment replies",
"example": "false",
"in": "query",
"name": "include_replies",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": {
"comment": "Great kickoff to a new Batman trilogy!",
"created_at": "2015-04-25T00:14:57.000Z",
"id": 267,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-25T00:14:57.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
"type": "movie"
},
{
"comment": {
"comment": "Skyler, I AM THE DANGER.",
"created_at": "2015-02-18T06:02:30.000Z",
"id": 199,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-02-18T06:02:30.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"comment": {
"comment": "Kicking off season 1 for a new Batman show.",
"created_at": "2015-04-21T06:53:25.000Z",
"id": 220,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T06:53:25.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
},
"season": {
"ids": {
"tmdb": 60394,
"trakt": 3958,
"tvdb": 274431
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "season"
},
{
"comment": {
"comment": "Is this the OC?",
"created_at": "2015-04-21T15:42:31.000Z",
"id": 229,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T15:42:31.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 7
}
},
"episode": {
"ids": {
"imdb": "tt3216414",
"tmdb": 975968,
"trakt": 63958,
"tvdb": 4768720
},
"number": 1,
"season": 1,
"title": "Jim Gordon"
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "episode"
},
{
"comment": {
"comment": "May the 4th be with you!",
"created_at": "2014-12-08T17:34:51.000Z",
"id": 268,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-12-08T17:34:51.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
},
"list": {
"allow_comments": true,
"comment_count": 0,
"description": "The complete Star Wars saga!",
"display_numbers": false,
"ids": {
"slug": "star-wars",
"trakt": 51
},
"item_count": 8,
"likes": 0,
"name": "Star Wars",
"privacy": "public",
"updated_at": "2015-04-22T22:01:39.000Z"
},
"type": "list"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get trending comments",
"tags": [
"Comments"
]
}
},
"/comments/updates/{comment_type}/{type}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 😁 Emojis\n\nReturns the most recently updated comments across all of Trakt. You can optionally filter by the `comment_type` and media `type` to limit what gets returned. If you want to `include_replies` that will return replies in place alongside top level comments.",
"operationId": "Get recently updated comments",
"parameters": [
{
"description": "",
"example": "all",
"in": "path",
"name": "comment_type",
"required": true,
"schema": {
"enum": [
"all",
"reviews",
"shouts"
],
"type": "string"
}
},
{
"description": "",
"example": "all",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"movies",
"shows",
"seasons",
"episodes",
"lists"
],
"type": "string"
}
},
{
"description": "include comment replies",
"example": "false",
"in": "query",
"name": "include_replies",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": {
"comment": "Great kickoff to a new Batman trilogy!",
"created_at": "2015-04-25T00:14:57.000Z",
"id": 267,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-25T00:14:57.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
"type": "movie"
},
{
"comment": {
"comment": "Skyler, I AM THE DANGER.",
"created_at": "2015-02-18T06:02:30.000Z",
"id": 199,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-02-18T06:02:30.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"comment": {
"comment": "Kicking off season 1 for a new Batman show.",
"created_at": "2015-04-21T06:53:25.000Z",
"id": 220,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T06:53:25.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
},
"season": {
"ids": {
"tmdb": 60394,
"trakt": 3958,
"tvdb": 274431
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "season"
},
{
"comment": {
"comment": "Is this the OC?",
"created_at": "2015-04-21T15:42:31.000Z",
"id": 229,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T15:42:31.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 7
}
},
"episode": {
"ids": {
"imdb": "tt3216414",
"tmdb": 975968,
"trakt": 63958,
"tvdb": 4768720
},
"number": 1,
"season": 1,
"title": "Jim Gordon"
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "episode"
},
{
"comment": {
"comment": "May the 4th be with you!",
"created_at": "2014-12-08T17:34:51.000Z",
"id": 268,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-12-08T17:34:51.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
},
"list": {
"allow_comments": true,
"comment_count": 0,
"description": "The complete Star Wars saga!",
"display_numbers": false,
"ids": {
"slug": "star-wars",
"trakt": 51
},
"item_count": 8,
"likes": 0,
"name": "Star Wars",
"privacy": "public",
"updated_at": "2015-04-22T22:01:39.000Z"
},
"type": "list"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated comments",
"tags": [
"Comments"
]
}
},
"/comments/{id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nDelete a single comment. The OAuth user must match the author of the comment in order to delete it. If not, a `401` HTTP status code is returned. The comment must also be less than 2 weeks old or have 0 replies. If not, a `409` HTTP status is returned.",
"operationId": "Delete a comment or reply",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Delete a comment or reply",
"tags": [
"Comments"
]
},
"get": {
"description": "#### 😁 Emojis\n\nReturns a single comment and indicates how many replies it has. Use [**/comments/:id/replies**](/reference/comments/replies/) to get the actual replies.",
"operationId": "Get a comment or reply",
"parameters": [
{
"description": "A specific comment ID.",
"example": "417",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"comment": "Agreed, this show is awesome. AMC in general has awesome shows.",
"created_at": "2010-11-03T06:30:13.000Z",
"id": 1,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
}
}
}
},
"description": "OK",
"headers": {
"X-Item-ID": {
"schema": {
"type": "string"
}
},
"X-Item-Type": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get a comment or reply",
"tags": [
"Comments"
]
},
"put": {
"description": "#### 🔒 OAuth Required 😁 Emojis\n\nUpdate a single comment. The OAuth user must match the author of the comment in order to update it. If not, a `401` HTTP status is returned.\n\n#### JSON POST Data\n\n| Key | Type | Default | Value |\n|---|---|---|---|\n| `comment` | string | | Text for the comment. |\n| `spoiler` | boolean | `false` | Is this a spoiler? |",
"operationId": "Update a comment or reply",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"comment": "Agreed, this show is awesome. AMC in general has awesome shows and I can't wait to see what they come up with next.",
"spoiler": false
},
"properties": {
"comment": {
"type": "string"
},
"spoiler": {
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"comment": "Agreed, this show is awesome. AMC in general has awesome shows and I can't wait to see what they come up with next.",
"created_at": "2010-11-03T06:30:13.000Z",
"id": 1,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2010-11-13T06:30:13.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Update a comment or reply",
"tags": [
"Comments"
]
}
},
"/comments/{id}/item": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns the media item this comment is attached to. The media type can be `movie`, `show`, `season`, `episode`, or `list` and it also returns the standard media object for that media type.",
"operationId": "Get the attached media item",
"parameters": [
{
"description": "A specific comment ID.",
"example": "417",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"show": {
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 353,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
"type": "show"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get the attached media item",
"tags": [
"Comments"
]
}
},
"/comments/{id}/like": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nRemove a like on a comment.",
"operationId": "Remove like on a comment",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove like on a comment",
"tags": [
"Comments"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nVotes help determine popular comments. Only one like is allowed per comment per user.",
"operationId": "Like a comment",
"parameters": [
{
"description": "A specific comment ID.",
"example": "417",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Like a comment",
"tags": [
"Comments"
]
}
},
"/comments/{id}/likes": {
"get": {
"description": "#### 📄 Pagination\n\nReturns all users who liked a comment. If you only need the `replies` count, the main `comment` object already has that, so no need to use this method.",
"operationId": "Get all users who liked a comment",
"parameters": [
{
"description": "A specific comment ID.",
"example": "417",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all users who liked a comment",
"tags": [
"Comments"
]
}
},
"/comments/{id}/replies": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all replies for a comment. It is possible these replies could have replies themselves, so in that case you would just call [**/comments/:id/replies**](/reference/comments/replies/) again with the new comment `id`.",
"operationId": "Get replies for a comment",
"parameters": [
{
"description": "A specific comment ID.",
"example": "417",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Season 2 has really picked up the action!",
"created_at": "2014-07-27T23:06:59.000Z",
"id": 19,
"likes": 0,
"parent_id": 1,
"replies": 0,
"review": false,
"spoiler": true,
"updated_at": "2014-07-27T23:06:59.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get replies for a comment",
"tags": [
"Comments"
]
},
"post": {
"description": "#### 🔒 OAuth Required 😁 Emojis\n\nAdd a new reply to an existing comment. Make sure to allow and encourage *spoilers* to be indicated in your app and follow the rules listed above.\n\n#### JSON POST Data\n\n| Key | Type | Default | Value |\n|---|---|---|---|\n| `comment` <span style=\"color:red;\">*</a> | string | | Text for the reply. |\n| `spoiler` | boolean | `false` | Is this a spoiler? |",
"operationId": "Post a reply for a comment",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"comment": "Couldn't agree more with your review!",
"spoiler": false
},
"properties": {
"comment": {
"type": "string"
},
"spoiler": {
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"comment": "Couldn't agree more with your review!",
"created_at": "2014-09-01T06:30:13.000Z",
"id": 2,
"likes": 0,
"parent_id": 1,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-09-01T06:30:13.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Post a reply for a comment",
"tags": [
"Comments"
]
}
},
"/countries/{type}": {
"get": {
"description": "Get a list of all countries, including names and codes.",
"operationId": "Get countries",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"code": "au",
"name": "Australia"
},
{
"code": "ja",
"name": "Japan"
},
{
"code": "us",
"name": "United States"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get countries",
"tags": [
"Countries"
]
}
},
"/genres/{type}": {
"get": {
"description": "Get a list of all genres, including names and slugs.",
"operationId": "Get genres",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"name": "Action",
"slug": "action"
},
{
"name": "Adventure",
"slug": "adventure"
},
{
"name": "Animation",
"slug": "animation"
},
{
"name": "Anime",
"slug": "anime"
},
{
"name": "Comedy",
"slug": "comedy"
},
{
"name": "Crime",
"slug": "crime"
},
{
"name": "Disaster",
"slug": "disaster"
},
{
"name": "Documentary",
"slug": "documentary"
},
{
"name": "donghua",
"slug": "Donghua"
},
{
"name": "Drama",
"slug": "drama"
},
{
"name": "Eastern",
"slug": "eastern"
},
{
"name": "Family",
"slug": "family"
},
{
"name": "Fan Film",
"slug": "fan-film"
},
{
"name": "Fantasy",
"slug": "fantasy"
},
{
"name": "Film Noir",
"slug": "film-noir"
},
{
"name": "History",
"slug": "history"
},
{
"name": "Holiday",
"slug": "holiday"
},
{
"name": "Horror",
"slug": "horror"
},
{
"name": "Indie",
"slug": "indie"
},
{
"name": "Music",
"slug": "music"
},
{
"name": "Musical",
"slug": "musical"
},
{
"name": "Mystery",
"slug": "mystery"
},
{
"name": "None",
"slug": "none"
},
{
"name": "Road",
"slug": "road"
},
{
"name": "Romance",
"slug": "romance"
},
{
"name": "Science Fiction",
"slug": "science-fiction"
},
{
"name": "Short",
"slug": "short"
},
{
"name": "Sports",
"slug": "sports"
},
{
"name": "Sporting Event",
"slug": "sporting-event"
},
{
"name": "Suspense",
"slug": "suspense"
},
{
"name": "Thriller",
"slug": "thriller"
},
{
"name": "Tv Movie",
"slug": "tv-movie"
},
{
"name": "War",
"slug": "war"
},
{
"name": "Western",
"slug": "western"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get genres",
"tags": [
"Genres"
]
}
},
"/languages/{type}": {
"get": {
"description": "Get a list of all langauges, including names and codes.",
"operationId": "Get languages",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"code": "en",
"name": "English"
},
{
"code": "it",
"name": "Italian"
},
{
"code": "pl",
"name": "Polish"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get languages",
"tags": [
"Languages"
]
}
},
"/lists/popular": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns the most popular lists. Popularity is calculated using total number of likes and comments.",
"operationId": "Get popular lists",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment_count": 20,
"like_count": 109,
"list": {
"allow_comments": true,
"comment_count": 20,
"created_at": "2015-10-11T17:00:54.000Z",
"description": "So cute.",
"display_numbers": true,
"ids": {
"slug": "top-chihuahua-movies",
"trakt": 1338
},
"item_count": 50,
"likes": 109,
"name": "Top Chihuahua Movies",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2015-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
},
{
"comment_count": 10,
"like_count": 99,
"list": {
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get popular lists",
"tags": [
"Lists"
]
}
},
"/lists/trending": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists with the most likes and comments over the last 7 days.",
"operationId": "Get trending lists",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment_count": 5,
"like_count": 5,
"list": {
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
},
{
"comment_count": 4,
"like_count": 4,
"list": {
"allow_comments": true,
"comment_count": 20,
"created_at": "2015-10-11T17:00:54.000Z",
"description": "So cute.",
"display_numbers": true,
"ids": {
"slug": "top-chihuahua-movies",
"trakt": 1338
},
"item_count": 50,
"likes": 109,
"name": "Top Chihuahua Movies",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2015-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get trending lists",
"tags": [
"Lists"
]
}
},
"/lists/{id}": {
"get": {
"description": "#### 😁 Emojis\n\nReturns a single list. Use the [**/lists/:id/items**](#reference/lists/list-items) method to get the actual items this list contains.\n\n**Note:** You must use an integer `id`, and only public lists will return data.",
"operationId": "Get list",
"parameters": [
{
"description": "Trakt ID",
"example": "55",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"allow_comments": true,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 5,
"likes": 0,
"name": "Star Wars in machete order",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
}
}
}
},
"description": "OK",
"headers": {
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get list",
"tags": [
"Lists"
]
}
},
"/lists/{id}/comments/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all top level comments for a list. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, and most `replies`.",
"operationId": "Get all list comments",
"parameters": [
{
"description": "Trakt ID",
"example": "55",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Can't wait to watch everything on this epic list!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all list comments",
"tags": [
"Lists"
]
}
},
"/lists/{id}/items/{type}": {
"get": {
"description": "#### 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nGet all items on a personal list. Items can be a `movie`, `show`, `season`, `episode`, or `person`. You can optionally specify the `type` parameter with a single value or comma delimited string for multiple item types.\n\n#### Notes\n\nEach list item contains a `notes` field with text entered by the user.\n\n#### Sorting Headers\n\nAll list items are sorted by ascending `rank`. We also send `X-Sort-By` and `X-Sort-How` headers which can be used to custom sort the list _**in your app**_ based on the user's preference. Values for `X-Sort-By` include `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, `votes`, `my_rating`, `random`, `watched`, and `collected`. Values for `X-Sort-How` include `asc` and `desc`.",
"operationId": "Get items on a list",
"parameters": [
{
"description": "Trakt ID",
"example": "55",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movie",
"show",
"season",
"episode",
"person"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 101,
"listed_at": "2014-06-16T06:07:12.000Z",
"movie": {
"ids": {
"imdb": "tt0076759",
"slug": "star-wars-episode-iv-a-new-hope-1977",
"tmdb": 11,
"trakt": 12
},
"title": "Star Wars: Episode IV - A New Hope",
"year": 1977
},
"notes": null,
"rank": 1,
"type": "movie"
},
{
"id": 102,
"listed_at": "2014-06-16T06:07:12.000Z",
"notes": null,
"rank": 2,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"type": "show"
},
{
"id": 103,
"listed_at": "2014-06-16T06:07:12.000Z",
"notes": null,
"rank": 3,
"season": {
"ids": {
"tmdb": 3572,
"tvdb": 30272
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "season"
},
{
"episode": {
"ids": {
"imdb": null,
"tmdb": 62133,
"trakt": 2,
"tvdb": 3859791
},
"number": 2,
"season": 0,
"title": "Wedding Day"
},
"id": 104,
"listed_at": "2014-06-17T06:52:03.000Z",
"notes": null,
"rank": 4,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"id": 105,
"listed_at": "2014-06-17T06:52:03.000Z",
"notes": null,
"person": {
"ids": {
"imdb": "nm1330560",
"slug": "garrett-hedlund",
"tmdb": 9828,
"trakt": 1
},
"name": "Garrett Hedlund"
},
"rank": 5,
"type": "person"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Private-User": {
"schema": {
"type": "string"
}
},
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get items on a list",
"tags": [
"Lists"
]
}
},
"/lists/{id}/likes": {
"get": {
"description": "#### 📄 Pagination\n\nReturns all users who liked a list.",
"operationId": "Get all users who liked a list",
"parameters": [
{
"description": "Trakt ID",
"example": "55",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all users who liked a list",
"tags": [
"Lists"
]
}
},
"/movies/anticipated": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most anticipated movies based on the number of lists a movie appears on.",
"operationId": "Get the most anticipated movies",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"list_count": 5362,
"movie": {
"ids": {
"imdb": "tt1951266",
"slug": "the-hunger-games-mockingjay-part-2-2015",
"tmdb": 131634,
"trakt": 89543
},
"title": "The Hunger Games: Mockingjay - Part 2",
"year": 2015
}
},
{
"list_count": 4405,
"movie": {
"ids": {
"imdb": "tt2975590",
"slug": "batman-v-superman-dawn-of-justice-2016",
"tmdb": 209112,
"trakt": 129583
},
"title": "Batman v Superman: Dawn of Justice",
"year": 2016
}
},
{
"list_count": 4185,
"movie": {
"ids": {
"imdb": "tt2488496",
"slug": "star-wars-episode-vii-the-force-awakens-2015",
"tmdb": 140607,
"trakt": 94024
},
"title": "Star Wars: Episode VII - The Force Awakens",
"year": 2015
}
},
{
"list_count": 2996,
"movie": {
"ids": {
"imdb": "tt3659388",
"slug": "the-martian-2015",
"tmdb": 286217,
"trakt": 183371
},
"title": "The Martian",
"year": 2015
}
},
{
"list_count": 2902,
"movie": {
"ids": {
"imdb": "tt1431045",
"slug": "deadpool-2016",
"tmdb": 293660,
"trakt": 190430
},
"title": "Deadpool",
"year": 2016
}
},
{
"list_count": 2675,
"movie": {
"ids": {
"imdb": "tt3498820",
"slug": "captain-america-civil-war-2016",
"tmdb": 271110,
"trakt": 169105
},
"title": "Captain America: Civil War",
"year": 2016
}
},
{
"list_count": 2629,
"movie": {
"ids": {
"imdb": "tt3385516",
"slug": "x-men-apocalypse-2016",
"tmdb": 246655,
"trakt": 149999
},
"title": "X-Men: Apocalypse",
"year": 2016
}
},
{
"list_count": 2184,
"movie": {
"ids": {
"imdb": "tt1386697",
"slug": "suicide-squad-2016",
"tmdb": 297761,
"trakt": 193079
},
"title": "Suicide Squad",
"year": 2016
}
},
{
"list_count": 2127,
"movie": {
"ids": {
"imdb": "tt2379713",
"slug": "spectre-2015",
"tmdb": 206647,
"trakt": 128378
},
"title": "SPECTRE",
"year": 2015
}
},
{
"list_count": 1951,
"movie": {
"ids": {
"imdb": "tt0974015",
"slug": "justice-league-2017",
"tmdb": 141052,
"trakt": 94232
},
"title": "Justice League",
"year": 2017
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most anticipated movies",
"tags": [
"Movies"
]
}
},
"/movies/boxoffice": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns the top 10 grossing movies in the U.S. box office last weekend. Updated every Monday morning.",
"operationId": "Get the weekend box office",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt2510894",
"slug": "hotel-transylvania-2-2015",
"tmdb": 159824,
"trakt": 103449
},
"title": "Hotel Transylvania 2",
"year": 2015
},
"revenue": 48464322
},
{
"movie": {
"ids": {
"imdb": "tt2361509",
"slug": "the-intern-2015",
"tmdb": 257211,
"trakt": 156997
},
"title": "The Intern",
"year": 2015
},
"revenue": 17728313
},
{
"movie": {
"ids": {
"imdb": "tt4046784",
"slug": "maze-runner-the-scorch-trials-2015",
"tmdb": 294254,
"trakt": 190987
},
"title": "Maze Runner: The Scorch Trials",
"year": 2015
},
"revenue": 14271777
},
{
"movie": {
"ids": {
"imdb": "tt2719848",
"slug": "everest-2015",
"tmdb": 253412,
"trakt": 153969
},
"title": "Everest",
"year": 2015
},
"revenue": 13242895
},
{
"movie": {
"ids": {
"imdb": "tt1355683",
"slug": "black-mass-2015",
"tmdb": 261023,
"trakt": 160067
},
"title": "Black Mass",
"year": 2015
},
"revenue": 11031215
},
{
"movie": {
"ids": {
"imdb": "tt3567288",
"slug": "the-visit-2015",
"tmdb": 298312,
"trakt": 196859
},
"title": "The Visit",
"year": 2015
},
"revenue": 6674280
},
{
"movie": {
"ids": {
"imdb": "tt3862750",
"slug": "the-perfect-guy-2015",
"tmdb": 304372,
"trakt": 207114
},
"title": "The Perfect Guy",
"year": 2015
},
"revenue": 4774505
},
{
"movie": {
"ids": {
"imdb": "tt3832914",
"slug": "war-room",
"tmdb": 323272,
"trakt": 203901
},
"title": "War Room",
"year": 2015
},
"revenue": 4242644
},
{
"movie": {
"ids": {
"imdb": "tt2403021",
"slug": "the-green-inferno-2014",
"tmdb": 171424,
"trakt": 109134
},
"title": "The Green Inferno",
"year": 2014
},
"revenue": 3520626
},
{
"movie": {
"ids": {
"imdb": "tt3397884",
"slug": "sicario-2015",
"tmdb": 273481,
"trakt": 171369
},
"title": "Sicario",
"year": 2015
},
"revenue": 1717301
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get the weekend box office",
"tags": [
"Movies"
]
}
},
"/movies/collected/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most collected (unique users) movies in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most Collected movies",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 33837,
"movie": {
"ids": {
"imdb": "tt0848228",
"slug": "the-avengers-2012",
"tmdb": 24428,
"trakt": 14701
},
"title": "The Avengers",
"year": 2012
},
"play_count": 102512,
"watcher_count": 81289
},
{
"collected_count": 32044,
"movie": {
"ids": {
"imdb": "tt1375666",
"slug": "inception-2010",
"tmdb": 27205,
"trakt": 16662
},
"title": "Inception",
"year": 2010
},
"play_count": 88597,
"watcher_count": 74665
},
{
"collected_count": 31877,
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 120
},
"title": "The Dark Knight",
"year": 2008
},
"play_count": 104242,
"watcher_count": 76254
},
{
"collected_count": 30502,
"movie": {
"ids": {
"imdb": "tt0903624",
"slug": "the-hobbit-an-unexpected-journey-2012",
"tmdb": 49051,
"trakt": 34097
},
"title": "The Hobbit: An Unexpected Journey",
"year": 2012
},
"play_count": 67402,
"watcher_count": 55355
},
{
"collected_count": 29062,
"movie": {
"ids": {
"imdb": "tt1345836",
"slug": "the-dark-knight-rises-2012",
"tmdb": 49026,
"trakt": 34073
},
"title": "The Dark Knight Rises",
"year": 2012
},
"play_count": 71767,
"watcher_count": 56916
},
{
"collected_count": 28037,
"movie": {
"ids": {
"imdb": "tt1392170",
"slug": "the-hunger-games-2012",
"tmdb": 70160,
"trakt": 51342
},
"title": "The Hunger Games",
"year": 2012
},
"play_count": 65325,
"watcher_count": 57603
},
{
"collected_count": 27802,
"movie": {
"ids": {
"imdb": "tt1300854",
"slug": "iron-man-3-2013",
"tmdb": 68721,
"trakt": 50134
},
"title": "Iron Man 3",
"year": 2013
},
"play_count": 63107,
"watcher_count": 52662
},
{
"collected_count": 27721,
"movie": {
"ids": {
"imdb": "tt0371746",
"slug": "iron-man-2008",
"tmdb": 1726,
"trakt": 1157
},
"title": "Iron Man",
"year": 2008
},
"play_count": 79998,
"watcher_count": 63920
},
{
"collected_count": 27693,
"movie": {
"ids": {
"imdb": "tt0499549",
"slug": "avatar-2009",
"tmdb": 19995,
"trakt": 12269
},
"title": "Avatar",
"year": 2009
},
"play_count": 78930,
"watcher_count": 62786
},
{
"collected_count": 27661,
"movie": {
"ids": {
"imdb": "tt1853728",
"slug": "django-unchained-2012",
"tmdb": 68718,
"trakt": 50131
},
"title": "Django Unchained",
"year": 2012
},
"play_count": 60086,
"watcher_count": 49809
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most Collected movies",
"tags": [
"Movies"
]
}
},
"/movies/played/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most played (a single user can watch multiple times) movies in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most played movies",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 27584,
"movie": {
"ids": {
"imdb": "tt2294629",
"slug": "frozen-2013",
"tmdb": 109445,
"trakt": 77349
},
"title": "Frozen",
"year": 2013
},
"play_count": 109736,
"watcher_count": 66667
},
{
"collected_count": 31877,
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 120
},
"title": "The Dark Knight",
"year": 2008
},
"play_count": 104242,
"watcher_count": 76254
},
{
"collected_count": 33837,
"movie": {
"ids": {
"imdb": "tt0848228",
"slug": "the-avengers-2012",
"tmdb": 24428,
"trakt": 14701
},
"title": "The Avengers",
"year": 2012
},
"play_count": 102512,
"watcher_count": 81289
},
{
"collected_count": 26662,
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 82405
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"play_count": 97715,
"watcher_count": 72538
},
{
"collected_count": 6252,
"movie": {
"ids": {
"imdb": "tt1980929",
"slug": "begin-again-2013",
"tmdb": 198277,
"trakt": 123759
},
"title": "Begin Again",
"year": 2014
},
"play_count": 95830,
"watcher_count": 8487
},
{
"collected_count": 32044,
"movie": {
"ids": {
"imdb": "tt1375666",
"slug": "inception-2010",
"tmdb": 27205,
"trakt": 16662
},
"title": "Inception",
"year": 2010
},
"play_count": 88597,
"watcher_count": 74665
},
{
"collected_count": 25855,
"movie": {
"ids": {
"imdb": "tt1323594",
"slug": "despicable-me-2010",
"tmdb": 20352,
"trakt": 12496
},
"title": "Despicable Me",
"year": 2010
},
"play_count": 82227,
"watcher_count": 55443
},
{
"collected_count": 27441,
"movie": {
"ids": {
"imdb": "tt1228705",
"slug": "iron-man-2-2010",
"tmdb": 10138,
"trakt": 5355
},
"title": "Iron Man 2",
"year": 2010
},
"play_count": 81167,
"watcher_count": 55739
},
{
"collected_count": 16419,
"movie": {
"ids": {
"imdb": "tt2245084",
"slug": "big-hero-6-2014",
"tmdb": 177572,
"trakt": 112404
},
"title": "Big Hero 6",
"year": 2014
},
"play_count": 80008,
"watcher_count": 45472
},
{
"collected_count": 27721,
"movie": {
"ids": {
"imdb": "tt0371746",
"slug": "iron-man-2008",
"tmdb": 1726,
"trakt": 1157
},
"title": "Iron Man",
"year": 2008
},
"play_count": 79998,
"watcher_count": 63920
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most played movies",
"tags": [
"Movies"
]
}
},
"/movies/popular": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most popular movies. Popularity is calculated using the rating percentage and the number of ratings.",
"operationId": "Get popular movies",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 16
},
"title": "The Dark Knight",
"year": 2008
},
{
"ids": {
"imdb": "tt0137523",
"slug": "fight-club-1999",
"tmdb": 550,
"trakt": 727
},
"title": "Fight Club",
"year": 1999
},
{
"ids": {
"imdb": "tt0107290",
"slug": "jurassic-park-1993",
"tmdb": 329,
"trakt": 393
},
"title": "Jurassic Park",
"year": 1993
},
{
"ids": {
"imdb": "tt0088763",
"slug": "back-to-the-future-1985",
"tmdb": 105,
"trakt": 308
},
"title": "Back to the Future",
"year": 1985
},
{
"ids": {
"imdb": "tt0111161",
"slug": "the-shawshank-redemption-1994",
"tmdb": 278,
"trakt": 231
},
"title": "The Shawshank Redemption",
"year": 1994
},
{
"ids": {
"imdb": "tt1285016",
"slug": "the-social-network-2010",
"tmdb": 37799,
"trakt": 98
},
"title": "The Social Network",
"year": 2010
},
{
"ids": {
"imdb": "tt0076759",
"slug": "star-wars-episode-iv-a-new-hope-1977",
"tmdb": 11,
"trakt": 738
},
"title": "Star Wars: Episode IV - A New Hope",
"year": 1977
},
{
"ids": {
"imdb": "tt0167260",
"slug": "the-lord-of-the-rings-the-return-of-the-king-2003",
"tmdb": 122,
"trakt": 374
},
"title": "The Lord of the Rings: The Return of the King",
"year": 2003
},
{
"ids": {
"imdb": "tt0167261",
"slug": "the-lord-of-the-rings-the-two-towers-2002",
"tmdb": 121,
"trakt": 373
},
"title": "The Lord of the Rings: The Two Towers",
"year": 2002
},
{
"ids": {
"imdb": "tt0133093",
"slug": "the-matrix-1999",
"tmdb": 603,
"trakt": 269
},
"title": "The Matrix",
"year": 1999
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get popular movies",
"tags": [
"Movies"
]
}
},
"/movies/recommended/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most recommended movies in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most recommended movies",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 120
},
"title": "The Dark Knight",
"year": 2008
},
"user_count": 76254
},
{
"movie": {
"ids": {
"imdb": "tt0848228",
"slug": "the-avengers-2012",
"tmdb": 24428,
"trakt": 14701
},
"title": "The Avengers",
"year": 2012
},
"user_count": 61289
},
{
"movie": {
"ids": {
"imdb": "tt1323594",
"slug": "despicable-me-2010",
"tmdb": 20352,
"trakt": 12496
},
"title": "Despicable Me",
"year": 2010
},
"user_count": 55443
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most recommended movies",
"tags": [
"Movies"
]
}
},
"/movies/trending": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns all movies being watched right now. Movies with the most users are returned first.",
"operationId": "Get trending movies",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt1104001",
"slug": "tron-legacy-2010",
"tmdb": 20526,
"trakt": 1
},
"title": "TRON: Legacy",
"year": 2010
},
"watchers": 21
},
{
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 4
},
"title": "The Dark Knight",
"year": 2008
},
"watchers": 17
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Trending-User-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get trending movies",
"tags": [
"Movies"
]
}
},
"/movies/updates/id/{start_date}": {
"get": {
"description": "#### 📄 Pagination\n\nReturns all movie Trakt IDs updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated movie Trakt IDs",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
1,
20,
34,
50
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated movie Trakt IDs",
"tags": [
"Movies"
]
}
},
"/movies/updates/{start_date}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nReturns all movies updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated movies",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt1104001",
"slug": "tron-legacy-2010",
"tmdb": 20526,
"trakt": 1
},
"title": "TRON: Legacy",
"year": 2010
},
"updated_at": "2014-09-22T21:56:03.000Z"
},
{
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 4
},
"title": "The Dark Knight",
"year": 2008
},
"updated_at": "2014-09-23T21:56:03.000Z"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated movies",
"tags": [
"Movies"
]
}
},
"/movies/watched/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most watched (unique users) movies in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most watched movies",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 33837,
"movie": {
"ids": {
"imdb": "tt0848228",
"slug": "the-avengers-2012",
"tmdb": 24428,
"trakt": 14701
},
"title": "The Avengers",
"year": 2012
},
"play_count": 102512,
"watcher_count": 81289
},
{
"collected_count": 31877,
"movie": {
"ids": {
"imdb": "tt0468569",
"slug": "the-dark-knight-2008",
"tmdb": 155,
"trakt": 120
},
"title": "The Dark Knight",
"year": 2008
},
"play_count": 104242,
"watcher_count": 76254
},
{
"collected_count": 32044,
"movie": {
"ids": {
"imdb": "tt1375666",
"slug": "inception-2010",
"tmdb": 27205,
"trakt": 16662
},
"title": "Inception",
"year": 2010
},
"play_count": 88597,
"watcher_count": 74665
},
{
"collected_count": 26662,
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 82405
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"play_count": 97715,
"watcher_count": 72538
},
{
"collected_count": 26263,
"movie": {
"ids": {
"imdb": "tt0133093",
"slug": "the-matrix-1999",
"tmdb": 603,
"trakt": 481
},
"title": "The Matrix",
"year": 1999
},
"play_count": 77108,
"watcher_count": 67228
},
{
"collected_count": 27584,
"movie": {
"ids": {
"imdb": "tt2294629",
"slug": "frozen-2013",
"tmdb": 109445,
"trakt": 77349
},
"title": "Frozen",
"year": 2013
},
"play_count": 109736,
"watcher_count": 66667
},
{
"collected_count": 27721,
"movie": {
"ids": {
"imdb": "tt0371746",
"slug": "iron-man-2008",
"tmdb": 1726,
"trakt": 1157
},
"title": "Iron Man",
"year": 2008
},
"play_count": 79998,
"watcher_count": 63920
},
{
"collected_count": 27693,
"movie": {
"ids": {
"imdb": "tt0499549",
"slug": "avatar-2009",
"tmdb": 19995,
"trakt": 12269
},
"title": "Avatar",
"year": 2009
},
"play_count": 78930,
"watcher_count": 62786
},
{
"collected_count": 27542,
"movie": {
"ids": {
"imdb": "tt0120737",
"slug": "the-lord-of-the-rings-the-fellowship-of-the-ring-2001",
"tmdb": 120,
"trakt": 88
},
"title": "The Lord of the Rings: The Fellowship of the Ring",
"year": 2001
},
"play_count": 69112,
"watcher_count": 60803
},
{
"collected_count": 25803,
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 228
},
"title": "Batman Begins",
"year": 2005
},
"play_count": 67884,
"watcher_count": 58057
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most watched movies",
"tags": [
"Movies"
]
}
},
"/movies/{id}": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns a single movie's details.\n\n**Note:** When getting `full` extended info, the `status` field can have a value of `released`, `in production`, `post production`, `planned`, `rumored`, or `canceled`.",
"operationId": "Get a movie",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"available_translations": [
"en"
],
"certification": "PG-13",
"comment_count": 92,
"country": "us",
"genres": [
"action"
],
"homepage": "http://disney.go.com/tron/",
"ids": {
"imdb": "tt1104001",
"slug": "tron-legacy-2010",
"tmdb": 20526,
"trakt": 343
},
"language": "en",
"overview": "Sam Flynn, the tech-savvy and daring son of Kevin Flynn, investigates his father's disappearance and is pulled into The Grid. With the help of a mysterious program named Quorra, Sam quests to stop evil dictator Clu from crossing into the real world.",
"rating": 8,
"released": "2010-12-16",
"runtime": 125,
"status": "released",
"tagline": "The Game Has Changed.",
"title": "TRON: Legacy",
"trailer": null,
"updated_at": "2014-07-23T03:21:46.000Z",
"votes": 111,
"year": 2010
}
}
}
}
},
"description": "```\n/movies/tron-legacy-2010?extended=full\n```",
"headers": {}
}
},
"summary": "Get a movie",
"tags": [
"Movies"
]
}
},
"/movies/{id}/aliases": {
"get": {
"description": "Returns all title aliases for a movie. Includes country where name is different.",
"operationId": "Get all movie aliases",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "ca",
"title": "Batman 1 - Batman Begins"
},
{
"country": "br",
"title": "Batman 5 Begins"
},
{
"country": "ar",
"title": "Batman inicia"
},
{
"country": "us",
"title": "Batman 5: Batman Begins"
},
{
"country": "tw",
"title": "蝙蝠俠：開戰時刻"
},
{
"country": "si",
"title": "Batman: Na začetku"
},
{
"country": "es",
"title": "Batman Begins"
},
{
"country": "de",
"title": "Batman Begins"
},
{
"country": "no",
"title": "Batman - Batman Begins"
},
{
"country": "ca",
"title": "Batman:Le commencement"
},
{
"country": "us",
"title": "Batman Dark Knight 1: Batman Begins"
},
{
"country": "cn",
"title": "蝙蝠侠：侠影之谜"
},
{
"country": "ru",
"title": "Бэтмен: Начало"
},
{
"country": "ua",
"title": "Бетмен: Початок"
},
{
"country": "kr",
"title": "배트맨 비긴즈"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all movie aliases",
"tags": [
"Movies"
]
}
},
"/movies/{id}/comments/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all top level comments for a movie. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, most `replies`, `highest` rated, `lowest` rated, and most `plays`.",
"operationId": "Get all movie comments",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies",
"highest",
"lowest",
"plays"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Great movie!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all movie comments",
"tags": [
"Movies"
]
}
},
"/movies/{id}/lists/{type}/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists that contain this movie. By default, `personal` lists are returned sorted by the most `popular`.",
"operationId": "Get lists containing this movie",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific list type",
"example": "personal",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"personal",
"official",
"watchlists",
"recommendations"
],
"type": "string"
}
},
{
"description": "How to sort",
"example": "popular",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"popular",
"likes",
"comments",
"items",
"added",
"updated"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get lists containing this movie",
"tags": [
"Movies"
]
}
},
"/movies/{id}/people": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all `cast` and `crew` for a movie. Each `cast` member will have a `characters` array and a standard `person` object.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, and `editing` (if there are people for those crew positions). Each of those members will have a `jobs` array and a standard `person` object.",
"operationId": "Get all people for a movie",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Sam Flynn"
],
"person": {
"ids": {
"imdb": "nm1330560",
"slug": "garrett-hedlund",
"tmdb": 9828,
"trakt": 1
},
"name": "Garrett Hedlund"
}
},
{
"characters": [
"Kevin Flynn",
"Clu"
],
"person": {
"ids": {
"imdb": "nm0000313",
"slug": "jeff-bridges",
"tmdb": 1229,
"trakt": 2
},
"name": "Jeff Bridges"
}
},
{
"characters": [
"Quorra"
],
"person": {
"ids": {
"imdb": "nm1312575",
"slug": "olivia-wilde",
"tmdb": 59315,
"trakt": 3
},
"name": "Olivia Wilde"
}
},
{
"characters": [
"Alan Bradley",
"Tron"
],
"person": {
"ids": {
"imdb": "nm0000310",
"slug": "bruce-boxleitner",
"tmdb": 2547,
"trakt": 4
},
"name": "Bruce Boxleitner"
}
},
{
"characters": [
"Siren"
],
"person": {
"ids": {
"imdb": "",
"slug": "yaya-dacosta",
"tmdb": 60033,
"trakt": 5
},
"name": "Yaya DaCosta"
}
},
{
"characters": [
"Siren"
],
"person": {
"ids": {
"imdb": "",
"slug": "serinda-swan",
"tmdb": 86268,
"trakt": 6
},
"name": "Serinda Swan"
}
},
{
"characters": [
"Siren"
],
"person": {
"ids": {
"imdb": "nm1683768",
"slug": "beau-garrett",
"tmdb": 20403,
"trakt": 7
},
"name": "Beau Garrett"
}
},
{
"characters": [
"Siren"
],
"person": {
"ids": {
"imdb": "",
"slug": "elizabeth-mathis",
"tmdb": 130108,
"trakt": 8
},
"name": "Elizabeth Mathis"
}
},
{
"characters": [
"Jarvis"
],
"person": {
"ids": {
"imdb": "nm0289656",
"slug": "james-frain",
"tmdb": 22063,
"trakt": 9
},
"name": "James Frain"
}
},
{
"characters": [
"Young Mrs. Flynn"
],
"person": {
"ids": {
"imdb": "",
"slug": "amy-esterle",
"tmdb": 86269,
"trakt": 10
},
"name": "Amy Esterle"
}
},
{
"characters": [
"Sobel"
],
"person": {
"ids": {
"imdb": "",
"slug": "brandon-jay-mclaren",
"tmdb": 58371,
"trakt": 11
},
"name": "Brandon Jay McLaren"
}
},
{
"characters": [
"Castor",
"Zuse"
],
"person": {
"ids": {
"imdb": "nm0790688",
"slug": "michael-sheen",
"tmdb": 3968,
"trakt": 12
},
"name": "Michael Sheen"
}
},
{
"characters": [
"Young Sam"
],
"person": {
"ids": {
"imdb": "",
"slug": "owen-best",
"tmdb": 109205,
"trakt": 13
},
"name": "Owen Best"
}
},
{
"characters": [
"Green Light Cycle Rider"
],
"person": {
"ids": {
"imdb": "nm1083137",
"slug": "michael-teigen",
"tmdb": 37980,
"trakt": 14
},
"name": "Michael Teigen"
}
},
{
"characters": [
"Masked DJ's"
],
"person": {
"ids": {
"imdb": "",
"slug": "daft-punk",
"tmdb": 67931,
"trakt": 15
},
"name": "Daft Punk"
}
},
{
"characters": [
"Chattering Homeless Man"
],
"person": {
"ids": {
"imdb": "",
"slug": "ron-selmour",
"tmdb": 10874,
"trakt": 16
},
"name": "Ron Selmour"
}
},
{
"characters": [
"Bartik"
],
"person": {
"ids": {
"imdb": "",
"slug": "conrad-coates",
"tmdb": 43263,
"trakt": 17
},
"name": "Conrad Coates"
}
},
{
"characters": [
"Half Faced Man (as Yurij Kis)"
],
"person": {
"ids": {
"imdb": "",
"slug": "kis-yurij",
"tmdb": 145110,
"trakt": 18
},
"name": "Kis Yurij"
}
}
],
"crew": {
"art": [
{
"jobs": [
"Production Design"
],
"person": {
"ids": {
"imdb": "",
"slug": "darren-gilford",
"tmdb": 411385,
"trakt": 22
},
"name": "Darren Gilford"
}
},
{
"jobs": [
"Set Decoration"
],
"person": {
"ids": {
"imdb": "nm0003106",
"slug": "lin-macdonald",
"tmdb": 12384,
"trakt": 25
},
"name": "Lin MacDonald"
}
}
],
"camera": [
{
"jobs": [
"Director of Photography"
],
"person": {
"ids": {
"imdb": "",
"slug": "claudio-miranda",
"tmdb": 51333,
"trakt": 41
},
"name": "Claudio Miranda"
}
}
],
"costume & make-up": [
{
"jobs": [
"Costume Design"
],
"person": {
"ids": {
"imdb": "nm0929452",
"slug": "michael-wilkinson",
"tmdb": 5392,
"trakt": 26
},
"name": "Michael Wilkinson"
}
},
{
"jobs": [
"Makeup Department Head"
],
"person": {
"ids": {
"imdb": "nm0196301",
"slug": "rosalina-da-silva",
"tmdb": 75294,
"trakt": 27
},
"name": "Rosalina Da Silva"
}
},
{
"jobs": [
"Costume Supervisor"
],
"person": {
"ids": {
"imdb": "",
"slug": "tangi-crawford",
"tmdb": 1323289,
"trakt": 28
},
"name": "Tangi Crawford"
}
}
],
"crew": [
{
"jobs": [
"Supervising Art Director"
],
"person": {
"ids": {
"imdb": "nm0411131",
"slug": "kevin-ishioka",
"tmdb": 6878,
"trakt": 23
},
"name": "Kevin Ishioka"
}
},
{
"jobs": [
"Supervising Art Director"
],
"person": {
"ids": {
"imdb": "nm0543729",
"slug": "mark-w-mansbridge",
"tmdb": 21070,
"trakt": 24
},
"name": "Mark W. Mansbridge"
}
}
],
"directing": [
{
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm2676052",
"slug": "joseph-kosinski",
"tmdb": 86270,
"trakt": 29
},
"name": "Joseph Kosinski"
}
}
],
"production": [
{
"jobs": [
"Casting"
],
"person": {
"ids": {
"imdb": "nm0104840",
"slug": "heike-brandstatter",
"tmdb": 5362,
"trakt": 19
},
"name": "Heike Brandstatter"
}
},
{
"jobs": [
"Casting"
],
"person": {
"ids": {
"imdb": "nm0278168",
"slug": "sarah-finn",
"tmdb": 7232,
"trakt": 20
},
"name": "Sarah Finn"
}
},
{
"jobs": [
"Casting"
],
"person": {
"ids": {
"imdb": "nm0563042",
"slug": "coreen-mayrs",
"tmdb": 5363,
"trakt": 21
},
"name": "Coreen Mayrs"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "sean-bailey",
"tmdb": 39387,
"trakt": 34
},
"name": "Sean Bailey"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "steven-lisberger",
"tmdb": 12859,
"trakt": 33
},
"name": "Steven Lisberger"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "jeffrey-silver",
"tmdb": 20908,
"trakt": 35
},
"name": "Jeffrey Silver"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "bruce-franklin",
"tmdb": 113981,
"trakt": 36
},
"name": "Bruce Franklin"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "steve-gaub",
"tmdb": 63289,
"trakt": 37
},
"name": "Steve Gaub"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "justis-greene",
"tmdb": 113982,
"trakt": 38
},
"name": "Justis Greene"
}
},
{
"jobs": [
"Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "julien-lemaitre",
"tmdb": 113983,
"trakt": 39
},
"name": "Julien Lemaitre"
}
},
{
"job": [
"Executive Producer"
],
"person": {
"ids": {
"imdb": "",
"slug": "donald-kushner",
"tmdb": 6889,
"trakt": 40
},
"name": "Donald Kushner"
}
}
],
"sound": [
{
"jobs": [
"Music"
],
"person": {
"ids": {
"imdb": "",
"slug": "daft-punk",
"tmdb": 67931,
"trakt": 15
},
"name": "Daft Punk"
}
}
],
"writing": [
{
"jobs": [
"Screenplay"
],
"person": {
"ids": {
"imdb": "",
"slug": "adam-horowitz",
"tmdb": 44035,
"trakt": 30
},
"name": "Adam Horowitz"
}
},
{
"job": [
"Screenplay"
],
"person": {
"ids": {
"imdb": "",
"slug": "richard-jefferies",
"tmdb": 73570,
"trakt": 31
},
"name": "Richard Jefferies"
}
},
{
"jobs": [
"Screenplay"
],
"person": {
"ids": {
"imdb": "",
"slug": "edward-kitsis",
"tmdb": 44034,
"trakt": 32
},
"name": "Edward Kitsis"
}
},
{
"jobs": [
"Screenplay"
],
"person": {
"ids": {
"imdb": "",
"slug": "steven-lisberger",
"tmdb": 12859,
"trakt": 33
},
"name": "Steven Lisberger"
}
}
]
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all people for a movie",
"tags": [
"Movies"
]
}
},
"/movies/{id}/ratings": {
"get": {
"description": "Returns rating (between 0 and 10) and distribution for a movie.",
"operationId": "Get movie ratings",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"distribution": {
"1": 298,
"2": 46,
"3": 87,
"4": 178,
"5": 446,
"6": 1167,
"7": 1855,
"8": 1543,
"9": 662,
"10": 1583
},
"rating": 7.33778,
"votes": 7866
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get movie ratings",
"tags": [
"Movies"
]
}
},
"/movies/{id}/related": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nReturns related and similar movies.",
"operationId": "Get related movies",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt0107290",
"slug": "jurassic-park-1993",
"tmdb": 329,
"trakt": 393
},
"title": "Jurassic Park",
"year": 1993
},
{
"ids": {
"imdb": "tt0088763",
"slug": "back-to-the-future-1985",
"tmdb": 105,
"trakt": 308
},
"title": "Back to the Future",
"year": 1985
},
{
"ids": {
"imdb": "tt1250777",
"slug": "kick-ass-2010",
"tmdb": 23483,
"trakt": 171
},
"title": "Kick-Ass",
"year": 2010
},
{
"ids": {
"imdb": "tt1119646",
"slug": "the-hangover-2009",
"tmdb": 18785,
"trakt": 547
},
"title": "The Hangover",
"year": 2009
},
{
"ids": {
"imdb": "tt0096874",
"slug": "back-to-the-future-part-ii-1989",
"tmdb": 165,
"trakt": 384
},
"title": "Back to the Future Part II",
"year": 1989
},
{
"ids": {
"imdb": "tt1156398",
"slug": "zombieland-2009",
"tmdb": 19908,
"trakt": 205
},
"title": "Zombieland",
"year": 2009
},
{
"ids": {
"imdb": "tt1375666",
"slug": "inception-2010",
"tmdb": 27205,
"trakt": 108
},
"title": "Inception",
"year": 2010
},
{
"ids": {
"imdb": "tt0172495",
"slug": "gladiator-2000",
"tmdb": 98,
"trakt": 463
},
"title": "Gladiator",
"year": 2000
},
{
"ids": {
"imdb": "tt0208092",
"slug": "snatch-2000",
"tmdb": 107,
"trakt": 1473
},
"title": "Snatch",
"year": 2000
},
{
"ids": {
"imdb": "tt0246578",
"slug": "donnie-darko-2001",
"tmdb": 141,
"trakt": 114
},
"title": "Donnie Darko",
"year": 2001
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get related movies",
"tags": [
"Movies"
]
}
},
"/movies/{id}/releases/{country}": {
"get": {
"description": "Returns all releases for a movie including country, certification, release date, release type, and note. The release type can be set to `unknown`, `premiere`, `limited`, `theatrical`, `digital`, `physical`, or `tv`. The `note` might have optional info such as the film festival name for a `premiere` release or Blu-ray specs for a `physical` release. We pull this info from [TMDB](https://developers.themoviedb.org/3/movies/get-movie-release-dates).",
"operationId": "Get all movie releases",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "2 character country code",
"example": "us",
"in": "path",
"name": "country",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"certification": "PG",
"country": "us",
"note": null,
"release_date": "2010-12-16",
"release_type": "theatrical"
},
{
"certification": "PG",
"country": "gb",
"note": null,
"release_date": "2010-12-17",
"release_type": "theatrical"
},
{
"certification": "12",
"country": "de",
"note": null,
"release_date": "2011-01-26",
"release_type": "theatrical"
},
{
"certification": "U",
"country": "fr",
"note": null,
"release_date": "2011-02-09",
"release_type": "theatrical"
},
{
"certification": "",
"country": "it",
"note": null,
"release_date": "2010-12-29",
"release_type": "theatrical"
},
{
"certification": "PG-13",
"country": "tr",
"note": null,
"release_date": "2011-01-28",
"release_type": "theatrical"
},
{
"certification": "",
"country": "ca",
"note": null,
"release_date": "2010-12-17",
"release_type": "theatrical"
},
{
"certification": "12",
"country": "nl",
"note": null,
"release_date": "2011-01-28",
"release_type": "theatrical"
},
{
"certification": "Б14",
"country": "kz",
"note": null,
"release_date": "2010-12-15",
"release_type": "theatrical"
},
{
"certification": "12",
"country": "sk",
"note": null,
"release_date": "2011-01-06",
"release_type": "theatrical"
},
{
"certification": "전체 관람가",
"country": "kr",
"note": null,
"release_date": "2010-12-29",
"release_type": "theatrical"
},
{
"certification": "PG",
"country": "au",
"note": null,
"release_date": "2010-12-16",
"release_type": "theatrical"
},
{
"certification": "PG",
"country": "gr",
"note": null,
"release_date": "2010-12-16",
"release_type": "theatrical"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all movie releases",
"tags": [
"Movies"
]
}
},
"/movies/{id}/stats": {
"get": {
"description": "Returns lots of movie stats.",
"operationId": "Get movie stats",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"collectors": 27379,
"comments": 36,
"lists": 4561,
"plays": 51033,
"recommended": 54321,
"votes": 7866,
"watchers": 39204
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get movie stats",
"tags": [
"Movies"
]
}
},
"/movies/{id}/studios": {
"get": {
"description": "Returns all studios for a movie.",
"operationId": "Get movie studios",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "us",
"ids": {
"slug": "20th-century-fox",
"tmdb": 25,
"trakt": 20
},
"name": "20th Century Fox"
},
{
"country": "us",
"ids": {
"slug": "marvel-entertainment",
"tmdb": 7505,
"trakt": 19
},
"name": "Marvel Entertainment"
},
{
"country": "us",
"ids": {
"slug": "the-donners-company",
"tmdb": 431,
"trakt": 25
},
"name": "The Donners' Company"
},
{
"country": "us",
"ids": {
"slug": "tsg-entertainment",
"tmdb": 22213,
"trakt": 22
},
"name": "TSG Entertainment"
},
{
"country": "us",
"ids": {
"slug": "genre-films",
"tmdb": 28788,
"trakt": 23
},
"name": "Genre Films"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get movie studios",
"tags": [
"Movies"
]
}
},
"/movies/{id}/translations/{language}": {
"get": {
"description": "Returns all translations for a movie, including language and translated values for title, tagline and overview.",
"operationId": "Get all movie translations",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "2 character language code",
"example": "es",
"in": "path",
"name": "language",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "us",
"language": "en",
"overview": "Driven by tragedy, billionaire Bruce Wayne dedicates his life to uncovering and defeating the corruption that plagues his home, Gotham City. Unable to work within the system, he instead creates a new identity, a symbol of fear for the criminal underworld - The Batman.",
"tagline": "Evil fears the knight.",
"title": "Batman Begins"
},
{
"country": "de",
"language": "de",
"overview": "...",
"tagline": "Das Böse fürchtet den Ritter.",
"title": "Batman Begins"
},
{
"country": "da",
"language": "da",
"overview": "...",
"tagline": "",
"title": "Batman Begins"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all movie translations",
"tags": [
"Movies"
]
}
},
"/movies/{id}/watching": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all users watching this movie right now.",
"operationId": "Get users watching right now",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "tron-legacy-2010",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
{
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get users watching right now",
"tags": [
"Movies"
]
}
},
"/networks": {
"get": {
"description": "Get a list of all TV networks, including the name.",
"operationId": "Get networks",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"name": "A&E"
},
{
"name": "ABC (US)"
},
{
"name": "AMC"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get networks",
"tags": [
"Networks"
]
}
},
"/oauth/authorize": {
"get": {
"description": "Construct then redirect to this URL. The Trakt website will request permissions for your app, which the user needs to approve. If the user isn't signed into Trakt, it will ask them to do so. Send `signup=true` if you prefer the account sign up page to be the default.\n\n**Note:** You should use the normal **https://trakt.tv** hostname when creating this URL and not the API URL.",
"operationId": "Authorize Application",
"parameters": [
{
"description": "Must be set to code.",
"example": "code",
"in": "query",
"name": "response_type",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Get this from your app settings.",
"example": " ",
"in": "query",
"name": "client_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "URI specified in your app settings.",
"example": " ",
"in": "query",
"name": "redirect_uri",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "State variable for CSRF purposes.",
"example": " ",
"in": "query",
"name": "state",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"description": "Default to the sign up page."
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "Authorize Application",
"tags": [
"Authentication - OAuth"
]
}
},
"/oauth/device/code": {
"post": {
"description": "Generate new codes to start the device authentication process. The `device_code` and `interval` will be used later to poll for the `access_token`. The `user_code` and `verification_url` should be presented to the user as mentioned in the flow steps above.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `client_id` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |",
"operationId": "Generate new device codes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"client_id": "9b36d8c0db59eff5038aea7a417d73e69aea75b41aac771816d2ef1b3109cc2f"
},
"properties": {
"client_id": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"device_code": "d9c126a7706328d808914cfd1e40274b6e009f684b1aca271b9b3f90b3630d64",
"expires_in": 600,
"interval": 5,
"user_code": "5055CC52",
"verification_url": "https://trakt.tv/activate"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Generate new device codes",
"tags": [
"Authentication - Devices"
]
}
},
"/oauth/device/token": {
"post": {
"description": "Use the `device_code` and poll at the `interval` (in seconds) to check if the user has authorized you app. Use `expires_in` to stop polling after that many seconds, and gracefully instruct the user to restart the process. **It is important to poll at the correct interval and also stop polling when expired.**\n\nWhen you receive a `200` success response, save the `access_token` so your app can authenticate the user in methods that require it. The `access_token` is valid for 3 months. Save and use the `refresh_token` to get a new `access_token` without asking the user to re-authenticate. Check below for all the error codes that you should handle.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `code` <span style=\"color:red;\">*</a> | string | `device_code` from the initial method. |\n| `client_id` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |\n| `client_secret` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |\n\n#### Status Codes\n\nThis method will send various HTTP status codes that you should handle accordingly.\n\n| Code | Description |\n|---|---|\n| `200` | Success - *save the `access_token`*\n| `400` | Pending - *waiting for the user to authorize your app*\n| `404` | Not Found - *invalid `device_code`*\n| `409` | Already Used - *user already approved this code*\n| `410` | Expired - *the tokens have expired, restart the process*\n| `418` | Denied - *user explicitly denied this code*\n| `429` | Slow Down - *your app is polling too quickly*",
"operationId": "Poll for the access_token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"client_id": "9b36d8c0db59eff5038aea7a417d73e69aea75b41aac771816d2ef1b3109cc2f",
"client_secret": "d6ea27703957b69939b8104ed4524595e210cd2e79af587744a7eb6e58f5b3d2",
"code": "fd0847dbb559752d932dd3c1ac34ff98d27b11fe2fea5a864f44740cd7919ad0"
},
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"code": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"access_token": "dbaf9757982a9e738f05d249b7b5b4a266b3a139049317c4909f2f263572c781",
"created_at": 1487889741,
"expires_in": 7200,
"refresh_token": "76ba4c5c75c96f6087f58a4de10be6c00b29ea1ddc3b2022ee2016d1363e3a7c",
"scope": "public",
"token_type": "bearer"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Poll for the access_token",
"tags": [
"Authentication - Devices"
]
}
},
"/oauth/revoke": {
"post": {
"description": "An `access_token` can be revoked when a user signs out of their Trakt account in your app. This is not required, but might improve the user experience so the user doesn't have an unused app connection hanging around.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `token` <span style=\"color:red;\">*</a> | string | A valid OAuth `access_token`. |\n| `client_id` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |\n| `client_secret` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |",
"operationId": "Revoke an access_token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"client_id": "9b36d8c0db59eff5038aea7a417d73e69aea75b41aac771816d2ef1b3109cc2f",
"client_secret": "d6ea27703957b69939b8104ed4524595e210cd2e79af587744a7eb6e58f5b3d2",
"token": "fd0847dbb559752d932dd3c1ac34ff98d27b11fe2fea5a864f44740cd7919ad0"
},
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Revoke an access_token",
"tags": [
"Authentication - OAuth"
]
}
},
"/oauth/token": {
"post": {
"description": "Use the `refresh_token` to get a new `access_token` without asking the user to re-authenticate. The `access_token` is valid for 3 months before it needs to be refreshed again.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `refresh_token` <span style=\"color:red;\">*</a> | string | Saved from the initial token method. |\n| `client_id` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |\n| `client_secret` <span style=\"color:red;\">*</a> | string | Get this from your app settings. |\n| `redirect_uri` <span style=\"color:red;\">*</a> | string | URI specified in your app settings. |\n| `grant_type` <span style=\"color:red;\">* </a> | string | `refresh_token` |",
"operationId": "Exchange refresh_token for access_token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"client_id": "9b36d8c0db59eff5038aea7a417d73e69aea75b41aac771816d2ef1b3109cc2f",
"client_secret": "d6ea27703957b69939b8104ed4524595e210cd2e79af587744a7eb6e58f5b3d2",
"grant_type": "refresh_token",
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
"refresh_token": "fd0847dbb559752d932dd3c1ac34ff98d27b11fe2fea5a864f44740cd7919ad0"
},
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"grant_type": {
"type": "string"
},
"redirect_uri": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"access_token": "dbaf9757982a9e738f05d249b7b5b4a266b3a139049317c4909f2f263572c781",
"created_at": 1487889741,
"expires_in": 7200,
"refresh_token": "76ba4c5c75c96f6087f58a4de10be6c00b29ea1ddc3b2022ee2016d1363e3a7c",
"scope": "public",
"token_type": "bearer"
}
}
}
}
},
"description": "If the `refresh_token` is valid, you'll get the `access_token` back.",
"headers": {}
},
"401": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"error": "invalid_grant",
"error_description": "The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client."
}
}
}
}
},
"description": "If the `refresh_token` is invalid, you'll get a `401` error.",
"headers": {}
}
},
"summary": "Exchange refresh_token for access_token",
"tags": [
"Authentication - OAuth"
]
}
},
"/people/updates/id/{start_date}": {
"get": {
"description": "#### 📄 Pagination\n\nReturns all people Trakt IDs updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated people Trakt IDs",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
1,
20,
34,
50
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated people Trakt IDs",
"tags": [
"People"
]
}
},
"/people/updates/{start_date}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nReturns all people updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated people",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"person": {
"ids": {
"imdb": "nm1214435",
"slug": "charlie-cox",
"tmdb": 23458,
"trakt": 417084,
"tvrage": 145276
},
"name": "Charlie Cox"
},
"updated_at": "2022-11-03T18:58:09.000Z"
},
{
"person": {
"ids": {
"imdb": "nm2832695",
"slug": "deborah-ann-woll",
"tmdb": 212154,
"trakt": 451773,
"tvrage": null
},
"name": "Deborah Ann Woll"
},
"updated_at": "2022-11-03T18:58:09.000Z"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated people",
"tags": [
"People"
]
}
},
"/people/{id}": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns a single person's details.\n\n#### Gender\n\nIf available, the `gender` property will be set to `male`, `female`, or `non_binary`.\n\n#### Known For Department\n\nIf available, the `known_for_department` property will be set to `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, or `editing`. Many people have credits across departments, `known_for` allows you to select their default credits more accurately.",
"operationId": "Get a single person",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "bryan-cranston",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"biography": "Bryan Lee Cranston (born March 7, 1956) is an American actor, voice actor, writer and director.He is perhaps best known for his roles as Hal, the father in the Fox situation comedy \"Malcolm in the Middle\", and as Walter White in the AMC drama series Breaking Bad, for which he has won three consecutive Outstanding Lead Actor in a Drama Series Emmy Awards. Other notable roles include Dr. Tim Whatley on Seinfeld, Doug Heffernan's neighbor in The King of Queens, Astronaut Buzz Aldrin in From the Earth to the Moon, and Ted Mosby's boss on How I Met Your Mother. Description above from the Wikipedia article Bryan Cranston, licensed under CC-BY-SA, full list of contributors on Wikipedia.",
"birthday": "1956-03-07",
"birthplace": "San Fernando Valley, California, USA",
"death": null,
"gender": "male",
"homepage": "http://www.bryancranston.com/",
"ids": {
"imdb": "nm0186505",
"slug": "bryan-cranston",
"tmdb": 17419,
"trakt": 1
},
"known_for_department": "acting",
"name": "Bryan Cranston",
"social_ids": {
"facebook": "thebryancranston",
"instagram": "bryancranston",
"twitter": "BryanCranston",
"wikipedia": null
},
"updated_at": "2022-11-03T17:00:54.000Z"
}
}
}
}
},
"description": "```\n/people/bryan-cranston?extended=full\n```",
"headers": {}
}
},
"summary": "Get a single person",
"tags": [
"People"
]
}
},
"/people/{id}/lists/{type}/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists that contain this person. By default, `personal` lists are returned sorted by the most `popular`.",
"operationId": "Get lists containing this person",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "bryan-cranston",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific list type",
"example": "personal",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"personal",
"official"
],
"type": "string"
}
},
{
"description": "How to sort",
"example": "popular",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"popular",
"likes",
"comments",
"items",
"added",
"updated"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get lists containing this person",
"tags": [
"People"
]
}
},
"/people/{id}/movies": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all movies where this person is in the `cast` or `crew`. Each `cast` object will have a `characters` array and a standard `movie` object.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, and `editing` (if there are people for those crew positions). Each of those members will have a `jobs` array and a standard `movie` object.",
"operationId": "Get movie credits",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "bryan-cranston",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Joe Brody"
],
"movie": {
"ids": {
"imdb": "tt0831387",
"slug": "godzilla-2014",
"tmdb": 124905,
"trakt": 24
},
"title": "Godzilla",
"year": 2014
}
}
],
"crew": {
"directing": [
{
"jobs": [
"Director"
],
"movie": {
"ids": {
"imdb": "tt0831387",
"slug": "godzilla-2014",
"tmdb": 124905,
"trakt": 24
},
"title": "Godzilla",
"year": 2014
}
}
],
"producing": [
{
"jobs": [
"Producer"
],
"movie": {
"ids": {
"imdb": "tt0831387",
"slug": "godzilla-2014",
"tmdb": 124905,
"trakt": 24
},
"title": "Godzilla",
"year": 2014
}
}
],
"writing": [
{
"jobs": [
"Screenplay"
],
"movie": {
"ids": {
"imdb": "tt0831387",
"slug": "godzilla-2014",
"tmdb": 124905,
"trakt": 24
},
"title": "Godzilla",
"year": 2014
}
}
]
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get movie credits",
"tags": [
"People"
]
}
},
"/people/{id}/shows": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all shows where this person is in the `cast` or `crew`, including the `episode_count` for which they appear. Each `cast` object will have a `characters` array and a standard `show` object. If `series_regular` is `true`, this person is a series regular and not simply a guest star.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, `editing`, and `created by` (if there are people for those crew positions). Each of those members will have a `jobs` array and a standard `show` object.",
"operationId": "Get show credits",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "bryan-cranston",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Walter White"
],
"episode_count": 62,
"series_regular": true,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
}
],
"crew": {
"production": [
{
"jobs": [
"Producer"
],
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
}
]
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get show credits",
"tags": [
"People"
]
}
},
"/recommendations/movies": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nMovie recommendations for a user. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page. Set `ignore_collected=true` to filter out movies the user has already collected or `ignore_watchlisted=true` to filter out movies the user has already watchlisted.",
"operationId": "Get movie recommendations",
"parameters": [
{
"description": "filter out collected movies",
"example": "false",
"in": "query",
"name": "ignore_collected",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"type": "string"
}
},
{
"description": "filter out watchlisted movies",
"example": "false",
"in": "query",
"name": "ignore_watchlisted",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt2545118",
"slug": "blackfish-2013",
"tmdb": 158999,
"trakt": 58
},
"title": "Blackfish",
"year": 2013
},
{
"ids": {
"imdb": "tt1566648",
"slug": "waiting-for-superman-2010",
"tmdb": 39440,
"trakt": 289
},
"title": "Waiting for Superman",
"year": 2010
},
{
"ids": {
"imdb": "tt1645089",
"slug": "inside-job-2010",
"tmdb": 44639,
"trakt": 329
},
"title": "Inside Job",
"year": 2010
},
{
"ids": {
"imdb": "tt0332379",
"slug": "school-of-rock-2003",
"tmdb": 1584,
"trakt": 503
},
"title": "School of Rock",
"year": 2003
},
{
"ids": {
"imdb": "tt1189340",
"slug": "the-lincoln-lawyer-2011",
"tmdb": 50348,
"trakt": 513
},
"title": "The Lincoln Lawyer",
"year": 2011
},
{
"ids": {
"imdb": "tt1488555",
"slug": "the-change-up-2011",
"tmdb": 49520,
"trakt": 822
},
"title": "The Change-Up",
"year": 2011
},
{
"ids": {
"imdb": "tt1306980",
"slug": "50-50-2011",
"tmdb": 40807,
"trakt": 907
},
"title": "50/50",
"year": 2011
},
{
"ids": {
"imdb": "tt1210166",
"slug": "moneyball-2011",
"tmdb": 60308,
"trakt": 945
},
"title": "Moneyball",
"year": 2011
},
{
"ids": {
"imdb": "tt0903660",
"slug": "killer-at-large-2008",
"tmdb": 37312,
"trakt": 3549
},
"title": "Killer at Large",
"year": 2008
},
{
"ids": {
"imdb": "tt0485773",
"slug": "green-day-bullet-in-a-bible-2005",
"tmdb": 26627,
"trakt": 3770
},
"title": "Green Day: Bullet in a Bible",
"year": 2005
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get movie recommendations",
"tags": [
"Recommendations"
]
}
},
"/recommendations/movies/{id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nHide a movie from getting recommended anymore.",
"operationId": "Hide a movie recommendation",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "922",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Hide a movie recommendation",
"tags": [
"Recommendations"
]
}
},
"/recommendations/shows": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nTV show recommendations for a user. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page. Set `ignore_collected=true` to filter out shows the user has already collected or `ignore_watchlisted=true` to filter out shows the user has already watchlisted.",
"operationId": "Get show recommendations",
"parameters": [
{
"description": "filter out collected shows",
"example": "false",
"in": "query",
"name": "ignore_collected",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"type": "string"
}
},
{
"description": "filter out watchlisted movies",
"example": "false",
"in": "query",
"name": "ignore_watchlisted",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt0429318",
"slug": "the-biggest-loser",
"tmdb": 579,
"trakt": 9,
"tvdb": 75166
},
"title": "The Biggest Loser",
"year": 2004
},
{
"ids": {
"imdb": "tt1442550",
"slug": "shark-tank",
"tmdb": 30703,
"trakt": 36,
"tvdb": 100981
},
"title": "Shark Tank",
"year": 2009
},
{
"ids": {
"imdb": "tt0437005",
"slug": "hell-s-kitchen",
"tmdb": 2370,
"trakt": 40,
"tvdb": 74897
},
"title": "Hell's Kitchen",
"year": 2005
},
{
"ids": {
"imdb": "tt1515193",
"slug": "the-big-c",
"tmdb": 32406,
"trakt": 51,
"tvdb": 161501
},
"title": "The Big C",
"year": 2010
},
{
"ids": {
"imdb": "tt1001482",
"slug": "united-states-of-tara",
"tmdb": 7097,
"trakt": 69,
"tvdb": 83463
},
"title": "United States of Tara",
"year": 2009
},
{
"ids": {
"imdb": "tt1229413",
"slug": "hung",
"tmdb": 18614,
"trakt": 168,
"tvdb": 82091
},
"title": "Hung",
"year": 2009
},
{
"ids": {
"imdb": "tt0421030",
"slug": "big-love",
"tmdb": 4392,
"trakt": 272,
"tvdb": 74156
},
"title": "Big Love",
"year": 2006
},
{
"ids": {
"imdb": "tt2467372",
"slug": "brooklyn-nine-nine",
"tmdb": 48891,
"trakt": 599,
"tvdb": 269586
},
"title": "Brooklyn Nine-Nine",
"year": 2013
},
{
"ids": {
"imdb": "tt1441135",
"slug": "flashforward",
"tmdb": 19092,
"trakt": 677,
"tvdb": 84024
},
"title": "FlashForward",
"year": 2009
},
{
"ids": {
"imdb": "tt0201391",
"slug": "roswell",
"tmdb": 4624,
"trakt": 717,
"tvdb": 73965
},
"title": "Roswell",
"year": 1999
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get show recommendations",
"tags": [
"Recommendations"
]
}
},
"/recommendations/shows/{id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nHide a show from getting recommended anymore.",
"operationId": "Hide a show recommendation",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "922",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Hide a show recommendation",
"tags": [
"Recommendations"
]
}
},
"/scrobble/pause": {
"post": {
"description": "#### 🔒 OAuth Required\n\nUse this method when the video is paused. The playback progress will be saved and [**/sync/playback**](/reference/sync/playback/) can be used to resume the video from this exact position. Unpause a video by calling the [**/scrobble/start**](/reference/scrobble/start/) method again.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie` or `episode` object. (see examples →) |\n| `progress` <span style=\"color:red;\">*</a> | float | Progress percentage between 0 and 100. |\n| `app_version` | string | Version number of the app. |\n| `app_date` | string | Build date of the app. |",
"operationId": "Pause watching in a media center",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"app_date": "2014-09-22",
"app_version": "1.0",
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"progress": 75
},
"properties": {
"app_date": {
"type": "string"
},
"app_version": {
"type": "string"
},
"movie": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"progress": {
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"action": "pause",
"id": 0,
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"progress": 75,
"sharing": {
"tumblr": false,
"twitter": false
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Pause watching in a media center",
"tags": [
"Scrobble"
]
}
},
"/scrobble/start": {
"post": {
"description": "#### 🔒 OAuth Required\n\nUse this method when the video initially starts playing or is unpaused. This will remove any playback progress if it exists.\n\n**Note:** A watching status will auto expire after the remaining runtime has elapsed. There is no need to call this method again while continuing to watch the same item.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie` or `episode` object. (see examples →) |\n| `progress` <span style=\"color:red;\">*</a> | float | Progress percentage between 0 and 100. |\n| `app_version` | string | Version number of the app. |\n| `app_date` | string | Build date of the app. |",
"operationId": "Start watching in a media center",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"app_date": "2014-09-22",
"app_version": "1.0",
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"progress": 1.25
},
"properties": {
"app_date": {
"type": "string"
},
"app_version": {
"type": "string"
},
"movie": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"progress": {
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"action": "start",
"episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 856373,
"tvdb": 362082
},
"number": 21,
"season": 9,
"title": "Light the Fire of Shandia! Wiper the Warrior"
},
"id": 0,
"progress": 10,
"sharing": {
"tumblr": false,
"twitter": true
},
"show": {
"ids": {
"imdb": "tt0388629",
"slug": "one-piece",
"tmdb": 37854,
"trakt": 37696,
"tvdb": 81797
},
"title": "One Piece",
"year": 1999
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
}
],
"summary": "Start watching in a media center",
"tags": [
"Scrobble"
]
}
},
"/scrobble/stop": {
"post": {
"description": "#### 🔒 OAuth Required\n\nUse this method when the video is stopped or finishes playing on its own. If the progress is above 80%, the video will be scrobbled and the `action` will be set to **scrobble**. A unique history `id` (64-bit integer) will be returned and can be used to reference this `scrobble` directly.\n\nIf the progress is less than 80%, it will be treated as a *pause* and the `action` will be set to **pause**. The playback progress will be saved and [**/sync/playback**](/reference/sync/playback/) can be used to resume the video from this exact position.\n\n**Note:** If you prefer to use a threshold higher than 80%, you should use [**/scrobble/pause**](/reference/scrobble/pause/) yourself so it doesn't create duplicate scrobbles.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie` or `episode` object. (see examples →) |\n| `progress` <span style=\"color:red;\">*</a> | flloat | Progress percentage between 0 and 100. |\n| `app_version` | string | Version number of the app. |\n| `app_date` | string | Build date of the app. |\n\n**Note:** If the same item was just scrobbled, a `409` HTTP status code will returned to avoid scrobbling a duplicate. The response will contain a `watched_at` timestamp when the item was last scrobbled and a `expires_at` timestamp when the item can be scrobbled again.",
"operationId": "Stop or finish watching in a media center",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"app_date": "2014-09-22",
"app_version": "1.0",
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"progress": 99.9
},
"properties": {
"app_date": {
"type": "string"
},
"app_version": {
"type": "string"
},
"movie": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"progress": {
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"action": "pause",
"id": 0,
"movie": {
"ids": {
"imdb": "tt2015381",
"slug": "guardians-of-the-galaxy-2014",
"tmdb": 118340,
"trakt": 28
},
"title": "Guardians of the Galaxy",
"year": 2014
},
"progress": 75,
"sharing": {
"tumblr": false,
"twitter": false
}
}
}
}
}
},
"description": "Created",
"headers": {}
},
"409": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"expires_at": "2014-10-15T23:21:29.000Z",
"watched_at": "2014-10-15T22:21:29.000Z"
}
}
}
}
},
"description": "The same item was recently scrobbled.",
"headers": {}
}
},
"security": [
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
},
{
"oauth2": []
}
],
"summary": "Stop or finish watching in a media center",
"tags": [
"Scrobble"
]
}
},
"/search/{id_type}/{id}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nLookup items by their Trakt, IMDB, TMDB, or TVDB ID. If you use the search url without a `type` it might return multiple items if the `id_type` is not globally unique. Specify the `type` of results by sending a single value or a comma delimited string for multiple types.\n\n| Type | URL |\n|---|---|\n| `trakt` | `/search/trakt/:id` |\n| | `/search/trakt/:id?type=movie` |\n| | `/search/trakt/:id?type=show` |\n| | `/search/trakt/:id?type=episode` |\n| | `/search/trakt/:id?type=person` |\n| `imdb` | `/search/imdb/:id` |\n| `tmdb` | `/search/tmdb/:id` |\n| | `/search/tmdb/:id?type=movie` |\n| | `/search/tmdb/:id?type=show` |\n| | `/search/tmdb/:id?type=episode` |\n| | `/search/tmdb/:id?type=person` |\n| `tvdb` | `/search/tvdb/:id` |\n| | `/search/tvdb/:id?type=show` |\n| | `/search/tvdb/:id?type=episode` |",
"operationId": "Get ID lookup results",
"parameters": [
{
"description": "Type of ID to lookup.",
"example": "imdb",
"in": "path",
"name": "id_type",
"required": true,
"schema": {
"enum": [
"trakt",
"imdb",
"tmdb",
"tvdb"
],
"type": "string"
}
},
{
"description": "ID that matches with the type.",
"example": "tt0848228",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Search type.",
"example": "movie",
"in": "query",
"name": "type",
"required": false,
"schema": {
"enum": [
"movie",
"show",
"episode",
"person",
"list"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt1104001",
"slug": "tron-legacy-2010",
"tmdb": 20526,
"trakt": 12601
},
"title": "TRON: Legacy",
"year": 2010
},
"score": null,
"type": "movie"
}
]
}
}
}
},
"description": "```\n/search/trakt/12601?type=movie\n/search/imdb/tt1104001\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get ID lookup results",
"tags": [
"Search"
]
}
},
"/search/{type}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nSearch all text fields that a media object contains (i.e. title, overview, etc). Results are ordered by the most relevant score. Specify the `type` of results by sending a single value or a comma delimited string for multiple types.\n\n#### Special Characters\n\nOur search engine (Solr) gives the following characters special meaning when they appear in a query:\n\n`+ - && || ! ( ) { } [ ] ^ \" ~ * ? : /`\n\nTo interpret any of these characters literally (and not as a special character), precede the character with a backslash `\\` character.\n\n#### Search Fields\n\nBy default, all text fields are used to search for the `query`. You can optionally specify the `fields` parameter with a single value or comma delimited string for multiple fields. Each `type` has specific `fields` that can be specified. This can be useful if you want to support more strict searches (i.e. title only).\n\n| Type | Field |\n|---|---|\n| `movie` | `title` |\n| | `tagline` |\n| | `overview` |\n| | `people` |\n| | `translations` |\n| | `aliases` |\n| `show` | `title` |\n| | `overview` |\n| | `people` |\n| | `translations` |\n| | `aliases` |\n| `episode` | `title` |\n| | `overview` |\n| `person` | `name` |\n| | `biography` |\n| `list` | `name` |\n| | `description` |",
"operationId": "Get text query results",
"parameters": [
{
"description": "Search type.",
"example": "movie",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movie",
"show",
"episode",
"person",
"list"
],
"type": "string"
}
},
{
"description": "Search all text based fields.",
"example": "tron",
"in": "query",
"name": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"enum": [
"title",
"tagline",
"overview",
"people",
"translations",
"aliases",
"name",
"biography",
"description"
],
"type": "string"
}
}
},
"description": "Specific text fields."
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"movie": {
"ids": {
"imdb": "tt1104001",
"slug": "tron-legacy-2010",
"tmdb": 20526,
"trakt": 12601
},
"title": "TRON: Legacy",
"year": 2010
},
"score": 26.019499,
"type": "movie"
},
{
"score": 19.533358,
"show": {
"ids": {
"imdb": "tt1812523",
"slug": "tron-uprising",
"tmdb": 34356,
"trakt": 34209,
"tvdb": 258480
},
"title": "Tron: Uprising",
"year": 2012
},
"type": "show"
},
{
"episode": {
"ids": {
"imdb": null,
"tmdb": 786460,
"trakt": 793693,
"tvdb": 4318713
},
"number": 1,
"season": 1,
"title": "The Renegade (1)"
},
"score": 42.50835,
"show": {
"ids": {
"imdb": "tt1812523",
"slug": "tron-uprising",
"tmdb": 34356,
"trakt": 34209,
"tvdb": 258480
},
"title": "Tron: Uprising",
"year": 2012
},
"type": "episode"
},
{
"person": {
"ids": {
"imdb": "nm0000313",
"slug": "jeff-bridges",
"tmdb": 1229,
"trakt": 4173
},
"name": "Jeff Bridges"
},
"score": 53.421608,
"type": "person"
},
{
"list": {
"allow_comments": true,
"comment_count": 0,
"created_at": "2016-04-22T05:54:55.000Z",
"description": "Let food be thy medicine and medicine be thy food.",
"display_numbers": true,
"ids": {
"slug": "open-your-eyes",
"trakt": 2180135
},
"item_count": 22,
"likes": 6,
"name": "Open Your Eyes",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2016-06-29T09:47:40.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": true
}
},
"score": 38.643196,
"type": "list"
}
]
}
}
}
},
"description": "```\n/search/movie,show,episode,person,list?query=tron\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get text query results",
"tags": [
"Search"
]
}
},
"/shows/anticipated": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most anticipated shows based on the number of lists a show appears on.",
"operationId": "Get the most anticipated shows",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"list_count": 5383,
"show": {
"ids": {
"imdb": "tt4016454",
"slug": "supergirl",
"tmdb": 62688,
"trakt": 99046,
"tvdb": 295759
},
"title": "Supergirl",
"year": 2015
}
},
{
"list_count": 3132,
"show": {
"ids": {
"imdb": "tt2357547",
"slug": "marvel-s-jessica-jones",
"tmdb": 38472,
"trakt": 79385,
"tvdb": 284190
},
"title": "Marvel's Jessica Jones",
"year": 2015
}
},
{
"list_count": 3095,
"show": {
"ids": {
"imdb": "tt4052886",
"slug": "lucifer",
"tmdb": 63174,
"trakt": 98990,
"tvdb": 295685
},
"title": "Lucifer",
"year": 2016
}
},
{
"list_count": 1704,
"show": {
"ids": {
"imdb": "tt4189022",
"slug": "ash-vs-evil-dead",
"tmdb": 62264,
"trakt": 99460,
"tvdb": 296295
},
"title": "Ash vs Evil Dead",
"year": 2015
}
},
{
"list_count": 1655,
"show": {
"ids": {
"imdb": "tt3230854",
"slug": "the-expanse",
"tmdb": null,
"trakt": 77199,
"tvdb": 280619
},
"title": "The Expanse",
"year": 2015
}
},
{
"list_count": 1481,
"show": {
"ids": {
"imdb": "tt3865236",
"slug": "into-the-badlands",
"tmdb": 47450,
"trakt": 82217,
"tvdb": 289079
},
"title": "Into the Badlands",
"year": 2015
}
},
{
"list_count": 1332,
"show": {
"ids": {
"imdb": "tt4209256",
"slug": "colony",
"tmdb": 62858,
"trakt": 95966,
"tvdb": 284210
},
"title": "Colony",
"year": 2016
}
},
{
"list_count": 1060,
"show": {
"ids": {
"imdb": "tt4428124",
"slug": "wicked-city",
"tmdb": 62927,
"trakt": 98888,
"tvdb": 295518
},
"title": "Wicked City",
"year": 2015
}
},
{
"list_count": 982,
"show": {
"ids": {
"imdb": "tt3322314",
"slug": "marvel-s-luke-cage",
"tmdb": 62126,
"trakt": 79382,
"tvdb": 284192
},
"title": "Marvel's Luke Cage",
"year": 2016
}
},
{
"list_count": 838,
"show": {
"ids": {
"imdb": "tt3216608",
"slug": "dr-ken-1969",
"tmdb": 62776,
"trakt": 98913,
"tvdb": 295557
},
"title": "Dr. Ken",
"year": 2015
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most anticipated shows",
"tags": [
"Shows"
]
}
},
"/shows/collected/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most collected (unique users) shows in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most collected shows",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 7427018,
"collector_count": 23876,
"play_count": 19286818,
"show": {
"ids": {
"imdb": "tt0096697",
"slug": "the-simpsons",
"tmdb": 456,
"trakt": 455,
"tvdb": 71663
},
"title": "The Simpsons",
"year": 1989
},
"watcher_count": 56216
},
{
"collected_count": 6635583,
"collector_count": 54953,
"play_count": 23542030,
"show": {
"ids": {
"imdb": "tt0898266",
"slug": "the-big-bang-theory",
"tmdb": 1418,
"trakt": 1409,
"tvdb": 80379
},
"title": "The Big Bang Theory",
"year": 2007
},
"watcher_count": 155291
},
{
"collected_count": 4529880,
"collector_count": 32335,
"play_count": 19787304,
"show": {
"ids": {
"imdb": "tt0460649",
"slug": "how-i-met-your-mother",
"tmdb": 1100,
"trakt": 1095,
"tvdb": 75760
},
"title": "How I Met Your Mother",
"year": 2005
},
"watcher_count": 100242
},
{
"collected_count": 3550246,
"collector_count": 4511,
"play_count": 17845449,
"show": {
"ids": {
"imdb": "tt0115147",
"slug": "the-daily-show-with-jon-stewart",
"tmdb": 2224,
"trakt": 2211,
"tvdb": 71256
},
"title": "The Daily Show with Jon Stewart",
"year": 1996
},
"watcher_count": 8050
},
{
"collected_count": 3347336,
"collector_count": 16230,
"play_count": 12379465,
"show": {
"ids": {
"imdb": "tt0108778",
"slug": "friends",
"tmdb": 1668,
"trakt": 1657,
"tvdb": 79168
},
"title": "Friends",
"year": 1994
},
"watcher_count": 53775
},
{
"collected_count": 3273255,
"collector_count": 23114,
"play_count": 7879681,
"show": {
"ids": {
"imdb": "tt0182576",
"slug": "family-guy",
"tmdb": 1434,
"trakt": 1425,
"tvdb": 75978
},
"title": "Family Guy",
"year": 1999
},
"watcher_count": 48984
},
{
"collected_count": 3119930,
"collector_count": 24399,
"play_count": 11294835,
"show": {
"ids": {
"imdb": "tt0460681",
"slug": "supernatural",
"tmdb": 1622,
"trakt": 1611,
"tvdb": 78901
},
"title": "Supernatural",
"year": 2005
},
"watcher_count": 68267
},
{
"collected_count": 2965842,
"collector_count": 19450,
"play_count": 7267474,
"show": {
"ids": {
"imdb": "tt0121955",
"slug": "south-park",
"tmdb": 2190,
"trakt": 2177,
"tvdb": 75897
},
"title": "South Park",
"year": 1997
},
"watcher_count": 41844
},
{
"collected_count": 2570535,
"collector_count": 28446,
"play_count": 7997522,
"show": {
"ids": {
"imdb": "tt1442437",
"slug": "modern-family",
"tmdb": 1421,
"trakt": 1412,
"tvdb": 95011
},
"title": "Modern Family",
"year": 2009
},
"watcher_count": 72285
},
{
"collected_count": 2546116,
"collector_count": 20113,
"play_count": 8986802,
"show": {
"ids": {
"imdb": "tt0412142",
"slug": "house",
"tmdb": 1408,
"trakt": 1399,
"tvdb": 73255
},
"title": "House",
"year": 2004
},
"watcher_count": 54604
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most collected shows",
"tags": [
"Shows"
]
}
},
"/shows/played/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most played (a single user can watch multiple episodes multiple times) shows in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most played shows",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 6635583,
"collector_count": 54953,
"play_count": 23542030,
"show": {
"ids": {
"imdb": "tt0898266",
"slug": "the-big-bang-theory",
"tmdb": 1418,
"trakt": 1409,
"tvdb": 80379
},
"title": "The Big Bang Theory",
"year": 2007
},
"watcher_count": 155291
},
{
"collected_count": 4529880,
"collector_count": 32335,
"play_count": 19787304,
"show": {
"ids": {
"imdb": "tt0460649",
"slug": "how-i-met-your-mother",
"tmdb": 1100,
"trakt": 1095,
"tvdb": 75760
},
"title": "How I Met Your Mother",
"year": 2005
},
"watcher_count": 100242
},
{
"collected_count": 7427018,
"collector_count": 23876,
"play_count": 19286818,
"show": {
"ids": {
"imdb": "tt0096697",
"slug": "the-simpsons",
"tmdb": 456,
"trakt": 455,
"tvdb": 71663
},
"title": "The Simpsons",
"year": 1989
},
"watcher_count": 56216
},
{
"collected_count": 3550246,
"collector_count": 4511,
"play_count": 17845449,
"show": {
"ids": {
"imdb": "tt0115147",
"slug": "the-daily-show-with-jon-stewart",
"tmdb": 2224,
"trakt": 2211,
"tvdb": 71256
},
"title": "The Daily Show with Jon Stewart",
"year": 1996
},
"watcher_count": 8050
},
{
"collected_count": 3347336,
"collector_count": 16230,
"play_count": 12379465,
"show": {
"ids": {
"imdb": "tt0108778",
"slug": "friends",
"tmdb": 1668,
"trakt": 1657,
"tvdb": 79168
},
"title": "Friends",
"year": 1994
},
"watcher_count": 53775
},
{
"collected_count": 3119930,
"collector_count": 24399,
"play_count": 11294835,
"show": {
"ids": {
"imdb": "tt0460681",
"slug": "supernatural",
"tmdb": 1622,
"trakt": 1611,
"tvdb": 78901
},
"title": "Supernatural",
"year": 2005
},
"watcher_count": 68267
},
{
"collected_count": 2423833,
"collector_count": 57617,
"play_count": 9945882,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 1393,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"watcher_count": 163097
},
{
"collected_count": 2251539,
"collector_count": 17682,
"play_count": 9766448,
"show": {
"ids": {
"imdb": "tt0413573",
"slug": "grey-s-anatomy",
"tmdb": 1416,
"trakt": 1407,
"tvdb": 73762
},
"title": "Grey's Anatomy",
"year": 2005
},
"watcher_count": 46170
},
{
"collected_count": 2546116,
"collector_count": 20113,
"play_count": 8986802,
"show": {
"ids": {
"imdb": "tt0412142",
"slug": "house",
"tmdb": 1408,
"trakt": 1399,
"tvdb": 73255
},
"title": "House",
"year": 2004
},
"watcher_count": 54604
},
{
"collected_count": 2436824,
"collector_count": 73224,
"play_count": 8784154,
"show": {
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 1390,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
"watcher_count": 203742
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most played shows",
"tags": [
"Shows"
]
}
},
"/shows/popular": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most popular shows. Popularity is calculated using the rating percentage and the number of ratings.",
"operationId": "Get popular shows",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt1439629",
"slug": "community",
"tmdb": 18347,
"trakt": 41,
"tvdb": 94571
},
"title": "Community",
"year": 2009
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0773262",
"slug": "dexter",
"tmdb": 1405,
"trakt": 19,
"tvdb": 79349
},
"title": "Dexter",
"year": 2006
},
{
"ids": {
"imdb": "tt0096697",
"slug": "the-simpsons",
"tmdb": 456,
"trakt": 91,
"tvdb": 71663
},
"title": "The Simpsons",
"year": 1989
},
{
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 353,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
{
"ids": {
"imdb": "tt0411008",
"slug": "lost",
"tmdb": 4607,
"trakt": 511,
"tvdb": 73739
},
"title": "Lost",
"year": 2004
},
{
"ids": {
"imdb": "tt0285331",
"slug": "24",
"tmdb": 1973,
"trakt": 460,
"tvdb": 76290
},
"title": "24",
"year": 2001
},
{
"ids": {
"imdb": "tt0407362",
"slug": "battlestar-galactica",
"tmdb": 1972,
"trakt": 331,
"tvdb": 73545
},
"title": "Battlestar Galactica",
"year": 2005
},
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt0303461",
"slug": "firefly",
"tmdb": 1437,
"trakt": 329,
"tvdb": 78874
},
"title": "Firefly",
"year": 2002
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get popular shows",
"tags": [
"Shows"
]
}
},
"/shows/recommended/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most recommended shows in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most recommended shows",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"show": {
"ids": {
"imdb": "tt0898266",
"slug": "the-big-bang-theory",
"tmdb": 1418,
"trakt": 1409,
"tvdb": 80379
},
"title": "The Big Bang Theory",
"year": 2007
},
"user_count": 155291
},
{
"show": {
"ids": {
"imdb": "tt0413573",
"slug": "grey-s-anatomy",
"tmdb": 1416,
"trakt": 1407,
"tvdb": 73762
},
"title": "Grey's Anatomy",
"year": 2005
},
"user_count": 46170
},
{
"show": {
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 1390,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
"user_count": 203742
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most recommended shows",
"tags": [
"Shows"
]
}
},
"/shows/trending": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns all shows being watched right now. Shows with the most users are returned first.",
"operationId": "Get trending shows",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"watchers": 541
},
{
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"watchers": 432
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Trending-User-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get trending shows",
"tags": [
"Shows"
]
}
},
"/shows/updates/id/{start_date}": {
"get": {
"description": "#### 📄 Pagination\n\nReturns all show Trakt IDs updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated show Trakt IDs",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
1,
20,
34,
50
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated show Trakt IDs",
"tags": [
"Shows"
]
}
},
"/shows/updates/{start_date}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nReturns all shows updated since the specified UTC date and time. We recommended storing the `X-Start-Date` header you can be efficient using this method moving forward. By default, `10` results are returned. You can send a `limit` to get up to `100` results per page.\n\n**Important!** The `start_date` is only accurate to the hour, for caching purposes. Please drop the minutes and seconds from your timestamp to help optimize our cached data. For example, use `2021-07-17T12:00:00Z` and not `2021-07-17T12:23:34Z`.\n\n**Note:** The `start_date` can only be a maximum of 30 days in the past.",
"operationId": "Get recently updated shows",
"parameters": [
{
"description": "Updated since this date and time.",
"example": "2020-11-27T00:00:00Z",
"in": "path",
"name": "start_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"updated_at": "2014-09-22T21:56:03.000Z"
},
{
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"updated_at": "2014-09-23T21:56:03.000Z"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
},
"X-Start-Date": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get recently updated shows",
"tags": [
"Shows"
]
}
},
"/shows/watched/{period}": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info 🎚 Filters\n\nReturns the most watched (unique users) shows in the specified time `period`, defaulting to `weekly`. All stats are relative to the specific time `period`.",
"operationId": "Get the most watched shows",
"parameters": [
{
"description": "Time period.",
"example": "weekly",
"in": "path",
"name": "period",
"required": true,
"schema": {
"enum": [
"daily",
"weekly",
"monthly",
"yearly",
"all"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"collected_count": 2436824,
"collector_count": 73224,
"play_count": 8784154,
"show": {
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 1390,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
"watcher_count": 203742
},
{
"collected_count": 2423833,
"collector_count": 57617,
"play_count": 9945882,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 1393,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"watcher_count": 163097
},
{
"collected_count": 6635583,
"collector_count": 54953,
"play_count": 23542030,
"show": {
"ids": {
"imdb": "tt0898266",
"slug": "the-big-bang-theory",
"tmdb": 1418,
"trakt": 1409,
"tvdb": 80379
},
"title": "The Big Bang Theory",
"year": 2007
},
"watcher_count": 155291
},
{
"collected_count": 2471061,
"collector_count": 49385,
"play_count": 8576210,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1388,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"watcher_count": 140725
},
{
"collected_count": 1856666,
"collector_count": 43351,
"play_count": 6173692,
"show": {
"ids": {
"imdb": "tt2193021",
"slug": "arrow",
"tmdb": 1412,
"trakt": 1403,
"tvdb": 257655
},
"title": "Arrow",
"year": 2012
},
"watcher_count": 123797
},
{
"collected_count": 4529880,
"collector_count": 32335,
"play_count": 19787304,
"show": {
"ids": {
"imdb": "tt0460649",
"slug": "how-i-met-your-mother",
"tmdb": 1100,
"trakt": 1095,
"tvdb": 75760
},
"title": "How I Met Your Mother",
"year": 2005
},
"watcher_count": 100242
},
{
"collected_count": 260713,
"collector_count": 34077,
"play_count": 912066,
"show": {
"ids": {
"imdb": "tt1475582",
"slug": "sherlock",
"tmdb": 19885,
"trakt": 19792,
"tvdb": 176941
},
"title": "Sherlock",
"year": 2010
},
"watcher_count": 94282
},
{
"collected_count": 1299956,
"collector_count": 39724,
"play_count": 3375660,
"show": {
"ids": {
"imdb": "tt1796960",
"slug": "homeland",
"tmdb": 1407,
"trakt": 1398,
"tvdb": 247897
},
"title": "Homeland",
"year": 2011
},
"watcher_count": 89242
},
{
"collected_count": 2239477,
"collector_count": 33424,
"play_count": 7799337,
"show": {
"ids": {
"imdb": "tt0773262",
"slug": "dexter",
"tmdb": 1405,
"trakt": 1396,
"tvdb": 79349
},
"title": "Dexter",
"year": 2006
},
"watcher_count": 87059
},
{
"collected_count": 881552,
"collector_count": 31982,
"play_count": 2795758,
"show": {
"ids": {
"imdb": "tt2364582",
"slug": "marvel-s-agents-of-s-h-i-e-l-d",
"tmdb": 1403,
"trakt": 1394,
"tvdb": 263365
},
"title": "Marvel's Agents of S.H.I.E.L.D.",
"year": 2013
},
"watcher_count": 83087
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get the most watched shows",
"tags": [
"Shows"
]
}
},
"/shows/{id}": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns a single shows's details. If you request extended info, the `airs` object is relative to the show's country. You can use the `day`, `time`, and `timezone` to construct your own date then convert it to whatever timezone your user is in.\n\n**Note:** When getting `full` extended info, the `status` field can have a value of `returning series` (airing right now), `continuing` (airing right now), `in production` (airing soon), `planned` (in development), `upcoming` (in development), `pilot`, `canceled`, or `ended`.",
"operationId": "Get a single show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"aired_episodes": 50,
"airs": {
"day": "Sunday",
"time": "21:00",
"timezone": "America/New_York"
},
"available_translations": [
"en",
"tr",
"sk",
"de",
"ru",
"fr",
"hu",
"zh",
"el",
"pt",
"es",
"bg",
"ro",
"it",
"ko",
"he",
"nl",
"pl"
],
"certification": "TV-MA",
"comment_count": 92,
"country": "us",
"first_aired": "2011-04-18T01:00:00.000Z",
"genres": [
"drama",
"fantasy"
],
"homepage": "http://www.hbo.com/game-of-thrones/index.html",
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 353,
"tvdb": 121361
},
"language": "en",
"network": "HBO",
"overview": "Game of Thrones is an American fantasy drama television series created for HBO by David Benioff and D. B. Weiss. It is an adaptation of A Song of Ice and Fire, George R. R. Martin's series of fantasy novels, the first of which is titled A Game of Thrones.\n\nThe series, set on the fictional continents of Westeros and Essos at the end of a decade-long summer, interweaves several plot lines. The first follows the members of several noble houses in a civil war for the Iron Throne of the Seven Kingdoms; the second covers the rising threat of the impending winter and the mythical creatures of the North; the third chronicles the attempts of the exiled last scion of the realm's deposed dynasty to reclaim the throne. Through its morally ambiguous characters, the series explores the issues of social hierarchy, religion, loyalty, corruption, sexuality, civil war, crime, and punishment.",
"rating": 9,
"runtime": 60,
"status": "returning series",
"title": "Game of Thrones",
"trailer": null,
"updated_at": "2014-08-22T08:32:06.000Z",
"votes": 111,
"year": 2011
}
}
}
}
},
"description": "```\n/shows/game-of-thrones?extended=full\n```",
"headers": {}
}
},
"summary": "Get a single show",
"tags": [
"Shows"
]
}
},
"/shows/{id}/aliases": {
"get": {
"description": "Returns all title aliases for a show. Includes country where name is different.",
"operationId": "Get all show aliases",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "tw",
"title": "冰與火之歌：權力遊戲"
},
{
"country": "br",
"title": "A Guerra dos Tronos"
},
{
"country": "de",
"title": "Game of Thrones- Das Lied von Eis und Feuer"
},
{
"country": "gr",
"title": "Παιχνίδι Του Στέμματος"
},
{
"country": "de",
"title": "Game of Thrones - Das Lied von Eis und Feuer"
},
{
"country": "fr",
"title": "Le Trône de fer"
},
{
"country": "ro",
"title": "Urzeala Tronurilor"
},
{
"country": "sa",
"title": "صراع العروش"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all show aliases",
"tags": [
"Shows"
]
}
},
"/shows/{id}/certifications": {
"get": {
"description": "Returns all content certifications for a show, including the country.",
"operationId": "Get all show certifications",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"certification": "TV-MA",
"country": "us"
},
{
"certification": "12",
"country": "de"
},
{
"certification": "15",
"country": "kr"
},
{
"certification": "15",
"country": "gb"
},
{
"certification": "16",
"country": "br"
},
{
"certification": "12",
"country": "nl"
},
{
"certification": "18",
"country": "pt"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all show certifications",
"tags": [
"Shows"
]
}
},
"/shows/{id}/comments/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all top level comments for a show. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, most `replies`, `highest` rated, `lowest` rated, most `plays`, and highest `watched` percentage.",
"operationId": "Get all show comments",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies",
"highest",
"lowest",
"plays",
"watched"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Great show!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all show comments",
"tags": [
"Shows"
]
}
},
"/shows/{id}/last_episode": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns the most recently aired episode. If no episode is found, a `204` HTTP status code will be returned.",
"operationId": "Get last episode",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"ids": {
"imdb": "tt4283094",
"tmdb": 1187405,
"trakt": 1989031,
"tvdb": 5624261
},
"number": 10,
"season": 6,
"title": "The Winds of Winter"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get last episode",
"tags": [
"Shows"
]
}
},
"/shows/{id}/lists/{type}/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists that contain this show. By default, `personal` lists are returned sorted by the most `popular`.",
"operationId": "Get lists containing this show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific list type",
"example": "personal",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"personal",
"official",
"watchlists",
"recommendations"
],
"type": "string"
}
},
{
"description": "How to sort",
"example": "popular",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"popular",
"likes",
"comments",
"items",
"added",
"updated"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get lists containing this show",
"tags": [
"Shows"
]
}
},
"/shows/{id}/next_episode": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns the next scheduled to air episode. If no episode is found, a `204` HTTP status code will be returned.",
"operationId": "Get next episode",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 2279059,
"tvdb": 5773656
},
"number": 1,
"season": 7,
"title": "TBA"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get next episode",
"tags": [
"Shows"
]
}
},
"/shows/{id}/people": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all `cast` and `crew` for a show, including the `episode_count` for which they appears. Each `cast` member will have a `characters` array and a standard `person` object.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, `editing`, and `created by` (if there are people for those crew positions). Each of those members will have a `jobs` array and a standard `person` object.\n\n#### Guest Stars\n\nIf you add `?extended=guest_stars` to the URL, it will return all guest stars that appeared in at least 1 episode of the show.\n\n**Note:** This returns a lot of data, so please only use this extended parameter if you actually need it!",
"operationId": "Get all people for a show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Daenerys Targaryen"
],
"episode_count": 73,
"person": {
"ids": {
"imdb": "nm3592338",
"slug": "emilia-clarke",
"tmdb": 1223786,
"trakt": 2332,
"tvrage": null
},
"name": "Emilia Clarke"
}
},
{
"characters": [
"Varys"
],
"episode_count": 73,
"person": {
"ids": {
"imdb": "nm0384152",
"slug": "conleth-hill",
"tmdb": 84423,
"trakt": 4428,
"tvrage": null
},
"name": "Conleth Hill"
}
},
{
"characters": [
"Tyrion Lannister"
],
"episode_count": 73,
"person": {
"ids": {
"imdb": "nm0227759",
"slug": "peter-dinklage",
"tmdb": 22970,
"trakt": 2329,
"tvrage": 34516
},
"name": "Peter Dinklage"
}
}
],
"crew": {
"art": [
{
"episode_count": 30,
"jobs": [
"Production Design"
],
"person": {
"ids": {
"imdb": "nm0413541",
"slug": "gemma-jackson",
"tmdb": 9153,
"trakt": 17454,
"tvrage": null
},
"name": "Gemma Jackson"
}
},
{
"episode_count": 20,
"jobs": [
"Art Direction"
],
"person": {
"ids": {
"imdb": "nm0255797",
"slug": "philip-elton",
"tmdb": 80424,
"trakt": 13414,
"tvrage": null
},
"name": "Philip Elton"
}
}
],
"costume & make-up": [
{
"episode_count": 63,
"jobs": [
"Costume Design"
],
"person": {
"ids": {
"imdb": "nm0163449",
"slug": "michele-clapton",
"tmdb": 50953,
"trakt": 5019,
"tvrage": null
},
"name": "Michele Clapton"
}
}
],
"directing": [
{
"episode_count": 9,
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm0638354",
"slug": "david-nutter",
"tmdb": 33316,
"trakt": 346,
"tvrage": 373
},
"name": "David Nutter"
}
},
{
"episode_count": 7,
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm0851930",
"slug": "alan-taylor",
"tmdb": 47005,
"trakt": 17457,
"tvrage": null
},
"name": "Alan Taylor"
}
}
],
"production": [
{
"episode_count": 73,
"jobs": [
"Co-Executive Producer"
],
"person": {
"ids": {
"imdb": "nm0552333",
"slug": "george-r-r-martin",
"tmdb": 237053,
"trakt": 5020,
"tvrage": 79951
},
"name": "George R. R. Martin"
}
},
{
"episode_count": 73,
"jobs": [
"Executive Producer"
],
"person": {
"ids": {
"imdb": "nm1888967",
"slug": "d-b-weiss",
"tmdb": 228068,
"trakt": 17443,
"tvrage": null
},
"name": "D. B. Weiss"
}
}
],
"sound": [
{
"episode_count": 73,
"jobs": [
"Original Music Composer"
],
"person": {
"ids": {
"imdb": "nm1014697",
"slug": "ramin-djawadi",
"tmdb": 10851,
"trakt": 3698,
"tvrage": null
},
"name": "Ramin Djawadi"
}
},
{
"episode_count": 40,
"jobs": [
"Sound Designer"
],
"person": {
"ids": {
"imdb": "nm0265584",
"slug": "paula-fairfield",
"tmdb": 85960,
"trakt": 17461,
"tvrage": null
},
"name": "Paula Fairfield"
}
}
],
"visual effects": [
{
"episode_count": 10,
"jobs": [
"Visual Effects"
],
"person": {
"ids": {
"imdb": "nm2108603",
"slug": "jeremy-stewart",
"tmdb": 1463785,
"trakt": 5018,
"tvrage": null
},
"name": "Jeremy Stewart"
}
}
],
"writing": [
{
"episode_count": 73,
"jobs": [
"Novel"
],
"person": {
"ids": {
"imdb": "nm0552333",
"slug": "george-r-r-martin",
"tmdb": 237053,
"trakt": 5020,
"tvrage": 79951
},
"name": "George R. R. Martin"
}
}
]
},
"guest_stars": [
{
"characters": [
"Podrick Payne"
],
"episode_count": 33,
"person": {
"ids": {
"imdb": "nm4535552",
"slug": "daniel-portman",
"tmdb": 1034702,
"trakt": 13094,
"tvrage": null
},
"name": "Daniel Portman"
}
},
{
"characters": [
"Eddison Tollett"
],
"episode_count": 32,
"person": {
"ids": {
"imdb": "nm0174005",
"slug": "ben-crompton",
"tmdb": 72315,
"trakt": 1782,
"tvrage": null
},
"name": "Ben Crompton"
}
},
{
"characters": [
"Grand Maester Pycelle"
],
"episode_count": 31,
"person": {
"ids": {
"imdb": "nm0002103",
"slug": "julian-glover",
"tmdb": 740,
"trakt": 2654,
"tvrage": 41261
},
"name": "Julian Glover"
}
}
]
}
}
}
}
},
"description": "```\n/shows/game-of-thrones/people?extended=guest_stars\n```",
"headers": {}
}
},
"summary": "Get all people for a show",
"tags": [
"Shows"
]
}
},
"/shows/{id}/progress/collection": {
"get": {
"description": "#### 🔒 OAuth Required\n\nReturns collection progress for a show including details on all aired seasons and episodes. The `next_episode` will be the next episode the user should collect, if there are no upcoming episodes it will be set to `null`.\n\nBy default, any hidden seasons will be removed from the response and stats. To include these and adjust the completion stats, set the `hidden` flag to `true`.\n\nBy default, specials will be excluded from the response. Set the `specials` flag to `true` to include season 0 and adjust the stats accordingly. If you'd like to include specials, but not adjust the stats, set `count_specials` to `false`.\n\nBy default, the `last_episode` and `next_episode` are calculated using the last `aired` episode the user has collected, even if they've collected older episodes more recently. To use their last collected episode for these calculations, set the `last_activity` flag to `collected`.\n\n**Note:** Only aired episodes are used to calculate progress. Episodes in the future or without an air date are ignored.",
"operationId": "Get show collection progress",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "include any hidden seasons",
"example": "false",
"in": "query",
"name": "hidden",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "include specials as season 0",
"example": "false",
"in": "query",
"name": "specials",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "count specials in the overall stats (only applies if specials are included)",
"example": "true",
"in": "query",
"name": "count_specials",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"enum": [
"aired",
"collected"
],
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"aired": 8,
"completed": 6,
"hidden_seasons": [
{
"ids": {
"tmdb": 53334,
"trakt": 3051,
"tvdb": 498968
},
"number": 2
}
],
"last_collected_at": "2015-03-21T19:03:58.000Z",
"last_episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 62314,
"tvdb": 4849872
},
"number": 6,
"season": 1,
"title": "Fire"
},
"next_episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 62315,
"tvdb": 4849873
},
"number": 7,
"season": 1,
"title": "Water"
},
"seasons": [
{
"aired": 8,
"completed": 6,
"episodes": [
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 1
},
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 2
},
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 3
},
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 4
},
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 5
},
{
"collected_at": "2015-03-21T19:03:58.000Z",
"completed": true,
"number": 6
},
{
"collected_at": null,
"completed": false,
"number": 7
},
{
"collected_at": null,
"completed": false,
"number": 8
}
],
"number": 1,
"title": "The first Hodor."
}
]
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get show collection progress",
"tags": [
"Shows"
]
}
},
"/shows/{id}/progress/watched": {
"get": {
"description": "#### 🔒 OAuth Required\n\nReturns watched progress for a show including details on all aired seasons and episodes. The `next_episode` will be the next episode the user should watch, if there are no upcoming episodes it will be set to `null`. If not `null`, the `reset_at` date is when the user started re-watching the show. Your app can adjust the progress by ignoring episodes with a `last_watched_at` prior to the `reset_at`.\n\nBy default, any hidden seasons will be removed from the response and stats. To include these and adjust the completion stats, set the `hidden` flag to `true`.\n\nBy default, specials will be excluded from the response. Set the `specials` flag to `true` to include season 0 and adjust the stats accordingly. If you'd like to include specials, but not adjust the stats, set `count_specials` to `false`.\n\nBy default, the `last_episode` and `next_episode` are calculated using the last `aired` episode the user has watched, even if they've watched older episodes more recently. To use their last watched episode for these calculations, set the `last_activity` flag to `watched`.\n\n**Note:** Only aired episodes are used to calculate progress. Episodes in the future or without an air date are ignored.",
"operationId": "Get show watched progress",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "include any hidden seasons",
"example": "false",
"in": "query",
"name": "hidden",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "include specials as season 0",
"example": "false",
"in": "query",
"name": "specials",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "count specials in the overall stats (only applies if specials are included)",
"example": "true",
"in": "query",
"name": "count_specials",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"enum": [
"aired",
"watched"
],
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"aired": 8,
"completed": 6,
"hidden_seasons": [
{
"ids": {
"tmdb": 53334,
"trakt": 3051,
"tvdb": 498968
},
"number": 2
}
],
"last_episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 62314,
"tvdb": 4849872
},
"number": 6,
"season": 1,
"title": "Fire"
},
"last_watched_at": "2015-03-21T19:03:58.000Z",
"next_episode": {
"ids": {
"imdb": null,
"tmdb": null,
"trakt": 62315,
"tvdb": 4849873
},
"number": 7,
"season": 1,
"title": "Water"
},
"reset_at": null,
"seasons": [
{
"aired": 8,
"completed": 6,
"episodes": [
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 1
},
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 2
},
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 3
},
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 4
},
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 5
},
{
"completed": true,
"last_watched_at": "2015-03-21T19:03:58.000Z",
"number": 6
},
{
"completed": false,
"last_watched_at": null,
"number": 7
},
{
"completed": false,
"last_watched_at": null,
"number": 8
}
],
"number": 1,
"title": "The first Hodor."
}
]
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get show watched progress",
"tags": [
"Shows"
]
}
},
"/shows/{id}/progress/watched/reset": {
"delete": {
"description": "#### 🔒 OAuth Required 🔥 VIP Only\n\nUndo the reset and have watched progress use all watched history for the show.",
"operationId": "Undo reset show progress",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Undo reset show progress",
"tags": [
"Shows"
]
},
"post": {
"description": "#### 🔒 OAuth Required 🔥 VIP Only\n\nReset a show's progress when the user started re-watching the show. You can optionally specify the `reset_at` date to have it calculate progress from that specific date onwards.",
"operationId": "Reset show progress",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reset_at": "2021-07-01T00:00:000Z"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Reset show progress",
"tags": [
"Shows"
]
}
},
"/shows/{id}/ratings": {
"get": {
"description": "Returns rating (between 0 and 10) and distribution for a show.",
"operationId": "Get show ratings",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"distribution": {
"1": 320,
"2": 77,
"3": 73,
"4": 131,
"5": 300,
"6": 514,
"7": 1560,
"8": 4399,
"9": 9648,
"10": 34042
},
"rating": 9.38363,
"votes": 51065
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get show ratings",
"tags": [
"Shows"
]
}
},
"/shows/{id}/related": {
"get": {
"description": "#### 📄 Pagination ✨ Extended Info\n\nReturns related and similar shows.",
"operationId": "Get related shows",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt0407362",
"slug": "battlestar-galactica",
"tmdb": 1972,
"trakt": 331,
"tvdb": 73545
},
"title": "Battlestar Galactica",
"year": 2005
},
{
"ids": {
"imdb": "tt0944947",
"slug": "game-of-thrones",
"tmdb": 1399,
"trakt": 353,
"tvdb": 121361
},
"title": "Game of Thrones",
"year": 2011
},
{
"ids": {
"imdb": "tt0303461",
"slug": "firefly",
"tmdb": 1437,
"trakt": 329,
"tvdb": 78874
},
"title": "Firefly",
"year": 2002
},
{
"ids": {
"imdb": "tt1870479",
"slug": "the-newsroom",
"tmdb": 15621,
"trakt": 497,
"tvdb": 256227
},
"title": "The Newsroom",
"year": 2012
},
{
"ids": {
"imdb": "tt1135300",
"slug": "dollhouse",
"tmdb": 14956,
"trakt": 395,
"tvdb": 82046
},
"title": "Dollhouse",
"year": 2009
},
{
"ids": {
"imdb": "tt1124373",
"slug": "sons-of-anarchy",
"tmdb": 1409,
"trakt": 23,
"tvdb": 82696
},
"title": "Sons of Anarchy",
"year": 2008
},
{
"ids": {
"imdb": "tt2243973",
"slug": "hannibal",
"tmdb": 40008,
"trakt": 567,
"tvdb": 259063
},
"title": "Hannibal",
"year": 2013
},
{
"ids": {
"imdb": "tt0844441",
"slug": "true-blood",
"tmdb": 10545,
"trakt": 122,
"tvdb": 82283
},
"title": "True Blood",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0286486",
"slug": "the-shield",
"tmdb": 1414,
"trakt": 486,
"tvdb": 78261
},
"title": "The Shield",
"year": 2002
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get related shows",
"tags": [
"Shows"
]
}
},
"/shows/{id}/seasons": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all seasons for a show including the number of episodes in each season.\n\n#### Episodes\n\nIf you add `?extended=episodes` to the URL, it will return all episodes for all seasons.\n\n**Note:** This returns a lot of data, so please only use this extended parameter if you actually need it!",
"operationId": "Get all seasons for a show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episodes": [
{
"ids": {
"imdb": "",
"tmdb": 63087,
"trakt": 36430,
"tvdb": 3226241
},
"number": 1,
"season": 0,
"title": "Inside Game of Thrones"
},
{
"ids": {
"imdb": "",
"tmdb": 63086,
"trakt": 36431,
"tvdb": 4045941
},
"number": 2,
"season": 0,
"title": "15-Minute Preview"
},
{
"ids": {
"imdb": "",
"tmdb": 63088,
"trakt": 36432,
"tvdb": 4073401
},
"number": 3,
"season": 0,
"title": "Making Game of Thrones"
},
{
"ids": {
"imdb": "",
"tmdb": 63089,
"trakt": 36433,
"tvdb": 4082317
},
"number": 4,
"season": 0,
"title": "El Juego Comienza"
},
{
"ids": {
"imdb": "",
"tmdb": 63090,
"trakt": 36434,
"tvdb": 4138149
},
"number": 5,
"season": 0,
"title": "2011 Comic Con Panel"
},
{
"ids": {
"imdb": "",
"tmdb": 63091,
"trakt": 36435,
"tvdb": 4292422
},
"number": 6,
"season": 0,
"title": "You Win or You Die"
},
{
"ids": {
"imdb": "",
"tmdb": 63092,
"trakt": 36436,
"tvdb": 4517457
},
"number": 7,
"season": 0,
"title": "A Gathering Storm"
},
{
"ids": {
"imdb": "",
"tmdb": 63093,
"trakt": 36437,
"tvdb": 4576208
},
"number": 8,
"season": 0,
"title": "Politics of Marriage"
},
{
"ids": {
"imdb": "",
"tmdb": 974558,
"trakt": 36438,
"tvdb": 4779102
},
"number": 9,
"season": 0,
"title": "Ice and Fire: A Foreshadowing"
},
{
"ids": {
"imdb": "",
"tmdb": 974559,
"trakt": 36439,
"tvdb": 4824480
},
"number": 10,
"season": 0,
"title": "The Politics of Power: A Look Back at Season 3"
}
],
"ids": {
"tmdb": 3627,
"trakt": 2145,
"tvdb": 137481
},
"number": 0
},
{
"episodes": [
{
"ids": {
"imdb": "tt1480055",
"tmdb": 63056,
"trakt": 36440,
"tvdb": 3254641
},
"number": 1,
"season": 1,
"title": "Winter Is Coming"
},
{
"ids": {
"imdb": "tt1668746",
"tmdb": 63057,
"trakt": 36441,
"tvdb": 3436411
},
"number": 2,
"season": 1,
"title": "The Kingsroad"
},
{
"ids": {
"imdb": "tt1829962",
"tmdb": 63058,
"trakt": 36442,
"tvdb": 3436421
},
"number": 3,
"season": 1,
"title": "Lord Snow"
},
{
"ids": {
"imdb": "tt1829963",
"tmdb": 63059,
"trakt": 36443,
"tvdb": 3436431
},
"number": 4,
"season": 1,
"title": "Cripples, Bastards, and Broken Things"
},
{
"ids": {
"imdb": "tt1829964",
"tmdb": 63060,
"trakt": 36444,
"tvdb": 3436441
},
"number": 5,
"season": 1,
"title": "The Wolf and the Lion"
},
{
"ids": {
"imdb": "tt1837862",
"tmdb": 63061,
"trakt": 36445,
"tvdb": 3436451
},
"number": 6,
"season": 1,
"title": "A Golden Crown"
},
{
"ids": {
"imdb": "tt1837863",
"tmdb": 63062,
"trakt": 36446,
"tvdb": 3436461
},
"number": 7,
"season": 1,
"title": "You Win or You Die"
},
{
"ids": {
"imdb": "tt1837864",
"tmdb": 63063,
"trakt": 36447,
"tvdb": 3360391
},
"number": 8,
"season": 1,
"title": "The Pointy End"
},
{
"ids": {
"imdb": "tt1851398",
"tmdb": 63064,
"trakt": 36448,
"tvdb": 4063481
},
"number": 9,
"season": 1,
"title": "Baelor"
},
{
"ids": {
"imdb": "tt1851397",
"tmdb": 63065,
"trakt": 36449,
"tvdb": 4063491
},
"number": 10,
"season": 1,
"title": "Fire and Blood"
}
],
"ids": {
"tmdb": 3624,
"trakt": 2146,
"tvdb": 364731
},
"number": 1
},
{
"episodes": [
{
"ids": {
"imdb": "tt1971833",
"tmdb": 63066,
"trakt": 36450,
"tvdb": 4161693
},
"number": 1,
"season": 2,
"title": "The North Remembers"
},
{
"ids": {
"imdb": "tt2069318",
"tmdb": 974430,
"trakt": 36451,
"tvdb": 4245771
},
"number": 2,
"season": 2,
"title": "The Night Lands"
},
{
"ids": {
"imdb": "tt2070135",
"tmdb": 63068,
"trakt": 36452,
"tvdb": 4245772
},
"number": 3,
"season": 2,
"title": "What is Dead May Never Die"
},
{
"ids": {
"imdb": "tt2069319",
"tmdb": 63069,
"trakt": 36453,
"tvdb": 4245773
},
"number": 4,
"season": 2,
"title": "Garden of Bones"
},
{
"ids": {
"imdb": "tt2074658",
"tmdb": 63070,
"trakt": 36454,
"tvdb": 4245774
},
"number": 5,
"season": 2,
"title": "The Ghost of Harrenhal"
},
{
"ids": {
"imdb": "tt2085238",
"tmdb": 63071,
"trakt": 36455,
"tvdb": 4245775
},
"number": 6,
"season": 2,
"title": "The Old Gods and the New"
},
{
"ids": {
"imdb": "tt2085239",
"tmdb": 63073,
"trakt": 36456,
"tvdb": 4245776
},
"number": 7,
"season": 2,
"title": "A Man Without Honor"
},
{
"ids": {
"imdb": "tt2085240",
"tmdb": 63074,
"trakt": 36457,
"tvdb": 4245777
},
"number": 8,
"season": 2,
"title": "The Prince of Winterfell"
},
{
"ids": {
"imdb": "tt2084342",
"tmdb": 63072,
"trakt": 36458,
"tvdb": 4245778
},
"number": 9,
"season": 2,
"title": "Blackwater"
},
{
"ids": {
"imdb": "tt2112510",
"tmdb": 63075,
"trakt": 36459,
"tvdb": 4245779
},
"number": 10,
"season": 2,
"title": "Valar Morghulis"
}
],
"ids": {
"tmdb": 3625,
"trakt": 2147,
"tvdb": 473271
},
"number": 2
},
{
"episodes": [
{
"ids": {
"imdb": "tt2178782",
"tmdb": 63077,
"trakt": 36460,
"tvdb": 4293685
},
"number": 1,
"season": 3,
"title": "Valar Dohaeris"
},
{
"ids": {
"imdb": "tt2178772",
"tmdb": 63076,
"trakt": 36461,
"tvdb": 4517458
},
"number": 2,
"season": 3,
"title": "Dark Wings, Dark Words"
},
{
"ids": {
"imdb": "tt2178802",
"tmdb": 63078,
"trakt": 36462,
"tvdb": 4517459
},
"number": 3,
"season": 3,
"title": "Walk of Punishment"
},
{
"ids": {
"imdb": "tt2178798",
"tmdb": 63082,
"trakt": 36463,
"tvdb": 4517460
},
"number": 4,
"season": 3,
"title": "And Now His Watch Is Ended"
},
{
"ids": {
"imdb": "tt2178788",
"tmdb": 63083,
"trakt": 36464,
"tvdb": 4517461
},
"number": 5,
"season": 3,
"title": "Kissed by Fire"
},
{
"ids": {
"imdb": "tt2178812",
"tmdb": 63084,
"trakt": 36465,
"tvdb": 4517462
},
"number": 6,
"season": 3,
"title": "The Climb"
},
{
"ids": {
"imdb": "tt2178814",
"tmdb": 63081,
"trakt": 36466,
"tvdb": 4517463
},
"number": 7,
"season": 3,
"title": "The Bear and the Maiden Fair"
},
{
"ids": {
"imdb": "tt2178806",
"tmdb": 63085,
"trakt": 36467,
"tvdb": 4517464
},
"number": 8,
"season": 3,
"title": "Second Sons"
},
{
"ids": {
"imdb": "tt2178784",
"tmdb": 63080,
"trakt": 36468,
"tvdb": 4517465
},
"number": 9,
"season": 3,
"title": "The Rains of Castamere"
},
{
"ids": {
"imdb": "tt2178796",
"tmdb": 63079,
"trakt": 36469,
"tvdb": 4517466
},
"number": 10,
"season": 3,
"title": "Mhysa"
}
],
"ids": {
"tmdb": 3626,
"trakt": 2148,
"tvdb": 488434
},
"number": 3
},
{
"episodes": [
{
"ids": {
"imdb": "tt2816136",
"tmdb": 973190,
"trakt": 36470,
"tvdb": 4721938
},
"number": 1,
"season": 4,
"title": "Two Swords"
},
{
"ids": {
"imdb": "tt2832378",
"tmdb": 973219,
"trakt": 36471,
"tvdb": 4801602
},
"number": 2,
"season": 4,
"title": "The Lion and the Rose"
},
{
"ids": {
"imdb": "tt2972426",
"tmdb": 63096,
"trakt": 36472,
"tvdb": 4615736
},
"number": 3,
"season": 4,
"title": "Breaker of Chains"
},
{
"ids": {
"imdb": "tt2972428",
"tmdb": 63097,
"trakt": 36473,
"tvdb": 4615737
},
"number": 4,
"season": 4,
"title": "Oathkeeper"
},
{
"ids": {
"imdb": "tt3060856",
"tmdb": 63098,
"trakt": 36474,
"tvdb": 4615738
},
"number": 5,
"season": 4,
"title": "First of His Name"
},
{
"ids": {
"imdb": "tt3060910",
"tmdb": 63099,
"trakt": 36475,
"tvdb": 4615739
},
"number": 6,
"season": 4,
"title": "The Laws of Gods and Men"
},
{
"ids": {
"imdb": "tt3060876",
"tmdb": 63100,
"trakt": 36476,
"tvdb": 4615740
},
"number": 7,
"season": 4,
"title": "Mockingbird"
},
{
"ids": {
"imdb": "tt3060782",
"tmdb": 63101,
"trakt": 36477,
"tvdb": 4615741
},
"number": 8,
"season": 4,
"title": "The Mountain and the Viper"
},
{
"ids": {
"imdb": "tt3060858",
"tmdb": 63102,
"trakt": 36478,
"tvdb": 4615742
},
"number": 9,
"season": 4,
"title": "The Watchers on the Wall"
},
{
"ids": {
"imdb": "tt3060860",
"tmdb": 63103,
"trakt": 36479,
"tvdb": 4615743
},
"number": 10,
"season": 4,
"title": "The Children"
}
],
"ids": {
"tmdb": 3628,
"trakt": 2149,
"tvdb": 522882
},
"number": 4
},
{
"episodes": [
{
"ids": {
"imdb": "",
"tmdb": 1001402,
"trakt": 63767,
"tvdb": null
},
"number": 1,
"season": 5,
"title": "5x1"
}
],
"ids": {
"tmdb": 62090,
"trakt": 3955,
"tvdb": null
},
"number": 5
}
]
}
}
}
},
"description": "```\n/shows/game-of-thrones/seasons?extended=episodes\n```",
"headers": {}
}
},
"summary": "Get all seasons for a show",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all episodes for a specific season of a show.\n\n#### Translations\n\nIf you'd like to included translated episode titles and overviews in the response, include the `translations` parameter in the URL. Include all languages by setting the parameter to `all` or use a specific 2 digit country language code to further limit it.\n\n**Note:** This returns a lot of data, so please only use this parameter if you actually need it!",
"operationId": "Get single season for a show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "include episode translations",
"example": "es",
"in": "query",
"name": "translations",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"imdb": "tt1480055",
"tmdb": 63056,
"trakt": 456,
"tvdb": 3254641
},
"number": 1,
"season": 1,
"title": "Winter Is Coming"
},
{
"ids": {
"imdb": "tt1668746",
"tmdb": 63057,
"trakt": 457,
"tvdb": 3436411
},
"number": 2,
"season": 1,
"title": "The Kingsroad"
},
{
"ids": {
"imdb": "tt1829962",
"tmdb": 63058,
"trakt": 458,
"tvdb": 3436421
},
"number": 3,
"season": 1,
"title": "Lord Snow"
},
{
"ids": {
"imdb": "tt1829963",
"tmdb": 63059,
"trakt": 459,
"tvdb": 3436431
},
"number": 4,
"season": 1,
"title": "Cripples, Bastards, and Broken Things"
},
{
"ids": {
"imdb": "tt1829964",
"tmdb": 63060,
"trakt": 460,
"tvdb": 3436441
},
"number": 5,
"season": 1,
"title": "The Wolf and the Lion"
},
{
"ids": {
"imdb": "tt1837862",
"tmdb": 63061,
"trakt": 461,
"tvdb": 3436451
},
"number": 6,
"season": 1,
"title": "A Golden Crown"
},
{
"ids": {
"imdb": "tt1837863",
"tmdb": 63062,
"trakt": 462,
"tvdb": 3436461
},
"number": 7,
"season": 1,
"title": "You Win or You Die"
},
{
"ids": {
"imdb": "tt1837864",
"tmdb": 63063,
"trakt": 463,
"tvdb": 3360391
},
"number": 8,
"season": 1,
"title": "The Pointy End"
},
{
"ids": {
"imdb": "tt1851398",
"tmdb": 63064,
"trakt": 464,
"tvdb": 4063481
},
"number": 9,
"season": 1,
"title": "Baelor"
},
{
"ids": {
"imdb": "tt1851397",
"tmdb": 63065,
"trakt": 465,
"tvdb": 4063491
},
"number": 10,
"season": 1,
"title": "Fire and Blood"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get single season for a show",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/comments/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all top level comments for a season. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, most `replies`, `highest` rated, `lowest` rated, most `plays`, and highest `watched` percentage.",
"operationId": "Get all season comments",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies",
"highest",
"lowest",
"plays",
"watched"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Great season!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all season comments",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns a single episode's details. All date and times are in UTC and were calculated using the episode's `air_date` and show's `country` and `air_time`.\n\n**Note:** If the `first_aired` is unknown, it will be set to `null`.",
"operationId": "Get a single episode for a show",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"available_translations": [
"en"
],
"comment_count": 92,
"first_aired": "2011-04-18T01:00:00.000Z",
"ids": {
"imdb": "tt1480055",
"tmdb": 63056,
"trakt": 36440,
"tvdb": 3254641
},
"number": 1,
"number_abs": null,
"overview": "Ned Stark, Lord of Winterfell learns that his mentor, Jon Arryn, has died and that King Robert is on his way north to offer Ned Arryn’s position as the King’s Hand. Across the Narrow Sea in Pentos, Viserys Targaryen plans to wed his sister Daenerys to the nomadic Dothraki warrior leader, Khal Drogo to forge an alliance to take the throne.",
"rating": 9,
"runtime": 58,
"season": 1,
"title": "Winter Is Coming",
"updated_at": "2014-08-29T23:16:39.000Z",
"votes": 111
}
}
}
}
},
"description": "```\n/shows/game-of-thrones/seasons/1/episodes/1?extended=full\n```",
"headers": {}
}
},
"summary": "Get a single episode for a show",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/comments/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all top level comments for an episode. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, most `replies`, `highest` rated, `lowest` rated, and most `plays`.",
"operationId": "Get all episode comments",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies",
"highest",
"lowest",
"plays"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Great episode!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all episode comments",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/lists/{type}/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists that contain this episode. By default, `personal` lists are returned sorted by the most `popular`.",
"operationId": "Get lists containing this episode",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "Filter for a specific list type",
"example": "personal",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"personal",
"official",
"watchlists"
],
"type": "string"
}
},
{
"description": "How to sort",
"example": "popular",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"popular",
"likes",
"comments",
"items",
"added",
"updated"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get lists containing this episode",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/people": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all `cast` and `crew` for an episode. Each `cast` member will have a `characters` array and a standard `person` object.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, and `editing` (if there are people for those crew positions). Each of those members will have a `jobs` array and a standard `person` object.\n\n#### Guest Stars\n\nIf you add `?extended=guest_stars` to the URL, it will return all guest stars that appeared in the episode.\n\n**Note:** This returns a lot of data, so please only use this extended parameter if you actually need it!",
"operationId": "Get all people for an episode",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Daenerys Targaryen"
],
"person": {
"ids": {
"imdb": "nm3592338",
"slug": "emilia-clarke",
"tmdb": 1223786,
"trakt": 2332,
"tvrage": null
},
"name": "Emilia Clarke"
}
},
{
"characters": [
"Jon Snow"
],
"person": {
"ids": {
"imdb": "nm3229685",
"slug": "kit-harington",
"tmdb": 239019,
"trakt": 2333,
"tvrage": null
},
"name": "Kit Harington"
}
},
{
"characters": [
"Robert Baratheon"
],
"person": {
"ids": {
"imdb": "nm0004692",
"slug": "mark-addy",
"tmdb": 13633,
"trakt": 17444,
"tvrage": 37728
},
"name": "Mark Addy"
}
}
],
"crew": {
"camera": [
{
"jobs": [
"Director of Photography"
],
"person": {
"ids": {
"imdb": "nm0002399",
"slug": "alik-sakharov",
"tmdb": 1318704,
"trakt": 17509,
"tvrage": null
},
"name": "Alik Sakharov"
}
}
],
"directing": [
{
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm0887700",
"slug": "tim-van-patten",
"tmdb": 44797,
"trakt": 17508,
"tvrage": 47577
},
"name": "Tim Van Patten"
}
}
],
"editing": [
{
"jobs": [
"Editor"
],
"person": {
"ids": {
"imdb": "nm0653205",
"slug": "oral-norrie-ottey",
"tmdb": 18077,
"trakt": 17510,
"tvrage": null
},
"name": "Oral Norrie Ottey"
}
}
],
"writing": [
{
"jobs": [
"Writer"
],
"person": {
"ids": {
"imdb": "nm1125275",
"slug": "david-benioff",
"tmdb": 9813,
"trakt": 2631,
"tvrage": null
},
"name": "David Benioff"
}
},
{
"jobs": [
"Writer"
],
"person": {
"ids": {
"imdb": "nm1888967",
"slug": "d-b-weiss",
"tmdb": 228068,
"trakt": 17443,
"tvrage": null
},
"name": "D. B. Weiss"
}
}
]
},
"guest_stars": [
{
"characters": [
"Khal Drogo"
],
"person": {
"ids": {
"imdb": "nm0597388",
"slug": "jason-momoa",
"tmdb": 117642,
"trakt": 5038,
"tvrage": 35980
},
"name": "Jason Momoa"
}
},
{
"characters": [
"Hodor"
],
"person": {
"ids": {
"imdb": null,
"slug": "kristian-nairn",
"tmdb": 1223792,
"trakt": 13075,
"tvrage": null
},
"name": "Kristian Nairn"
}
},
{
"characters": [
"Benjen Stark"
],
"person": {
"ids": {
"imdb": "nm1152798",
"slug": "joseph-mawle",
"tmdb": 119783,
"trakt": 10613,
"tvrage": null
},
"name": "Joseph Mawle"
}
}
]
}
}
}
}
},
"description": "```\n/shows/game-of-thrones/seasons/1/episodes/1/people?extended=guest_stars\n```",
"headers": {}
}
},
"summary": "Get all people for an episode",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/ratings": {
"get": {
"description": "Returns rating (between 0 and 10) and distribution for an episode.",
"operationId": "Get episode ratings",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "12",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"distribution": {
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 0,
"6": 0,
"7": 0,
"8": 0,
"9": 1,
"10": 2
},
"rating": 9,
"votes": 3
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get episode ratings",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/stats": {
"get": {
"description": "Returns lots of episode stats.",
"operationId": "Get episode stats",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"collected_episodes": 87991,
"collectors": 12899,
"comments": 115,
"lists": 309,
"plays": 37986,
"votes": 25655,
"watchers": 30521
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get episode stats",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/translations/{language}": {
"get": {
"description": "Returns all translations for an episode, including language and translated values for title and overview.",
"operationId": "Get all episode translations",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "2 character language code",
"example": "es",
"in": "path",
"name": "language",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "us",
"language": "en",
"overview": "Jon Arryn, the Hand of the King, is dead. King Robert Baratheon plans to ask his oldest friend, Eddard Stark, to take Jon's place. Across the sea, Viserys Targaryen plans to wed his sister to a nomadic warlord in exchange for an army.",
"title": "Winter Is Coming"
},
{
"country": "es",
"language": "es",
"overview": "El Lord Ned Stark está preocupado por los perturbantes reportes de un desertor del Nights Watch; El Rey Robert y los Lannisters llegan a Winterfell; el exiliado Viserys Targaryen forja una nueva y poderosa alianza.",
"title": "Se acerca el invierno"
},
{
"country": "tw",
"language": "zh",
"overview": "一名守夜人军团的逃兵在临冬城外被抓获，领主艾德（奈德）·史塔克下令将其处斩。奈德对绝境长城之外的形势忧心忡忡。行刑结束后，奈德回到城中，他的夫人凯特琳带来一个令人震惊的消息：奈德的良师益友、现任首相琼恩·艾林在都城离奇死亡，罗伯特国王正启程赶往北方，希望奈德接替琼恩·艾林出任国王之手。与此同时，在狭海对岸的潘托斯，韦赛里斯·坦格利安正计划与多斯拉克游牧民族的一位重要首领卓戈卡奥结盟，凭借多斯拉克人的力量夺回本属于他的铁王座。他妹妹丹妮莉斯的终身幸福成了他手中最重要的筹码。罗伯特国王带着瑟曦·兰尼斯特王后及兰尼斯特家族的重要成员抵达临冬城。他的随行人员包括：王后的弟弟詹姆和提力昂，他们一个英俊潇洒，一个却是侏儒；12岁的乔佛里王子，王位的继承人。奈德无法拒绝国王的盛情邀请，决定南下君临城帮助国王稳定国内局势。就在罗伯特和奈德动身之前，奈德的私生子琼恩·雪诺决定北上黑城堡加盟守夜人军团，对守夜人颇为好奇的提力昂打算和雪诺一同前往。厄运突然降临到奈德的次子布兰身上，奈德和琼恩都被迫推迟了行程。",
"title": "凛冬将至"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all episode translations",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/episodes/{episode}/watching": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all users watching this episode right now.",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "episode number",
"example": "1",
"in": "path",
"name": "episode",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
{
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get users watching right now",
"tags": [
"Episodes"
]
}
},
"/shows/{id}/seasons/{season}/lists/{type}/{sort}": {
"get": {
"description": "#### 📄 Pagination 😁 Emojis\n\nReturns all lists that contain this season. By default, `personal` lists are returned sorted by the most `popular`.",
"operationId": "Get lists containing this season",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "Filter for a specific list type",
"example": "personal",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"personal",
"official",
"watchlists"
],
"type": "string"
}
},
{
"description": "How to sort",
"example": "popular",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"popular",
"likes",
"comments",
"items",
"added",
"updated"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 10,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "How could my brain conceive them?",
"display_numbers": true,
"ids": {
"slug": "incredible-thoughts",
"trakt": 1337
},
"item_count": 50,
"likes": 99,
"name": "Incredible Thoughts",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get lists containing this season",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/people": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all `cast` and `crew` for a season, including the `episode_count` for which they appear. Each `cast` member will have a `characters` array and a standard `person` object.\n\nThe `crew` object will be broken up by department into `production`, `art`, `crew`, `costume & make-up`, `directing`, `writing`, `sound`, `camera`, `visual effects`, `lighting`, and `editing` (if there are people for those crew positions).. Each of those members will have a `jobs` array and a standard `person` object.\n\n#### Guest Stars\n\nIf you add `?extended=guest_stars` to the URL, it will return all guest stars that appeared in at least 1 episode of the season.\n\n**Note:** This returns a lot of data, so please only use this extended parameter if you actually need it!",
"operationId": "Get all people for a season",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cast": [
{
"characters": [
"Daenerys Targaryen"
],
"episode_count": 10,
"person": {
"ids": {
"imdb": "nm3592338",
"slug": "emilia-clarke",
"tmdb": 1223786,
"trakt": 2332,
"tvrage": null
},
"name": "Emilia Clarke"
}
},
{
"characters": [
"Jon Snow"
],
"episode_count": 10,
"person": {
"ids": {
"imdb": "nm3229685",
"slug": "kit-harington",
"tmdb": 239019,
"trakt": 2333,
"tvrage": null
},
"name": "Kit Harington"
}
},
{
"characters": [
"Robert Baratheon"
],
"episode_count": 10,
"person": {
"ids": {
"imdb": "nm0004692",
"slug": "mark-addy",
"tmdb": 13633,
"trakt": 17444,
"tvrage": 37728
},
"name": "Mark Addy"
}
}
],
"crew": {
"art": [
{
"episode_count": 10,
"jobs": [
"Set Decoration"
],
"person": {
"ids": {
"imdb": "nm0731517",
"slug": "richard-roberts",
"tmdb": 8410,
"trakt": 6026,
"tvrage": null
},
"name": "Richard Roberts"
}
},
{
"episode_count": 10,
"jobs": [
"Production Design"
],
"person": {
"ids": {
"imdb": "nm0413541",
"slug": "gemma-jackson",
"tmdb": 9153,
"trakt": 17454,
"tvrage": null
},
"name": "Gemma Jackson"
}
}
],
"costume & make-up": [
{
"episode_count": 10,
"jobs": [
"Costume Design"
],
"person": {
"ids": {
"imdb": "nm0163449",
"slug": "michele-clapton",
"tmdb": 50953,
"trakt": 5019,
"tvrage": null
},
"name": "Michele Clapton"
}
}
],
"directing": [
{
"episode_count": 3,
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm1047532",
"slug": "brian-kirk",
"tmdb": 93223,
"trakt": 17511,
"tvrage": 115091
},
"name": "Brian Kirk"
}
},
{
"episode_count": 3,
"jobs": [
"Director"
],
"person": {
"ids": {
"imdb": "nm0590889",
"slug": "daniel-minahan",
"tmdb": 88743,
"trakt": 17514,
"tvrage": 28917
},
"name": "Daniel Minahan"
}
}
],
"production": [
{
"episode_count": 10,
"jobs": [
"Executive Producer"
],
"person": {
"ids": {
"imdb": "nm1125275",
"slug": "david-benioff",
"tmdb": 9813,
"trakt": 2631,
"tvrage": null
},
"name": "David Benioff"
}
},
{
"episode_count": 10,
"jobs": [
"Co-Executive Producer"
],
"person": {
"ids": {
"imdb": "nm0552333",
"slug": "george-r-r-martin",
"tmdb": 237053,
"trakt": 5020,
"tvrage": 79951
},
"name": "George R. R. Martin"
}
}
],
"sound": [
{
"episode_count": 10,
"jobs": [
"Original Music Composer"
],
"person": {
"ids": {
"imdb": "nm1014697",
"slug": "ramin-djawadi",
"tmdb": 10851,
"trakt": 3698,
"tvrage": null
},
"name": "Ramin Djawadi"
}
}
],
"writing": [
{
"episode_count": 10,
"jobs": [
"Novel"
],
"person": {
"ids": {
"imdb": "nm0552333",
"slug": "george-r-r-martin",
"tmdb": 237053,
"trakt": 5020,
"tvrage": 79951
},
"name": "George R. R. Martin"
}
}
]
},
"guest_stars": [
{
"characters": [
"Rodrik Cassel"
],
"episode_count": 9,
"person": {
"ids": {
"imdb": "nm0231871",
"slug": "ron-donachie",
"tmdb": 63141,
"trakt": 17471,
"tvrage": 13644
},
"name": "Ron Donachie"
}
},
{
"characters": [
"Grand Maester Pycelle"
],
"episode_count": 8,
"person": {
"ids": {
"imdb": "nm0002103",
"slug": "julian-glover",
"tmdb": 740,
"trakt": 2654,
"tvrage": 41261
},
"name": "Julian Glover"
}
},
{
"characters": [
"Irri"
],
"episode_count": 8,
"person": {
"ids": {
"imdb": "nm3822505",
"slug": "amrita-acharia",
"tmdb": 1048692,
"trakt": 17478,
"tvrage": 340928
},
"name": "Amrita Acharia"
}
}
]
}
}
}
}
},
"description": "```\n/shows/game-of-thrones/seasons/1/people?extended=guest_stars\n```",
"headers": {}
}
},
"summary": "Get all people for a season",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/ratings": {
"get": {
"description": "Returns rating (between 0 and 10) and distribution for a season.",
"operationId": "Get season ratings",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"distribution": {
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 0,
"6": 0,
"7": 0,
"8": 0,
"9": 1,
"10": 2
},
"rating": 9,
"votes": 3
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get season ratings",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/stats": {
"get": {
"description": "Returns lots of season stats.",
"operationId": "Get season stats",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"collected_episodes": 87991,
"collectors": 12899,
"comments": 115,
"lists": 309,
"plays": 37986,
"votes": 25655,
"watchers": 30521
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get season stats",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/translations/{language}": {
"get": {
"description": "Returns all translations for an season, including language and translated values for title and overview.",
"operationId": "Get all season translations",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "2 character language code",
"example": "es",
"in": "path",
"name": "language",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "ko",
"language": "ko",
"overview": "웨스테로스 북부 지방 윈터펠을 다스리는 에다드 스타크. 스타크 가문은 '겨울이 오고 있다'를 가언으로 몇 년, 때론 남은 일생 동안 계속 될지도 모르는 혹독한 겨울을 대비하며 지낸다. 그러던 중 에다드는 현재 왕좌에 있는 바라테온 가문의 로버트 왕의 핸드로서 왕을 보좌하기 위해 수도 킹스랜딩에 오게 된다. 바라테온 가문과 라니스터 가문, 왕좌를 빼앗긴 타르가옌 가문 등 칠왕국 안의 가문들은 욕망과 명예를 향한 열망으로 피 튀기는 암투를 시작하는데...",
"title": "시즌 1"
},
{
"country": "nl",
"language": "nl",
"overview": "Het eerste seizoen van de epische fantasy tv- drama-serie Game of Thrones ging in première op HBO op 17 april 2011 en eindigde op 19 juni 2011, uitgezonden in de Verenigde Staten . Het bestaat uit 10 afleveringen , elke aflevering duurt ongeveer 55 minuten. Game of Thrones is gebaseerd op de roman A Game of Thrones , de eerste vermelding in Een Lied van IJs en Vuur serie van George RR Martin . Het verhaal speelt zich af in een fictieve wereld , in de eerste plaats op een continent genaamd Westeros . The Noble House Stark , onder leiding van Lord Eddard \" Ned \" Stark wordt betrokken in regelingen tegen koning Robert Baratheon wanneer de Hand van de Koning Jon Arryn op mysterieuze wijze sterft .",
"title": "Seizoen 1"
},
{
"country": "no",
"language": "no",
"overview": "Sesong 1 av Game of Thrones hadde premiere 17 Mai, 2011.",
"title": "Sesong 1"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all season translations",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/seasons/{season}/watching": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all users watching this season right now.",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "season number",
"example": "1",
"in": "path",
"name": "season",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
{
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get users watching right now",
"tags": [
"Seasons"
]
}
},
"/shows/{id}/stats": {
"get": {
"description": "Returns lots of show stats.",
"operationId": "Get show stats",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"collected_episodes": 7144637,
"collectors": 159266,
"comments": 257,
"lists": 149488,
"plays": 18278737,
"recommended": 54321,
"votes": 51065,
"watchers": 355422
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get show stats",
"tags": [
"Shows"
]
}
},
"/shows/{id}/studios": {
"get": {
"description": "Returns all studios for a show.",
"operationId": "Get show studios",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "us",
"ids": {
"slug": "abc-studios",
"tmdb": 19366,
"trakt": 1
},
"name": "ABC Studios"
},
{
"country": "us",
"ids": {
"slug": "deknight-productions",
"tmdb": 51963,
"trakt": 2
},
"name": "DeKnight Productions"
},
{
"country": "us",
"ids": {
"slug": "goddard-textiles",
"tmdb": 51964,
"trakt": 3
},
"name": "Goddard Textiles"
},
{
"country": "us",
"ids": {
"slug": "marvel-television",
"tmdb": 38679,
"trakt": 4
},
"name": "Marvel Television"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get show studios",
"tags": [
"Shows"
]
}
},
"/shows/{id}/translations/{language}": {
"get": {
"description": "Returns all translations for a show, including language and translated values for title and overview.",
"operationId": "Get all show translations",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "2 character language code",
"example": "es",
"in": "path",
"name": "language",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"country": "us",
"language": "en",
"overview": "Breaking Bad is an American crime drama television series created and produced by Vince Gilligan. Set and produced in Albuquerque, New Mexico, Breaking Bad is the story of Walter White, a struggling high school chemistry teacher who is diagnosed with inoperable lung cancer at the beginning of the series. He turns to a life of crime, producing and selling methamphetamine, in order to secure his family's financial future before he dies, teaming with his former student, Jesse Pinkman. Heavily serialized, the series is known for positioning its characters in seemingly inextricable corners and has been labeled a contemporary western by its creator.",
"title": "Breaking Bad"
},
{
"country": "tr",
"language": "tr",
"overview": "...",
"title": "Breaking Bad"
},
{
"country": "sk",
"language": "sk",
"overview": "",
"title": "Perníkový tatko"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all show translations",
"tags": [
"Shows"
]
}
},
"/shows/{id}/watching": {
"get": {
"description": "#### ✨ Extended Info\n\nReturns all users watching this show right now.",
"parameters": [
{
"description": "Trakt ID, Trakt slug, or IMDB ID",
"example": "game-of-thrones",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
{
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get users watching right now",
"tags": [
"Shows"
]
}
},
"/sync/collection": {
"post": {
"description": "#### 🔒 OAuth Required\n\nAdd items to a user's collection. Accepts shows, seasons, episodes and movies. If only a show is passed, all episodes for the show will be collected. If seasons are specified, all episodes in those seasons will be collected.\n\nSend a `collected_at` UTC datetime to mark items as collected in the past. You can also send additional metadata about the media itself to have a very accurate collection. Showcase what is available to watch from your epic HD DVD collection down to your downloaded iTunes movies.\n\n**Note:** You can resend items already in your collection and they will be updated with any new values. This includes the `collected_at` and any other metadata.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n\n#### Media Object POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie`, `show`, or `episode` object. |\n| `collected_at` | datetime | UTC datetime when the item was collected. Set to `released` to automatically use the inital release date + runtime *(episodes only)*). |\n| `media_type` | string | Set to `digital`, `bluray`, `hddvd`, `dvd`, `vcd`, `vhs`, `betamax`, or `laserdisc`. |\n| `resolution` | string | Set to `uhd_4k`, `hd_1080p`, `hd_1080i`, `hd_720p`, `sd_480p`, `sd_480i`, `sd_576p`, or `sd_576i`. |\n| `hdr` | string | Set to `dolby_vision`, `hdr10`, `hdr10_plus`, or `hlg`. |\n| `audio` | string | Set to `dolby_digital`, `dolby_digital_plus`, `dolby_digital_plus_atmos`, `dolby_truehd`, `dolby_atmos` *(Dolby TrueHD Atmos)*, `dolby_prologic`, `dts`, `dts_ma`, `dts_hr`, `dts_x`, `auro_3d`, `mp3`, `mp2`, `aac`, `lpcm`, `ogg` *(Ogg Vorbis)*, `ogg_opus`, `wma`, or `flac`. |\n| `audio_channels` | string | Set to `1.0`, `2.0`, `2.1`, `3.0`, `3.1`, `4.0`, `4.1`, `5.0`, `5.1`, `5.1.2`, `5.1.4`, `6.1`, `7.1`, `7.1.2`, `7.1.4`, `9.1`, or `10.1` |\n| `3d` | boolean | Set `true` if in 3D. |",
"operationId": "Add items to collection",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"movies": [
{
"audio": "dts_ma",
"audio_channels": "5.1",
"collected_at": "2014-09-01T09:10:11.000Z",
"hdr": "dolby_vision",
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"media_type": "digital",
"resolution": "uhd_4k",
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"audio": "dolby_digital_plus",
"audio_channels": "5.1",
"media_type": "bluray",
"number": 1,
"resolution": "hd_1080p"
},
{
"number": 2
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"audio": {
"type": "string"
},
"audio_channels": {
"type": "string"
},
"collected_at": {
"type": "string"
},
"hdr": {
"type": "string"
},
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"media_type": {
"type": "string"
},
"resolution": {
"type": "string"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"audio": {
"type": "string"
},
"audio_channels": {
"type": "string"
},
"media_type": {
"type": "string"
},
"number": {
"type": "number"
},
"resolution": {
"type": "string"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"episodes": 12,
"movies": 1
},
"existing": {
"episodes": 0,
"movies": 0
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
},
"updated": {
"episodes": 0,
"movies": 0
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add items to collection",
"tags": [
"Sync"
]
}
},
"/sync/collection/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove one or more items from a user's collection.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |",
"operationId": "Remove items from collection",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Remove_items_from_collectionBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"episodes": 12,
"movies": 1
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove items from collection",
"tags": [
"Sync"
]
}
},
"/sync/collection/{type}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nGet all collected items in a user's collection. A collected item indicates availability to watch digitally or on physical media.\n\nEach `movie` object contains `collected_at` and `updated_at` timestamps. Since users can set custom dates when they collected movies, it is possible for `collected_at` to be in the past. We also include `updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the movie if you see a newer timestamp.\n\nEach `show` object contains `last_collected_at` and `last_updated_at` timestamps. Since users can set custom dates when they collected episodes, it is possible for `last_collected_at` to be in the past. We also include `last_updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the show if you see a newer timestamp.\n\nIf you add `?extended=metadata` to the URL, it will return the additional `media_type`, `resolution`, `hdr`, `audio`, `audio_channels` and '3d' metadata. It will use `null` if the metadata isn't set for an item.",
"operationId": "Get collection",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"last_collected_at": "2014-09-01T09:10:11.000Z",
"last_updated_at": "2014-09-01T09:10:11.000Z",
"seasons": [
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 1
},
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10_plus",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10_plus",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 2
}
],
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
},
{
"last_collected_at": "2014-09-01T09:10:11.000Z",
"last_updated_at": "2014-09-01T09:10:11.000Z",
"seasons": [
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 1
},
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 2
}
],
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
}
}
]
}
}
}
},
"description": "```\n/sync/collection/shows?extended=metadata\n```",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get collection",
"tags": [
"Sync"
]
}
},
"/sync/history": {
"post": {
"description": "#### 🔒 OAuth Required\n\nAdd items to a user's watch history. Accepts shows, seasons, episodes and movies. If only a show is passed, all episodes for the show will be added. If seasons are specified, only episodes in those seasons will be added.\n\nSend a `watched_at` UTC datetime to mark items as watched in the past. This is useful for syncing past watches from a media center.\n\n**Note:** Please be careful with sending duplicate data. We don't verify the `item` + `watched_at` to ensure it's unique, it is up to your app to veify this and not send duplicate plays.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n\n#### Media Object POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie`, `show`, or `episode` object. |\n| `watched_at` | datetime | UTC datetime when the item was watched. Set to `released` to automatically use the initial release date + runtime *(episodes only)*. |",
"operationId": "Add items to watched history",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
},
"watched_at": "2014-09-01T09:10:11.000Z"
}
],
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"watched_at": "2014-09-01T09:10:11.000Z",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
},
"watched_at": "2019-01-02T09:10:11.000Z"
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3,
"watched_at": "2014-09-01T09:10:11.000Z"
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"number": 1,
"watched_at": "2014-09-01T09:10:11.000Z"
},
{
"number": 2
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"watched_at": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"watched_at": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"watched_at": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
},
"watched_at": {
"type": "string"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
},
"watched_at": {
"type": "string"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"episodes": 72,
"movies": 2
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add items to watched history",
"tags": [
"Sync"
]
}
},
"/sync/history/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove items from a user's watch history including all watches, scrobbles, and checkins. Accepts shows, seasons, episodes and movies. If only a show is passed, all episodes for the show will be removed. If seasons are specified, only episodes in those seasons will be removed.\n\nYou can also send a list of raw history `ids` _(64-bit integers)_ to delete single plays from the watched history. The [**/sync/history**](#reference/sync/get-history) method will return an individual `id` _(64-bit integer)_ for each history item.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n| `ids` | array | Array of history ids. |",
"operationId": "Remove items from history",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"ids": [
4,
8,
15,
16,
23,
42
],
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"number": 1
},
{
"number": 2
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"ids": {
"items": {
"type": "number"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"episodes": 72,
"movies": 2
},
"not_found": {
"episodes": [],
"ids": [
23,
42
],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove items from history",
"tags": [
"Sync"
]
}
},
"/sync/history/{type}/{id}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination ✨ Extended Info\n\nReturns movies and episodes that a user has watched, sorted by most recent. You can optionally limit the `type` to `movies` or `episodes`. The `id` _(64-bit integer)_ in each history item uniquely identifies the event and can be used to remove individual events by using the [**/sync/history/remove**](#reference/sync/remove-from-history/get-watched-history) method. The `action` will be set to `scrobble`, `checkin`, or `watch`.\n\nSpecify a `type` and trakt `id` to limit the history for just that item. If the `id` is valid, but there is no history, an empty array will be returned.\n\n| Example URL | Returns watches for... |\n|---|---|\n| `/history/movies/12601` | TRON: Legacy |\n| `/history/shows/1388` | All episodes of Breaking Bad |\n| `/history/seasons/3950` | All episodes of Breaking Bad: Season 1 |\n| `/history/episodes/73482` | Only episode 1 for Breaking Bad: Season 1 |",
"operationId": "Get watched history",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes"
],
"type": "string"
}
},
{
"description": "Trakt ID for a specific item.",
"example": "123",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "Starting date.",
"example": "2016-06-01T00:00:00.000Z",
"in": "query",
"name": "start_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Ending date.",
"example": "2016-07-01T23:59:59.000Z",
"in": "query",
"name": "end_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"action": "scrobble",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397629,
"trakt": 251,
"tvdb": 797571
},
"number": 1,
"season": 2,
"title": "Pawnee Zoo"
},
"id": 1982346,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
},
{
"action": "checkin",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397627,
"trakt": 252,
"tvdb": 1088031
},
"number": 2,
"season": 2,
"title": "The Stakeout"
},
"id": 1982347,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
},
{
"action": "watch",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397642,
"trakt": 253,
"tvdb": 1088041
},
"number": 3,
"season": 2,
"title": "Beauty Pageant"
},
"id": 1982348,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
}
]
}
}
}
},
"description": "```\n/sync/history/episodes\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get watched history",
"tags": [
"Sync"
]
}
},
"/sync/last_activities": {
"get": {
"description": "#### 🔒 OAuth Required\n\nThis method is a useful first step in the syncing process. We recommended caching these dates locally, then you can compare to know exactly what data has changed recently. This can greatly optimize your syncs so you don't pull down a ton of data only to see nothing has actually changed.\n\n#### Account\n\n`settings_at` is set when the OAuth user updates any of their Trakt settings on the website. `followed_at` is set when another Trakt user follows or unfollows the OAuth user. `following_at` is set when the OAuth user follows or unfollows another Trakt user. `pending_at` is set when the OAuth user follows a private account, which requires their approval. `requested_at` is set when the OAuth user has a private account and someone requests to follow them.",
"operationId": "Get last activity",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"account": {
"followed_at": "2020-03-04T03:38:09.000Z",
"following_at": "2020-03-04T03:38:09.000Z",
"pending_at": "2020-03-04T03:38:09.000Z",
"requested_at": "2022-04-27T03:38:09.000Z",
"settings_at": "2020-03-04T03:38:09.000Z"
},
"all": "2014-11-20T07:01:32.000Z",
"comments": {
"blocked_at": "2022-02-22T03:38:09.000Z",
"liked_at": "2014-11-20T03:38:09.000Z"
},
"episodes": {
"collected_at": "2014-11-19T22:02:41.000Z",
"commented_at": "2014-11-20T06:51:30.000Z",
"paused_at": "2014-11-20T06:51:30.000Z",
"rated_at": "2014-11-20T06:51:30.000Z",
"watched_at": "2014-11-20T06:51:30.000Z",
"watchlisted_at": "2014-11-20T06:51:30.000Z"
},
"lists": {
"commented_at": "2014-11-20T06:51:30.000Z",
"liked_at": "2014-11-20T00:36:48.000Z",
"updated_at": "2014-11-20T06:52:18.000Z"
},
"movies": {
"collected_at": "2014-11-20T06:51:30.000Z",
"commented_at": "2014-11-20T06:51:30.000Z",
"hidden_at": "2016-08-20T06:51:30.000Z",
"paused_at": "2014-11-20T06:51:30.000Z",
"rated_at": "2014-11-19T18:32:29.000Z",
"recommendations_at": "2014-11-19T21:42:41.000Z",
"watched_at": "2014-11-19T21:42:41.000Z",
"watchlisted_at": "2014-11-19T21:42:41.000Z"
},
"recommendations": {
"updated_at": "2014-11-20T06:52:18.000Z"
},
"saved_filters": {
"updated_at": "2022-06-14T06:52:18.000Z"
},
"seasons": {
"commented_at": "2014-11-20T06:51:30.000Z",
"hidden_at": "2016-08-20T06:51:30.000Z",
"rated_at": "2014-11-19T19:54:24.000Z",
"watchlisted_at": "2014-11-20T06:51:30.000Z"
},
"shows": {
"commented_at": "2014-11-20T06:51:30.000Z",
"hidden_at": "2016-08-20T06:51:30.000Z",
"rated_at": "2014-11-19T19:50:58.000Z",
"recommendations_at": "2014-11-20T06:51:30.000Z",
"watchlisted_at": "2014-11-20T06:51:30.000Z"
},
"watchlist": {
"updated_at": "2014-11-20T06:52:18.000Z"
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get last activity",
"tags": [
"Sync"
]
}
},
"/sync/playback/{id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nRemove a playback item from a user's playback progress list. A `404` will be returned if the `id` is invalid.",
"operationId": "Remove a playback item",
"parameters": [
{
"description": "playback ID",
"example": "13",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove a playback item",
"tags": [
"Sync"
]
}
},
"/sync/playback/{type}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination Optional\n\nWhenever a scrobble is paused, the playback progress is saved. Use this progress to sync up playback across different media centers or apps. For example, you can start watching a movie in a media center, stop it, then resume on your tablet from the same spot. Each item will have the `progress` percentage between 0 and 100.\n\nYou can optionally specify a `type` to only get `movies` or `episodes`.\n\nBy default, all results will be returned. Pagination is optional and can be used for something like an \"on deck\" feature, or if you only need a limited data set.\n\n**Note:** We only save playback progress for the last 6 months.",
"operationId": "Get playback progress",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"episodes"
],
"type": "string"
}
},
{
"description": "Starting date.",
"example": "2016-06-01T00:00:00.000Z",
"in": "query",
"name": "start_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Ending date.",
"example": "2016-07-01T23:59:59.000Z",
"in": "query",
"name": "end_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 13,
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
"paused_at": "2015-01-25T22:01:32.000Z",
"progress": 10,
"type": "movie"
},
{
"episode": {
"ids": {
"imdb": "",
"tmdb": 62131,
"trakt": 1,
"tvdb": 3859781
},
"number": 1,
"season": 0,
"title": "Good Cop Bad Cop"
},
"id": 37,
"paused_at": "2015-01-25T22:01:32.000Z",
"progress": 65.5,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get playback progress",
"tags": [
"Sync"
]
}
},
"/sync/ratings": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRate one or more items. Accepts shows, seasons, episodes and movies. If only a show is passed, only the show itself will be rated. If seasons are specified, all of those seasons will be rated.\n\nSend a `rated_at` UTC datetime to mark items as rated in the past. This is useful for syncing ratings from a media center.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n\n#### Media Object POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| item <span style=\"color:red;\">*</a> | object | `movie`, `show`, `season`, or `episode` object. |\n| `rating` <span style=\"color:red;\">*</a> | integer | Between 1 and 10. |\n| `rated_at` | datetime | UTC datetime when the item was rated. |",
"operationId": "Add new ratings",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
},
"rating": 7
}
],
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"rated_at": "2014-09-01T09:10:11.000Z",
"rating": 5,
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
},
"rating": 10
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
},
"rating": 10
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"rating": 10,
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3,
"rating": 9
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"number": 1,
"rating": 8
},
{
"number": 2,
"rating": 8
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"rating": {
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"rated_at": {
"type": "string"
},
"rating": {
"type": "number"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"rating",
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"rating": {
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"rating": {
"type": "number"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
},
"rating": {
"type": "number"
}
},
"required": [
"rating",
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
},
"rating": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"episodes": 2,
"movies": 1,
"seasons": 1,
"shows": 1
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
},
"rating": 10
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add new ratings",
"tags": [
"Sync"
]
}
},
"/sync/ratings/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove ratings for one or more items.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |",
"operationId": "Remove ratings",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Remove_items_from_collectionBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"episodes": 2,
"movies": 1,
"seasons": 1,
"shows": 1
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove ratings",
"tags": [
"Sync"
]
}
},
"/sync/ratings/{type}/{rating}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info\n\nGet a user's ratings filtered by `type`. You can optionally filter for a specific `rating` between 1 and 10. Send a comma separated string for `rating` if you need multiple ratings.",
"operationId": "Get ratings",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes",
"all"
],
"type": "string"
}
},
{
"description": "Filter for a specific rating.",
"example": "9",
"in": "path",
"name": "rating",
"required": true,
"schema": {
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10"
],
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt1683084",
"tmdb": 62118,
"trakt": 49,
"tvdb": 2639411
},
"number": 1,
"season": 4,
"title": "Box Cutter"
},
"rated_at": "2014-09-01T09:10:11.000Z",
"rating": 10,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"episode": {
"ids": {
"imdb": "tt1683095",
"tmdb": 62127,
"trakt": 56,
"tvdb": 4127161
},
"number": 8,
"season": 4,
"title": "Hermanos"
},
"rated_at": "2014-09-01T09:10:11.000Z",
"rating": 10,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
}
]
}
}
}
},
"description": "```\n/sync/ratings/episodes\n```",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get ratings",
"tags": [
"Sync"
]
}
},
"/sync/recommendations": {
"post": {
"description": "#### 🔒 OAuth Required 😁 Emojis\n\nIf the user only had 50 movies and TV shows to bring with them on a desert island, what would they be? These recommendations are used to enchance Trakt's social recommendation algorithm. Apps should encourage user's to build their personal recommendations so the algorithm keeps getting better.\n\n#### Notes\n\nEach recommendation can optionally accept a `notes` *(255 maximum characters)* field explaining why the user recommended the item.\n\n#### Limits\n\nIf the user has recommended 50 items already, a `420` HTTP error code is returned. This limit applies to all users.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |",
"operationId": "Add items to personal recommendations",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"notes": "One of Chritian Bale's most iconic roles.",
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"notes": "I AM THE DANGER!",
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
}
]
},
"properties": {
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"movies": 1,
"shows": 2
},
"existing": {
"movies": 0,
"shows": 0
},
"list": {
"item_count": 3,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"shows": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add items to personal recommendations",
"tags": [
"Sync"
]
}
},
"/sync/recommendations/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove items from a user's personal recommendations. These recommendations are used to enchance Trakt's social recommendation algorithm. Apps should encourage user's to build their personal recommendations so the algorithm keeps getting better.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |",
"operationId": "Remove items from personal recommendations",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
]
},
"properties": {
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"movies": 1,
"shows": 1
},
"list": {
"item_count": 0,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove items from personal recommendations",
"tags": [
"Sync"
]
}
},
"/sync/recommendations/reorder": {
"post": {
"description": "#### 🔒 OAuth Required\n\nReorder all items on a user's personal recommendations by sending the updated `rank` of list item ids. Use the [**/sync/recommendations**](#reference/sync/get-personal-recommendations) method to get all list item ids.",
"operationId": "Reorder personally recommended items",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Reorder_watchlist_itemsBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"list": {
"item_count": 3,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"skipped_ids": [
12
],
"updated": 6
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Reorder personally recommended items",
"tags": [
"Sync"
]
}
},
"/sync/recommendations/{type}/{sort}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nIf the user only had 50 movies and TV shows to bring with them on a desert island, what would they be? These recommendations are used to enchance Trakt's social recommendation algorithm. Apps should encourage user's to build their personal recommendations so the algorithm keeps getting better.\n\n#### Notes\n\nEach recommendation contains a `notes` field explaining why the user recommended the item.",
"operationId": "Get personal recommendations",
"parameters": [
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "How to sort (only if type is also sent)",
"example": "rank",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"rank",
"added",
"released",
"title"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 101,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": "I AM THE DANGER!",
"rank": 1,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"id": 102,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": "Atmospheric for days.",
"rank": 2,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"type": "show"
}
]
}
}
}
},
"description": "```\n/sync/recommendations/shows\n```",
"headers": {
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get personal recommendations",
"tags": [
"Sync"
]
}
},
"/sync/watched/{type}": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nReturns all movies or shows a user has watched sorted by most plays.\n\nIf `type` is set to _shows_ and you add `?extended=noseasons` to the URL, it won't return season or episode info.\n\nEach `movie` and `show` object contains `last_watched_at` and `last_updated_at` timestamps. Since users can set custom dates when they watched movies and episodes, it is possible for `last_watched_at` to be in the past. We also include `last_updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the movies and shows if you see a newer timestamp.\n\nEach `show` object contains a `reset_at` timestamp. If not `null`, this is when the user started re-watching the show. Your app can adjust the progress by ignoring episodes with a `last_watched_at` prior to the `reset_at`.",
"operationId": "Get watched",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"last_updated_at": "2014-10-11T17:00:54.000Z",
"last_watched_at": "2014-10-11T17:00:54.000Z",
"plays": 56,
"reset_at": null,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
},
{
"last_updated_at": "2014-10-12T17:00:54.000Z",
"last_watched_at": "2014-10-12T17:00:54.000Z",
"plays": 23,
"reset_at": "2019-08-12T17:00:54.000Z",
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
}
}
]
}
}
}
},
"description": "```\n/sync/watched/shows?extended=noseasons\n```",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get watched",
"tags": [
"Sync"
]
}
},
"/sync/watchlist": {
"post": {
"description": "#### 🔒 OAuth Required 😁 Emojis 🔥 VIP Enhanced\n\nAdd one of more items to a user's watchlist. Accepts shows, seasons, episodes and movies. If only a show is passed, only the show itself will be added. If seasons are specified, all of those seasons will be added.\n\n#### Notes\n\nEach watchlist item can optionally accept a `notes` *(255 maximum characters)* field with custom text. The user must be a [**Trakt VIP**](https://trakt.tv/vip) to send `notes`.\n\n#### Limits\n\nIf the user's watchlist limit is exceeded, a `420` HTTP error code is returned. Use the [**/users/settings**](/reference/users/settings) method to get all limits for a user account. In most cases, upgrading to [**Trakt VIP**](https://trakt.tv/vip) will increase the limits.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |",
"operationId": "Add items to watchlist",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"notes": "One of Chritian Bale's most iconic roles.",
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"notes": "I AM THE DANGER!",
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"number": 1
},
{
"number": 2
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"episodes": 2,
"movies": 1,
"seasons": 1,
"shows": 1
},
"existing": {
"episodes": 0,
"movies": 0,
"seasons": 0,
"shows": 0
},
"list": {
"item_count": 5,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
},
"420": {
"description": "",
"headers": {
"X-Account-Limit": {
"schema": {
"type": "string"
}
},
"X-Upgrade-URL": {
"schema": {
"type": "string"
}
},
"X-VIP-User": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add items to watchlist",
"tags": [
"Sync"
]
}
},
"/sync/watchlist/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove one or more items from a user's watchlist.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |",
"operationId": "Remove items from watchlist",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Remove_items_from_collectionBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"episodes": 2,
"movies": 1,
"seasons": 1,
"shows": 1
},
"list": {
"item_count": 0,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove items from watchlist",
"tags": [
"Sync"
]
}
},
"/sync/watchlist/reorder": {
"post": {
"description": "#### 🔒 OAuth Required\n\nReorder all items on a user's watchlist by sending the updated `rank` of list item ids. Use the [**/sync/watchlist**](#reference/sync/get-watchlist) method to get all list item ids.",
"operationId": "Reorder watchlist items",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Reorder_watchlist_itemsBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"list": {
"item_count": 5,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"skipped_ids": [
12
],
"updated": 6
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Reorder watchlist items",
"tags": [
"Sync"
]
}
},
"/sync/watchlist/{type}/{sort}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nReturns all items in a user's watchlist filtered by type.\n\n#### Notes\n\nEach watchlist item contains a `notes` field with text entered by the user.\n\n#### Sorting Headers\n\nBy default, all list items are sorted by `rank` `asc`. We send `X-Applied-Sort-By` and `X-Applied-Sort-How` headers to indicate how the results are actually being sorted.\n\nWe also send `X-Sort-By` and `X-Sort-How` headers which indicate the user's sort preference. Use these to to custom sort the watchlist _**in your app**_ for more advanced sort abilities we can't do in the API. Values for `X-Sort-By` include `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, and `votes`. Values for `X-Sort-How` include `asc` and `desc`.\n\n#### Auto Removal\n\nWhen an item is watched, it will be automatically removed from the watchlist. For shows and seasons, watching 1 episode will remove the entire show or season.\n\n_**The watchlist should not be used as a list of what the user is actively watching.**_\n\nUse a combination of the [**/sync/watched**](/reference/sync/get-watched) and [**/shows/:id/progress**](/reference/shows/watched-progress) methods to get what the user is actively watching.",
"operationId": "Get watchlist",
"parameters": [
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes"
],
"type": "string"
}
},
{
"description": "How to sort (only if type is also sent)",
"example": "rank",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"rank",
"added",
"released",
"title"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt1683084",
"tmdb": 62118,
"trakt": 49,
"tvdb": 2639411
},
"number": 1,
"season": 4,
"title": "Box Cutter"
},
"id": 101,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": null,
"rank": 1,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"episode": {
"ids": {
"imdb": "tt1683095",
"tmdb": 62127,
"trakt": 56,
"tvdb": 4127161
},
"number": 8,
"season": 4,
"title": "Hermanos"
},
"id": 102,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": null,
"rank": 2,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
}
]
}
}
}
},
"description": "```\n/sync/watchlist/episodes\n```",
"headers": {
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get watchlist",
"tags": [
"Sync"
]
}
},
"/users/hidden/{section}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination ✨ Extended Info\n\nGet hidden items for a section. This will return an array of standard media objects. You can optionally limit the `type` of results to return.",
"operationId": "Get hidden items",
"parameters": [
{
"description": "",
"example": "calendar",
"in": "path",
"name": "section",
"required": true,
"schema": {
"enum": [
"calendar",
"progress_watched",
"progress_watched_reset",
"progress_collected",
"recommendations",
"comments"
],
"type": "string"
}
},
{
"description": "Narrow down by element type.",
"in": "query",
"name": "type",
"required": false,
"schema": {
"enum": [
"movie",
"show",
"season",
"user"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"hidden_at": "2015-03-30T23:18:42.000Z",
"show": {
"ids": {
"imdb": "tt0397442",
"slug": "gossip-girl",
"tmdb": 1395,
"trakt": 48,
"tvdb": 80547
},
"title": "Gossip Girl",
"year": 2007
},
"type": "show"
},
{
"hidden_at": "2015-03-30T23:19:33.000Z",
"show": {
"ids": {
"imdb": "tt2365946",
"slug": "bitten",
"tmdb": 60556,
"trakt": 839,
"tvdb": 269550
},
"title": "Bitten",
"year": 2014
},
"type": "show"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get hidden items",
"tags": [
"Users"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nHide items for a specific section. Here's what type of items can hidden for each section.\n\n#### Hideable Media Objects\n\n| Section | Objects |\n|---|---|---|\n| `calendar` | `movie`, `show` |\n| `progress_watched` | `show`, `season` |\n| `progress_collected` | `show`, `season` |\n| `recommendations` | `movie`, `show` |\n| `comments` | `user` |\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `users` | array | Array of `user` objects. |",
"operationId": "Add hidden items",
"parameters": [
{
"description": "",
"example": "calendar",
"in": "path",
"name": "section",
"required": true,
"schema": {
"enum": [
"calendar",
"progress_watched",
"progress_collected",
"recommendations"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Add_hidden_itemsBody"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"movies": 1,
"seasons": 2,
"shows": 2,
"users": 0
},
"not_found": {
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": [],
"users": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add hidden items",
"tags": [
"Users"
]
}
},
"/users/hidden/{section}/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nUnhide items for a specific section. Here's what type of items can unhidden for each section.\n\n#### Unhideable Media Objects\n\n| Section | Objects |\n|---|---|---|\n| `calendar` | `movie`, `show` |\n| `progress_watched` | `show`, `season` |\n| `progress_collected` | `show`, `season` |\n| `recommendations` | `movie`, `show` |\n| `comments` | `user` |\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `users` | array | Array of `user` objects. |",
"operationId": "Remove hidden items",
"parameters": [
{
"description": "",
"example": "calendar",
"in": "path",
"name": "section",
"required": true,
"schema": {
"enum": [
"calendar",
"progress_watched",
"progress_collected",
"recommendations",
"comments"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Add_hidden_itemsBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"movies": 1,
"seasons": 2,
"shows": 2,
"users": 0
},
"not_found": {
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [],
"shows": [],
"users": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove hidden items",
"tags": [
"Users"
]
}
},
"/users/requests": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nList a user's pending follow requests so they can either approve or deny them.",
"operationId": "Get follow requests",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 3,
"requested_at": "2014-09-22T04:23:48.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get follow requests",
"tags": [
"Users"
]
}
},
"/users/requests/following": {
"get": {
"description": "#### 🔒 OAuth Required ✨ Extended Info\n\nList a user's pending following requests that they're waiting for the other user's to approve.",
"operationId": "Get pending following requests",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 3,
"requested_at": "2014-09-22T04:23:48.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get pending following requests",
"tags": [
"Users"
]
}
},
"/users/requests/{id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nDeny a follower using the `id` of the request. If the `id` is not found, was already approved, or was already denied, a `404` error will be returned.",
"operationId": "Deny follow request",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Deny follow request",
"tags": [
"Users"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nApprove a follower using the `id` of the request. If the `id` is not found, was already approved, or was already denied, a `404` error will be returned.",
"operationId": "Approve follow request",
"parameters": [
{
"description": "ID of the follower request.",
"example": "123",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"followed_at": "2014-09-22T05:38:54.083Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Approve follow request",
"tags": [
"Users"
]
}
},
"/users/saved_filters/{section}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination 🔥 VIP Only\n\nGet all saved filters a user has created. The `path` and `query` can be used to construct an API path to retrieve the saved data. Think of this like a dynamically updated list.",
"operationId": "Get saved filters",
"parameters": [
{
"description": "",
"example": "movies",
"in": "path",
"name": "section",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"calendars",
"search"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 101,
"name": "Movies: IMDB + TMDB ratings",
"path": "/movies/recommended/weekly",
"query": "imdb_ratings=6.9-10.0&tmdb_ratings=4.2-10.0",
"rank": 1,
"section": "movies",
"updated_at": "2022-06-15T11:15:06.000Z"
},
{
"id": 102,
"name": "Shows: US + Disney+",
"path": "/shows/popular",
"query": "watchnow=disney_plus&countries=us",
"rank": 2,
"section": "shows",
"updated_at": "2022-06-15T12:15:06.000Z"
},
{
"id": 103,
"name": "On Netflix",
"path": "/calendars/my/shows",
"query": "networks=Netflix",
"rank": 3,
"section": "calendars",
"updated_at": "2022-06-15T13:15:06.000Z"
},
{
"id": 104,
"name": "Action & Adventure",
"path": "/search/movie,show",
"query": "genres=+action,+adventure",
"rank": 4,
"section": "search",
"updated_at": "2022-06-15T14:15:06.000Z"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get saved filters",
"tags": [
"Users"
]
}
},
"/users/settings": {
"get": {
"description": "#### 🔒 OAuth Required\n\nGet the user's settings so you can align your app's experience with what they're used to on the trakt website. A globally unique `uuid` is also returned, which can be used to identify the user locally in your app if needed. However, the `uuid` can't be used to retrieve data from the Trakt API.",
"operationId": "Retrieve settings",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"account": {
"cover_image": "https://walter.trakt.tv/images/movies/000/001/545/fanarts/original/0abb604492.jpg",
"date_format": "mdy",
"time_24hr": false,
"timezone": "America/Los_Angeles"
},
"connections": {
"apple": false,
"dropbox": false,
"facebook": false,
"google": true,
"medium": false,
"microsoft": false,
"slack": false,
"tumblr": false,
"twitter": true
},
"limits": {
"list": {
"count": 5,
"item_count": 250
},
"recommendations": {
"item_count": 50
},
"watchlist": {
"item_count": 250
}
},
"sharing_text": {
"rated": "[item] [stars]",
"watched": "I just watched [item]",
"watching": "I'm watching [item]"
},
"user": {
"about": "Co-founder of trakt.",
"age": 32,
"gender": "male",
"ids": {
"slug": "justin",
"uuid": "b6589fc6ab0dc82cf12099d1c2d40ab994e8410c"
},
"images": {
"avatar": {
"full": "https://secure.gravatar.com/avatar/30c2f0dfbc39e48656f40498aa871e33?r=pg&s=256"
}
},
"joined_at": "2010-09-25T17:49:25.000Z",
"location": "San Diego, CA",
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false,
"vip_og": true,
"vip_years": 5
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Retrieve settings",
"tags": [
"Users"
]
}
},
"/users/{id}": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nGet a user's profile information. If the user is private, info will only be returned if you send OAuth and are either that user or an approved follower. Adding `?extended=vip` will return some additional VIP related fields so you can display the user's Trakt VIP status and year count.",
"operationId": "Get user profile",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_cover_image": "https://walter.trakt.tv/images/movies/000/000/343/fanarts/full/5aab754f58.jpg",
"vip_ep": true,
"vip_og": true,
"vip_years": 5
}
}
}
}
},
"description": "```\n/users/sean?extended=vip\n```",
"headers": {}
}
},
"summary": "Get user profile",
"tags": [
"Users"
]
}
},
"/users/{id}/collection/{type}": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nGet all collected items in a user's collection. A collected item indicates availability to watch digitally or on physical media.\n\nEach `movie` object contains `collected_at` and `updated_at` timestamps. Since users can set custom dates when they collected movies, it is possible for `collected_at` to be in the past. We also include `updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the movie if you see a newer timestamp.\n\nEach `show` object contains `last_collected_at` and `last_updated_at` timestamps. Since users can set custom dates when they collected episodes, it is possible for `last_collected_at` to be in the past. We also include `last_updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the show if you see a newer timestamp.\n\nIf you add `?extended=metadata` to the URL, it will return the additional `media_type`, `resolution`, `hdr`, `audio`, `audio_channels` and '3d' metadata. It will use `null` if the metadata isn't set for an item.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"last_collected_at": "2014-09-01T09:10:11.000Z",
"last_updated_at": "2014-09-01T09:10:11.000Z",
"seasons": [
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 1
},
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10_plus",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10_plus",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 2
}
],
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
},
{
"last_collected_at": "2014-09-01T09:10:11.000Z",
"last_updated_at": "2014-09-01T09:10:11.000Z",
"seasons": [
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 1
},
{
"episodes": [
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 1
},
{
"collected_at": "2014-09-01T09:10:11.000Z",
"metadata": {
"3d": false,
"audio": "aac",
"audio_channels": "5.1",
"hdr": "hdr10",
"media_type": "digital",
"resolution": "hd_720p"
},
"number": 2
}
],
"number": 2
}
],
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
}
}
]
}
}
}
},
"description": "```\n/users/sean/collection/shows?extended=metadata\n```",
"headers": {}
}
},
"summary": "Get collection",
"tags": [
"Users"
]
}
},
"/users/{id}/comments/{comment_type}/{type}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination ✨ Extended Info\n\nReturns the most recently written comments for the user. You can optionally filter by the `comment_type` and media `type` to limit what gets returned.\n\nBy default, only top level comments are returned. Set `?include_replies=true` to return replies in addition to top level comments. Set `?include_replies=only` to return only replies and no top level comments.",
"operationId": "Get comments",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"example": "all",
"in": "path",
"name": "comment_type",
"required": true,
"schema": {
"enum": [
"all",
"reviews",
"shouts"
],
"type": "string"
}
},
{
"description": "",
"example": "all",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"all",
"movies",
"shows",
"seasons",
"episodes",
"lists"
],
"type": "string"
}
},
{
"description": "include comment replies",
"example": "false",
"in": "query",
"name": "include_replies",
"required": false,
"schema": {
"enum": [
"true",
"false",
"only"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": {
"comment": "Great kickoff to a new Batman trilogy!",
"created_at": "2015-04-25T00:14:57.000Z",
"id": 267,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-25T00:14:57.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"movie": {
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
"type": "movie"
},
{
"comment": {
"comment": "Skyler, I AM THE DANGER.",
"created_at": "2015-02-18T06:02:30.000Z",
"id": 199,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-02-18T06:02:30.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 10
}
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"comment": {
"comment": "Kicking off season 1 for a new Batman show.",
"created_at": "2015-04-21T06:53:25.000Z",
"id": 220,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T06:53:25.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 8
}
},
"season": {
"ids": {
"tmdb": 60394,
"trakt": 3958,
"tvdb": 274431
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "season"
},
{
"comment": {
"comment": "Is this the OC?",
"created_at": "2015-04-21T15:42:31.000Z",
"id": 229,
"likes": 0,
"parent_id": 0,
"replies": 1,
"review": false,
"spoiler": false,
"updated_at": "2015-04-21T15:42:31.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": 7
}
},
"episode": {
"ids": {
"imdb": "tt3216414",
"tmdb": 975968,
"trakt": 63958,
"tvdb": 4768720
},
"number": 1,
"season": 1,
"title": "Jim Gordon"
},
"show": {
"ids": {
"imdb": "tt3749900",
"slug": "gotham",
"tmdb": 60708,
"trakt": 869,
"tvdb": 274431
},
"title": "Gotham",
"year": 2014
},
"type": "episode"
},
{
"comment": {
"comment": "May the 4th be with you!",
"created_at": "2014-12-08T17:34:51.000Z",
"id": 268,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2014-12-08T17:34:51.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin N.",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
},
"list": {
"allow_comments": true,
"comment_count": 0,
"description": "The complete Star Wars saga!",
"display_numbers": false,
"ids": {
"slug": "star-wars",
"trakt": 51
},
"item_count": 8,
"likes": 0,
"name": "Star Wars",
"privacy": "public",
"updated_at": "2015-04-22T22:01:39.000Z"
},
"type": "list"
}
]
}
}
}
},
"description": "```\n/users/sean/comments\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get comments",
"tags": [
"Users"
]
}
},
"/users/{id}/follow": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nUnfollow someone you already follow.",
"operationId": "Unfollow this user",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Unfollow this user",
"tags": [
"Users"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nIf the user has a private profile, the follow request will require approval (`approved_at` will be null). If a user is public, they will be followed immediately (`approved_at` will have a date).\n\n**Note:** If this user is already being followed, a `409` HTTP status code will returned.",
"operationId": "Follow this user",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"approved_at": "2014-11-15T09:41:34.704Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
}
}
}
},
"description": "Created",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Follow this user",
"tags": [
"Users"
]
}
},
"/users/{id}/followers": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nReturns all followers including when the relationship began.",
"operationId": "Get followers",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"followed_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"followed_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get followers",
"tags": [
"Users"
]
}
},
"/users/{id}/following": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nReturns all user's they follow including when the relationship began.",
"operationId": "Get following",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"followed_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"followed_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get following",
"tags": [
"Users"
]
}
},
"/users/{id}/friends": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nReturns all friends for a user including when the relationship began. Friendship is a 2 way relationship where each user follows the other.",
"operationId": "Get friends",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"friends_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"friends_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get friends",
"tags": [
"Users"
]
}
},
"/users/{id}/history/{type}/{item_id}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination ✨ Extended Info\n\nReturns movies and episodes that a user has watched, sorted by most recent. You can optionally limit the `type` to `movies` or `episodes`. The `id` _(64-bit integer)_ in each history item uniquely identifies the event and can be used to remove individual events by using the [**/sync/history/remove**](#reference/sync/remove-from-history/get-watched-history) method. The `action` will be set to `scrobble`, `checkin`, or `watch`.\n\nSpecify a `type` and trakt `item_id` to limit the history for just that item. If the `item_id` is valid, but there is no history, an empty array will be returned.\n\n| Example URL | Returns watches for... |\n|---|---|\n| `/history/movies/12601` | TRON: Legacy |\n| `/history/shows/1388` | All episodes of Breaking Bad |\n| `/history/seasons/3950` | All episodes of Breaking Bad: Season 1 |\n| `/history/episodes/73482` | Only episode 1 for Breaking Bad: Season 1 |",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes"
],
"type": "string"
}
},
{
"description": "Trakt ID for a specific item.",
"example": "123",
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "Starting date.",
"example": "2016-06-01T00:00:00.000Z",
"in": "query",
"name": "start_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Ending date.",
"example": "2016-07-01T23:59:59.000Z",
"in": "query",
"name": "end_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"action": "scrobble",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397629,
"trakt": 251,
"tvdb": 797571
},
"number": 1,
"season": 2,
"title": "Pawnee Zoo"
},
"id": 1982346,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
},
{
"action": "checkin",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397627,
"trakt": 252,
"tvdb": 1088031
},
"number": 2,
"season": 2,
"title": "The Stakeout"
},
"id": 1982347,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
},
{
"action": "watch",
"episode": {
"ids": {
"imdb": null,
"tmdb": 397642,
"trakt": 253,
"tvdb": 1088041
},
"number": 3,
"season": 2,
"title": "Beauty Pageant"
},
"id": 1982348,
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
},
"type": "episode",
"watched_at": "2014-03-31T09:28:53.000Z"
}
]
}
}
}
},
"description": "```\n/users/sean/history/episodes\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get watched history",
"tags": [
"Users"
]
}
},
"/users/{id}/likes/{type}": {
"get": {
"description": "#### 🔒 OAuth Optional 📄 Pagination\n\nGet items a user likes. This will return an array of standard media objects. You can optionally limit the `type` of results to return.\n\n#### Comment Media Objects\n\nIf you add `?extended=comments` to the URL, it will return media objects for each comment like.\n\n**Note:** This returns a lot of data, so please only use this extended parameter if you actually need it!",
"operationId": "Get likes",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"comments",
"lists"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"liked_at": "2015-03-31T23:18:42.000Z",
"list": {
"allow_comments": false,
"comment_count": 0,
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 5,
"likes": 0,
"name": "Star Wars in NEW machete order",
"privacy": "private",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
"type": "list"
}
]
}
}
}
},
"description": "```\n/users/sean/likes/lists\n```",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get likes",
"tags": [
"Users"
]
}
},
"/users/{id}/lists": {
"get": {
"description": "#### 🔓 OAuth Optional 😁 Emojis\n\nReturns all personal lists for a user. Use the [**/users/:id/lists/:list_id/items**](#reference/users/list-items) method to get the actual items a specific list contains.",
"operationId": "Get a user's personal lists",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 5,
"likes": 0,
"name": "Star Wars in machete order",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z"
},
{
"allow_comments": true,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "These suck, but in a good way!",
"display_numbers": false,
"ids": {
"slug": "vampires-ftw",
"trakt": 52
},
"item_count": 5,
"likes": 0,
"name": "Vampires FTW",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z"
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a user's personal lists",
"tags": [
"Users"
]
},
"post": {
"description": "#### 🔒 OAuth Required 🔥 VIP Enhanced\n\nCreate a new personal list. The `name` is the only required field, but the other info is recommended to ask for.\n\n#### Limits\n\nIf the user's list limit is exceeded, a `420` HTTP error code is returned. Use the [**/users/settings**](/reference/users/settings) method to get all limits for a user account. In most cases, upgrading to [**Trakt VIP**](https://trakt.tv/vip) will increase the limits.\n\n#### JSON POST Data\n\n| Key | Type | Default | Value |\n|---|---|---|---|\n| `name` <span style=\"color:red;\">*</a> | string | | Name of the list. |\n| `description` | string | | Description for this list. |\n| `privacy` | string | `private` | `private`, `friends`, `public` |\n| `display_numbers` | boolean | `false` | Should each item be numbered? |\n| `allow_comments` | boolean | `true` | Are comments allowed? |\n| `sort_by` | string | `rank` | `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, `votes`, `my_rating`, `random`, `watched`, `collected` |\n| `sort_how` | string | `asc` | `asc`, `desc` |",
"operationId": "Create personal list",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"allow_comments": true,
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"name": "Star Wars in machete order",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc"
},
"properties": {
"allow_comments": {
"type": "boolean"
},
"description": {
"type": "string"
},
"display_numbers": {
"type": "boolean"
},
"name": {
"type": "string"
},
"privacy": {
"type": "string"
},
"sort_by": {
"type": "string"
},
"sort_how": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"allow_comments": true,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 0,
"likes": 0,
"name": "Star Wars in machete order",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z"
}
}
}
}
},
"description": "Created",
"headers": {}
},
"420": {
"description": "",
"headers": {
"X-Account-Limit": {
"schema": {
"type": "string"
}
},
"X-Upgrade-URL": {
"schema": {
"type": "string"
}
},
"X-VIP-User": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Create personal list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/collaborations": {
"get": {
"description": "#### 🔓 OAuth Optional\n\nReturns all lists a user can collaborate on. This gives full access to add, remove, and re-order list items. It essentially works just like a list owned by the user, just make sure to use the correct list owner `user` when building the API URLs.",
"operationId": "Get all lists a user can collaborate on",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"allow_comments": true,
"comment_count": 0,
"created_at": "2022-02-16T21:48:18.000Z",
"description": "Hey everyone, add your favorite movies we've all enjoyed together over the years!",
"display_numbers": false,
"ids": {
"slug": "our-favorite-movies",
"trakt": 2612438
},
"item_count": 6,
"likes": 1,
"name": "Our Favorite Movies",
"privacy": "private",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2022-06-10T21:55:05.000Z",
"user": {
"ids": {
"slug": "sean",
"trakt": 2
},
"name": "Sean",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all lists a user can collaborate on",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/reorder": {
"post": {
"description": "#### 🔒 OAuth Required\n\nReorder all lists by sending the updated `rank` of list ids. Use the [**/users/:id/lists**](#reference/users/lists) method to get all list ids.",
"operationId": "Reorder a user's lists",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"rank": [
823,
224,
88768,
356456,
245,
2,
890
]
},
"properties": {
"rank": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"skipped_ids": [
2
],
"updated": 6
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Reorder a user's lists",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nRemove a personal list and all items it contains.",
"operationId": "Delete a user's personal list",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Delete a user's personal list",
"tags": [
"Users"
]
},
"get": {
"description": "#### 🔓 OAuth Optional 😁 Emojis\n\nReturns a single personal list. Use the [**/users/:id/lists/:list_id/items**](#reference/users/list-items) method to get the actual items this list contains.",
"operationId": "Get personal list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"allow_comments": true,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 5,
"likes": 0,
"name": "Star Wars in machete order",
"privacy": "public",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
}
}
}
},
"description": "OK",
"headers": {
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get personal list",
"tags": [
"Users"
]
},
"put": {
"description": "#### 🔒 OAuth Required\n\nUpdate a personal list by sending 1 or more parameters. If you update the list name, the original slug will still be retained so existing references to this list won't break.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|---|\n| `name` | string | Name of the list. |\n| `description` | string | Description for this list. |\n| `privacy` | string | `private`, `friends`, `public` |\n| `display_numbers` | boolean | Should each item be numbered? |\n| `allow_comments` | boolean | Are comments allowed? |\n| `sort_by` | string | `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, `votes`, `my_rating`, `random`, `watched`, `collected` |\n| `sort_how` | string | `asc`, `desc` |",
"operationId": "Update personal list",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"display_numbers": false,
"name": "Star Wars in NEW machete order",
"privacy": "private",
"sort_by": "rank",
"sort_how": "asc"
},
"properties": {
"display_numbers": {
"type": "boolean"
},
"name": {
"type": "string"
},
"privacy": {
"type": "string"
},
"sort_by": {
"type": "string"
},
"sort_how": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"allow_comments": false,
"comment_count": 0,
"created_at": "2014-10-11T17:00:54.000Z",
"description": "Next time you want to introduce someone to Star Wars for the first time, watch the films with them in this order: IV, V, II, III, VI.",
"display_numbers": true,
"ids": {
"slug": "star-wars-in-machete-order",
"trakt": 55
},
"item_count": 5,
"likes": 0,
"name": "Star Wars in NEW machete order",
"privacy": "private",
"sort_by": "rank",
"sort_how": "asc",
"type": "personal",
"updated_at": "2014-10-11T17:00:54.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Update personal list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/comments/{sort}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination 😁 Emojis\n\nReturns all top level comments for a list. By default, the `newest` comments are returned first. Other sorting options include `oldest`, most `likes`, and most `replies`.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "how to sort",
"example": "newest",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"newest",
"oldest",
"likes",
"replies"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"comment": "Can't wait to watch everything on this epic list!",
"created_at": "2011-03-25T22:35:17.000Z",
"id": 8,
"likes": 0,
"parent_id": 0,
"replies": 0,
"review": false,
"spoiler": false,
"updated_at": "2011-03-25T22:35:17.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
},
"user_stats": {
"completed_count": 1,
"play_count": 1,
"rating": null
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all list comments",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/items": {
"post": {
"description": "#### 🔒 OAuth Required 😁 Emojis 🔥 VIP Enhanced\n\nAdd one or more items to a personal list. Items can be movies, shows, seasons, episodes, or people.\n\n#### Notes\n\nEach list item can optionally accept a `notes` *(255 maximum characters)* field with custom text. The user must be a [**Trakt VIP**](https://trakt.tv/vip) to send `notes`.\n\n#### Limits\n\nIf the user's list item limit is exceeded, a `420` HTTP error code is returned. Use the [**/users/settings**](/reference/users/settings) method to get all limits for a user account. In most cases, upgrading to [**Trakt VIP**](https://trakt.tv/vip) will increase the limits.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n| `people` | array | Array of `person` objects. |",
"operationId": "Add items to personal list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"movies": [
{
"ids": {
"trakt": 1
},
"notes": "Amazing movie!"
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"people": [
{
"ids": {
"imdb": "nm0000313",
"slug": "jeff-bridges",
"tmdb": 1229,
"trakt": 2
},
"name": "Jeff Bridges"
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"trakt": 1
}
},
{
"ids": {
"trakt": 1
},
"notes": "Best season of this show, don't bother watching the rest.",
"seasons": [
{
"number": 1
}
]
},
{
"ids": {
"trakt": 1
},
"seasons": [
{
"episodes": [
{
"number": 1
},
{
"number": 2
}
],
"number": 1
}
]
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"people": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"trakt": {
"type": "number"
}
},
"type": "object"
},
"notes": {
"type": "string"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"added": {
"episodes": 2,
"movies": 1,
"people": 1,
"seasons": 1,
"shows": 1
},
"existing": {
"episodes": 0,
"movies": 0,
"people": 0,
"seasons": 0,
"shows": 0
},
"list": {
"item_count": 6,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"people": [],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "Created",
"headers": {}
},
"420": {
"description": "",
"headers": {
"X-Account-Limit": {
"schema": {
"type": "string"
}
},
"X-Upgrade-URL": {
"schema": {
"type": "string"
}
},
"X-VIP-User": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Add items to personal list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/items/remove": {
"post": {
"description": "#### 🔒 OAuth Required\n\nRemove one or more items from a personal list.\n\n#### JSON POST Data\n\n| Key | Type | Value |\n|---|---|---|\n| `movies` | array | Array of `movie` objects. (see examples →) |\n| `shows` | array | Array of `show` objects. |\n| `seasons` | array | Array of `season` objects. |\n| `episodes` | array | Array of `episode` objects. |\n| `people` | array | Array of `person` objects. |",
"operationId": "Remove items from personal list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"movies": [
{
"ids": {
"trakt": 1
}
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"people": [
{
"ids": {
"imdb": "nm0000313",
"slug": "jeff-bridges",
"tmdb": 1229,
"trakt": 2
},
"name": "Jeff Bridges"
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"trakt": 1
}
},
{
"ids": {
"trakt": 1
},
"seasons": [
{
"number": 1
}
]
},
{
"ids": {
"trakt": 1
},
"seasons": [
{
"episodes": [
{
"number": 1
},
{
"number": 2
}
],
"number": 1
}
]
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"trakt": {
"type": "number"
}
},
"type": "object"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"people": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"trakt": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"deleted": {
"episodes": 2,
"movies": 1,
"people": 1,
"seasons": 1,
"shows": 1
},
"list": {
"item_count": 0,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"not_found": {
"episodes": [],
"movies": [
{
"ids": {
"imdb": "tt0000111"
}
}
],
"people": [],
"seasons": [],
"shows": []
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove items from personal list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/items/reorder": {
"post": {
"description": "#### 🔒 OAuth Required\n\nReorder all items on a list by sending the updated `rank` of list item ids. Use the [**/users/:id/lists/:list_id/items**](#reference/users/list-items) method to get all list item ids.",
"operationId": "Reorder items on a list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Reorder_watchlist_itemsBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"list": {
"item_count": 6,
"updated_at": "2022-04-27T21:40:41.000Z"
},
"skipped_ids": [
12
],
"updated": 6
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Reorder items on a list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/items/{type}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nGet all items on a personal list. Items can be a `movie`, `show`, `season`, `episode`, or `person`. You can optionally specify the `type` parameter with a single value or comma delimited string for multiple item types.\n\n#### Notes\n\nEach list item contains a `notes` field with text entered by the user.\n\n#### Sorting Headers\n\nAll list items are sorted by ascending `rank`. We also send `X-Sort-By` and `X-Sort-How` headers which can be used to custom sort the list _**in your app**_ based on the user's preference. Values for `X-Sort-By` include `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, `votes`, `my_rating`, `random`, `watched`, and `collected`. Values for `X-Sort-How` include `asc` and `desc`.",
"operationId": "Get items on a personal list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movie",
"show",
"season",
"episode",
"person"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 101,
"listed_at": "2014-06-16T06:07:12.000Z",
"movie": {
"ids": {
"imdb": "tt0076759",
"slug": "star-wars-episode-iv-a-new-hope-1977",
"tmdb": 11,
"trakt": 12
},
"title": "Star Wars: Episode IV - A New Hope",
"year": 1977
},
"notes": "You are part of the rebel alliance and a spy!",
"rank": 1,
"type": "movie"
},
{
"id": 102,
"listed_at": "2014-06-16T06:07:12.000Z",
"notes": null,
"rank": 2,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"type": "show"
},
{
"id": 103,
"listed_at": "2014-06-16T06:07:12.000Z",
"notes": null,
"rank": 3,
"season": {
"ids": {
"tmdb": 3572,
"tvdb": 30272
},
"number": 1
},
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "season"
},
{
"episode": {
"ids": {
"imdb": null,
"tmdb": 62133,
"trakt": 2,
"tvdb": 3859791
},
"number": 2,
"season": 0,
"title": "Wedding Day"
},
"id": 104,
"listed_at": "2014-06-17T06:52:03.000Z",
"notes": null,
"rank": 4,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"id": 105,
"listed_at": "2014-06-17T06:52:03.000Z",
"notes": null,
"person": {
"ids": {
"imdb": "nm1330560",
"slug": "garrett-hedlund",
"tmdb": 9828,
"trakt": 1
},
"name": "Garrett Hedlund"
},
"rank": 5,
"type": "person"
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Private-User": {
"schema": {
"type": "string"
}
},
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get items on a personal list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/like": {
"delete": {
"description": "#### 🔒 OAuth Required\n\nRemove a like on a list.",
"operationId": "Remove like on a list",
"parameters": [
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Remove like on a list",
"tags": [
"Users"
]
},
"post": {
"description": "#### 🔒 OAuth Required\n\nVotes help determine popular lists. Only one like is allowed per list per user.",
"operationId": "Like a list",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Like a list",
"tags": [
"Users"
]
}
},
"/users/{id}/lists/{list_id}/likes": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination\n\nReturns all users who liked a list.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Trakt ID or Trakt slug",
"example": "star-wars-in-machete-order",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "sean"
},
"name": "Sean Rudford",
"private": false,
"username": "sean",
"vip": true,
"vip_ep": false
}
},
{
"liked_at": "2014-09-01T09:10:11.000Z",
"user": {
"ids": {
"slug": "justin"
},
"name": "Justin Nemeth",
"private": false,
"username": "justin",
"vip": true,
"vip_ep": false
}
}
]
}
}
}
},
"description": "OK",
"headers": {
"X-Pagination-Item-Count": {
"schema": {
"type": "string"
}
},
"X-Pagination-Limit": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page": {
"schema": {
"type": "string"
}
},
"X-Pagination-Page-Count": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get all users who liked a list",
"tags": [
"Users"
]
}
},
"/users/{id}/ratings/{type}/{rating}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info\n\nGet a user's ratings filtered by `type`. You can optionally filter for a specific `rating` between 1 and 10. Send a comma separated string for `rating` if you need multiple ratings.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes",
"all"
],
"type": "string"
}
},
{
"description": "Filter for a specific rating.",
"example": "9",
"in": "path",
"name": "rating",
"required": true,
"schema": {
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10"
],
"type": "integer"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt1683084",
"tmdb": 62118,
"trakt": 49,
"tvdb": 2639411
},
"number": 1,
"season": 4,
"title": "Box Cutter"
},
"rated_at": "2014-09-01T09:10:11.000Z",
"rating": 10,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"episode": {
"ids": {
"imdb": "tt1683095",
"tmdb": 62127,
"trakt": 56,
"tvdb": 4127161
},
"number": 8,
"season": 4,
"title": "Hermanos"
},
"rated_at": "2014-09-01T09:10:11.000Z",
"rating": 10,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
}
]
}
}
}
},
"description": "```\n/users/sean/ratings/episodes\n```",
"headers": {}
}
},
"summary": "Get ratings",
"tags": [
"Users"
]
}
},
"/users/{id}/recommendations/{type}/{sort}": {
"get": {
"description": "#### 🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nReturns the top 50 items a user personally recommendeds to others. These recommendations are used to enchance Trakt's social recommendation algorithm. Apps should encourage user's to build their personal recommendations so the algorithm keeps getting better.\n\n#### Notes\n\nEach recommendation contains a `notes` field explaining why the user recommended the item.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "How to sort (only if type is also sent)",
"example": "rank",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"rank",
"added",
"released",
"title"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"id": 101,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": "I AM THE DANGER!",
"rank": 1,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "show"
},
{
"id": 102,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": "Atmospheric for days.",
"rank": 2,
"show": {
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"title": "The Walking Dead",
"year": 2010
},
"type": "show"
}
]
}
}
}
},
"description": "```\n/users/justin/recommendations/shows\n```",
"headers": {
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"oauth2": []
}
],
"summary": "Get personal recommendations",
"tags": [
"Users"
]
}
},
"/users/{id}/stats": {
"get": {
"description": "#### 🔓 OAuth Optional\n\nReturns stats about the movies, shows, and episodes a user has watched, collected, and rated.",
"operationId": "Get stats",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"episodes": {
"collected": 117,
"comments": 14,
"minutes": 17330,
"plays": 552,
"ratings": 64,
"watched": 534
},
"movies": {
"collected": 933,
"comments": 28,
"minutes": 15650,
"plays": 155,
"ratings": 256,
"watched": 114
},
"network": {
"followers": 4,
"following": 11,
"friends": 1
},
"ratings": {
"distribution": {
"1": 18,
"2": 1,
"3": 4,
"4": 1,
"5": 10,
"6": 9,
"7": 37,
"8": 37,
"9": 57,
"10": 215
},
"total": 389
},
"seasons": {
"comments": 1,
"ratings": 6
},
"shows": {
"collected": 7,
"comments": 20,
"ratings": 63,
"watched": 16
}
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get stats",
"tags": [
"Users"
]
}
},
"/users/{id}/watched/{type}": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nReturns all movies or shows a user has watched sorted by most plays.\n\nIf `type` is set to _shows_ and you add `?extended=noseasons` to the URL, it won't return season or episode info.\n\nEach `movie` and `show` object contains `last_watched_at` and `last_updated_at` timestamps. Since users can set custom dates when they watched movies and episodes, it is possible for `last_watched_at` to be in the past. We also include `last_updated_at` to help sync Trakt data with your app. Cache this timestamp locally and only re-process the movies and shows if you see a newer timestamp.\n\nEach `show` object contains a `reset_at` timestamp. If not `null`, this is when the user started re-watching the show. Your app can adjust the progress by ignoring episodes with a `last_watched_at` prior to the `reset_at`.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"last_updated_at": "2014-10-11T17:00:54.000Z",
"last_watched_at": "2014-10-11T17:00:54.000Z",
"plays": 56,
"reset_at": null,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
}
},
{
"last_updated_at": "2014-10-12T17:00:54.000Z",
"last_watched_at": "2014-10-12T17:00:54.000Z",
"plays": 23,
"reset_at": "2019-10-12T17:00:54.000Z",
"show": {
"ids": {
"imdb": "tt1266020",
"slug": "parks-and-recreation",
"tmdb": 8592,
"trakt": 4,
"tvdb": 84912
},
"title": "Parks and Recreation",
"year": 2009
}
}
]
}
}
}
},
"description": "```\n/users/sean/watched/shows?extended=noseasons\n```",
"headers": {}
}
},
"summary": "Get watched",
"tags": [
"Users"
]
}
},
"/users/{id}/watching": {
"get": {
"description": "#### 🔓 OAuth Optional ✨ Extended Info\n\nReturns a movie or episode if the user is currently watching something. If they are not, it returns no data and a `204` HTTP status code.",
"operationId": "Get watching",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"action": "checkin",
"expires_at": "2014-10-23T08:36:02.000Z",
"movie": {
"ids": {
"imdb": "tt1650062",
"slug": "super-8-2011",
"tmdb": 37686,
"trakt": 2
},
"title": "Super 8",
"year": 2011
},
"started_at": "2014-10-23T06:44:02.000Z",
"type": "movie"
}
}
}
}
},
"description": "Currently watching a `movie`.",
"headers": {}
},
"204": {
"description": "Not watching anything.",
"headers": {}
}
},
"summary": "Get watching",
"tags": [
"Users"
]
}
},
"/users/{id}/watchlist/{type}/{sort}": {
"get": {
"description": "#### 🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info 😁 Emojis\n\nReturns all items in a user's watchlist filtered by type.\n\n#### Notes\n\nEach watchlist item contains a `notes` field with text entered by the user.\n\n#### Sorting Headers\n\nBy default, all list items are sorted by `rank` `asc`. We send `X-Applied-Sort-By` and `X-Applied-Sort-How` headers to indicate how the results are actually being sorted.\n\nWe also send `X-Sort-By` and `X-Sort-How` headers which indicate the user's sort preference. Use these to to custom sort the watchlist _**in your app**_ for more advanced sort abilities we can't do in the API. Values for `X-Sort-By` include `rank`, `added`, `title`, `released`, `runtime`, `popularity`, `percentage`, and `votes`. Values for `X-Sort-How` include `asc` and `desc`.\n\n#### Auto Removal\n\nWhen an item is watched, it will be automatically removed from the watchlist. For shows and seasons, watching 1 episode will remove the entire show or season.\n\n_**The watchlist should not be used as a list of what the user is actively watching.**_\n\nUse a combination of the [**/sync/watched**](/reference/sync/get-watched) and [**/shows/:id/progress**](/reference/shows/watched-progress) methods to get what the user is actively watching.",
"parameters": [
{
"description": "User slug",
"example": "sean",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter for a specific item type",
"example": "movies",
"in": "path",
"name": "type",
"required": true,
"schema": {
"enum": [
"movies",
"shows",
"seasons",
"episodes"
],
"type": "string"
}
},
{
"description": "How to sort (only if type is also sent)",
"example": "rank",
"in": "path",
"name": "sort",
"required": true,
"schema": {
"enum": [
"rank",
"added",
"released",
"title"
],
"type": "string"
}
},
{
"description": "e.g. 2",
"example": "2",
"in": "header",
"name": "trakt-api-version",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "e.g. [client_id]",
"example": "[client_id]",
"in": "header",
"name": "trakt-api-key",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": [
{
"episode": {
"ids": {
"imdb": "tt1683084",
"tmdb": 62118,
"trakt": 49,
"tvdb": 2639411
},
"number": 1,
"season": 4,
"title": "Box Cutter"
},
"id": 101,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": null,
"rank": 1,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
},
{
"episode": {
"ids": {
"imdb": "tt1683095",
"tmdb": 62127,
"trakt": 56,
"tvdb": 4127161
},
"number": 8,
"season": 4,
"title": "Hermanos"
},
"id": 102,
"listed_at": "2014-09-01T09:10:11.000Z",
"notes": null,
"rank": 2,
"show": {
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
"type": "episode"
}
]
}
}
}
},
"description": "```\n/users/sean/watchlist/episodes\n```",
"headers": {
"X-Private-User": {
"schema": {
"type": "string"
}
},
"X-Sort-By": {
"schema": {
"type": "string"
}
},
"X-Sort-How": {
"schema": {
"type": "string"
}
}
}
}
},
"summary": "Get watchlist",
"tags": [
"Users"
]
}
}
},
"components": {
"requestBodies": {
"Add_hidden_itemsBody": {
"content": {
"application/json": {
"schema": {
"example": {
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"trakt": 1337
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3
}
],
"title": "The Walking Dead",
"year": 2010
}
]
},
"properties": {
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"trakt": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"Remove_items_from_collectionBody": {
"content": {
"application/json": {
"schema": {
"example": {
"episodes": [
{
"ids": {
"imdb": "tt007404",
"tmdb": 422183,
"trakt": 1061,
"tvdb": 1555111
}
}
],
"movies": [
{
"ids": {
"imdb": "tt0372784",
"slug": "batman-begins-2005",
"tmdb": 272,
"trakt": 1
},
"title": "Batman Begins",
"year": 2005
},
{
"ids": {
"imdb": "tt0000111"
}
}
],
"seasons": [
{
"ids": {
"tmdb": 81266,
"trakt": 140912,
"tvdb": 703353
}
}
],
"shows": [
{
"ids": {
"imdb": "tt0903747",
"slug": "breaking-bad",
"tmdb": 1396,
"trakt": 1,
"tvdb": 81189
},
"title": "Breaking Bad",
"year": 2008
},
{
"ids": {
"imdb": "tt1520211",
"slug": "the-walking-dead",
"tmdb": 1402,
"trakt": 2,
"tvdb": 153021
},
"seasons": [
{
"number": 3
}
],
"title": "The Walking Dead",
"year": 2010
},
{
"ids": {
"imdb": "tt0804503",
"slug": "mad-men",
"tmdb": 1104,
"trakt": 4,
"tvdb": 80337
},
"seasons": [
{
"episodes": [
{
"number": 1
},
{
"number": 2
}
],
"number": 1
}
],
"title": "Mad Men",
"year": 2007
}
]
},
"properties": {
"episodes": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"movies": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"ids"
],
"type": "object"
},
"type": "array"
},
"seasons": {
"items": {
"properties": {
"ids": {
"properties": {
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"shows": {
"items": {
"properties": {
"ids": {
"properties": {
"imdb": {
"type": "string"
},
"slug": {
"type": "string"
},
"tmdb": {
"type": "number"
},
"trakt": {
"type": "number"
},
"tvdb": {
"type": "number"
}
},
"type": "object"
},
"seasons": {
"items": {
"properties": {
"episodes": {
"items": {
"properties": {
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"number": {
"type": "number"
}
},
"required": [
"number"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"year": {
"type": "number"
}
},
"required": [
"title",
"year",
"ids",
"seasons"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
}
},
"Reorder_watchlist_itemsBody": {
"content": {
"application/json": {
"schema": {
"example": {
"rank": [
923,
324,
98768,
456456,
345,
12,
990
]
},
"properties": {
"rank": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
}
}
}
}
},
"schemas": {
"Add_Hidden_Items": {},
"Add_List_Items": {},
"Add_Ratings": {},
"Add_to_Collection": {},
"Add_to_History": {},
"Add_to_Personal_Recommendations_-_BETA": {},
"Add_to_Watchlist": {},
"Aliases": {},
"All_DVD": {},
"All_Movies": {},
"All_New_Shows": {},
"All_Season_Premieres": {},
"All_Shows": {},
"Anticipated": {},
"Approve_or_Deny_Follower_Requests": {},
"Authorize": {},
"Box_Office": {},
"Certifications": {},
"Checkin": {},
"Collaborations": {},
"Collected": {},
"Collection": {},
"Collection_Progress": {},
"Comment": {},
"Comments": {},
"Device_Code": {},
"Follow": {},
"Follower_Requests": {},
"Followers": {},
"Following": {},
"Following_Requests": {},
"Friends": {},
"Get_Collection": {},
"Get_History": {},
"Get_Personal_Recommendations_-_BETA": {},
"Get_Ratings": {},
"Get_Token": {},
"Get_Watched": {},
"Get_Watchlist": {},
"Hidden_Items": {},
"Hide_Movie": {},
"Hide_Show": {},
"History": {},
"ID_Lookup": {},
"Item": {},
"Last_Activities": {},
"Last_Episode": {},
"Like": {},
"Likes": {},
"List": {},
"List_Comments": {},
"List_Items": {},
"List_Like": {},
"List_Likes": {},
"Lists": {},
"Movies": {},
"My_DVD": {},
"My_Movies": {},
"My_New_Shows": {},
"My_Season_Premieres": {},
"My_Shows": {},
"Next_Episode": {},
"Pause": {},
"People": {},
"Personal_Recommendations_-_BETA": {},
"Playback": {},
"Played": {},
"Popular": {},
"Profile": {},
"Ratings": {},
"Recent": {},
"Recommended": {},
"Refresh_Token": {},
"Related": {},
"Releases": {},
"Remove_Hidden_Items": {},
"Remove_List_Items": {},
"Remove_Playback": {},
"Remove_Ratings": {},
"Remove_from_Collection": {},
"Remove_from_History": {},
"Remove_from_Personal_Recommendations_-_BETA": {},
"Remove_from_Watchlist": {},
"Reorder_List_Items": {},
"Reorder_Lists": {},
"Reorder_Personal_Recommendations_-_BETA": {},
"Reorder_Watchlist": {},
"Replies": {},
"Reset_Watched_Progress": {},
"Revoke_Token": {},
"Saved_Filters": {},
"Season": {},
"Settings": {},
"Shows": {},
"Start": {},
"Stats": {},
"Stop": {},
"Studios": {},
"Summary": {},
"Text_Query": {},
"Translations": {},
"Trending": {},
"Updated_IDs": {},
"Updates": {},
"Watched": {},
"Watched_Progress": {},
"Watching": {},
"Watchlist": {}
},
"securitySchemes": {
"oauth2": {
"flows": {
"authorizationCode": {
"authorizationUrl": "/",
"scopes": {},
"tokenUrl": "/"
}
},
"type": "oauth2"
}
}
}
}