Trakt API
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
More 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.
Make sure to check out the Required Headers and Authentication sections for more info on what needs to be sent with each API call. Also check out the Terminology section insight into the features Trakt supports.
Create an App
To use the Trakt API, you'll need to create a new API app.
Stay Connected
API discussion and bugs should be posted in the GitHub Developer Forum and watch the repository if you'd like to get notifications. Make sure to follow our API Blog and @traktapi on Twitter too.
API URL
The API should always be accessed over SSL.
https://api.trakt.tvIf 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://api-staging.trakt.tvVerbs
The API uses restful verbs.
| Verb | Description |
|---|---|
GET | Select one or more items. Success returns 200 status code. |
POST | Create a new item. Success returns 201 status code. |
PUT | Update an item. Success returns 200 status code. |
DELETE | Delete an item. Success returns 200 or 204 status code. |
Status Codes
The API will respond with one of the following HTTP status codes.
| Code | Description |
|---|---|
200 | Success |
201 | Success - new resource created (POST) |
204 | Success - no content to return (DELETE) |
400 | Bad Request - request couldn't be parsed |
401 | Unauthorized - OAuth must be provided |
403 | Forbidden - invalid API key or unapproved app |
404 | Not Found - method exists, but no record found |
405 | Method Not Found - method doesn't exist |
409 | Conflict - resource already created |
412 | Precondition Failed - use application/json content type |
420 | Account Limit Exceeded - list count, item count, etc |
422 | Unprocessable Entity - validation errors |
423 | Locked User Account - have the user contact support |
426 | VIP Only - user must upgrade to VIP |
429 | Rate Limit Exceeded |
500 | Server Error - please open a support ticket |
502 | Service Unavailable - server overloaded (try again in 30s) |
503 | Service Unavailable - server overloaded (try again in 30s) |
504 | Service Unavailable - server overloaded (try again in 30s) |
520 | Service Unavailable - Cloudflare error |
521 | Service Unavailable - Cloudflare error |
522 | Service Unavailable - Cloudflare error |
Required Headers
You'll need to send some headers when making API calls to identify your application, set the version and set the content type to JSON.
| Header | Value | |
|---|---|---|
Content-type * | application/json | |
trakt-api-key * | Your client_id listed under your Trakt applications. | |
trakt-api-version * | 2 | API version to use. |
All 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.
Your OAuth library should take care of sending the auth headers for you, but for reference here's how the Bearer token should be sent.
| Header | Value |
|---|---|
Authorization | Bearer [access_token] |
Rate Limiting
All 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.
| Header | Value |
|---|---|
X-Ratelimit | {"name":"UNAUTHED_API_GET_LIMIT","period":300,"limit":1000,"remaining":0,"until":"2020-10-10T00:24:00Z"} |
Retry-After | 10 |
Here 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.
| Name | Verb | Methods | Limit |
|---|---|---|---|
AUTHED_API_POST_LIMIT | POST, PUT, DELETE | all | 1 call per second… |
Endpoints 183
Authentication - OAuth
- GETAuthorize Application
/oauth/authorize?response_type=code&client_id= &redirect_uri= &state=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… - POSTRevoke an access_token
/oauth/revokeAn 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… - POSTExchange refresh_token for access_token
/oauth/tokenUse 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…
Authentication - Devices
- POSTGenerate new device codes
/oauth/device/codeGenerate 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… - POSTPoll for the access_token
/oauth/device/tokenUse 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,…
Calendars
- GETGet DVD releases
/calendars/all/dvd/:start_date/:days✨ Extended Info 🎚 Filters Returns all movies with a DVD release date during the time period specified. - GETGet movies
/calendars/all/movies/:start_date/:days✨ Extended Info 🎚 Filters Returns all movies with a release date during the time period specified. - GETGet new shows
/calendars/all/shows/new/:start_date/:days✨ Extended Info 🎚 Filters Returns all new show premieres (season 1, episode 1) airing during the time period specified. - GETGet season premieres
/calendars/all/shows/premieres/:start_date/:days✨ Extended Info 🎚 Filters Returns all show premieres (any season, episode 1) airing during the time period specified. - GETGet shows
/calendars/all/shows/:start_date/:days✨ Extended Info 🎚 Filters Returns all shows airing during the time period specified. - GETGet DVD releases
/calendars/my/dvd/:start_date/:days🔒 OAuth Required ✨ Extended Info 🎚 Filters Returns all movies with a DVD release date during the time period specified. - GETGet movies
/calendars/my/movies/:start_date/:days🔒 OAuth Required ✨ Extended Info 🎚 Filters Returns all movies with a release date during the time period specified. - GETGet new shows
/calendars/my/shows/new/:start_date/:days🔒 OAuth Required ✨ Extended Info 🎚 Filters Returns all new show premieres (season 1, episode 1) airing during the time period specified. - GETGet season premieres
/calendars/my/shows/premieres/:start_date/:days🔒 OAuth Required ✨ Extended Info 🎚 Filters Returns all show premieres (any season, episode 1) airing during the time period specified. - GETGet shows
/calendars/my/shows/:start_date/:days🔒 OAuth Required ✨ Extended Info 🎚 Filters Returns all shows airing during the time period specified.
Checkin
- POSTCheck into an item
/checkin🔒 OAuth Required Check into a movie or episode. This should be tied to a user action to manually indicate they are watching something. The item will… - DELETEDelete any active checkins
/checkin🔒 OAuth Required Removes any active checkins, no need to provide a specific item.
Certifications
- GETGet certifications
/certifications/:typeGet a list of all certifications, including names, slugs, and descriptions.
Comments
- POSTPost a comment
/comments🔒 OAuth Required 😁 Emojis Add a new comment to a movie, show, season, episode, or list. Make sure to allow and encourage *spoilers* to be… - GETGet recently created comments
/comments/recent/:comment_type/:type?include_replies=false📄 Pagination ✨ Extended Info 😁 Emojis Returns the most recently written comments across all of Trakt. You can optionally filter by the… - GETGet trending comments
/comments/trending/:comment_type/:type?include_replies=false📄 Pagination ✨ Extended Info 😁 Emojis Returns all comments with the most likes and replies over the last 7 days. You can optionally… - GETGet recently updated comments
/comments/updates/:comment_type/:type?include_replies=false📄 Pagination ✨ Extended Info 😁 Emojis Returns the most recently updated comments across all of Trakt. You can optionally filter by the… - GETGet a comment or reply
/comments/:id😁 Emojis Returns a single comment and indicates how many replies it has. Use /comments/:id/replies to get the actual replies. - PUTUpdate a comment or reply
/comments/:id🔒 OAuth Required 😁 Emojis Update a single comment. The OAuth user must match the author of the comment in order to update it. If not, a 401… - DELETEDelete a comment or reply
/comments/:id🔒 OAuth Required Delete 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… - GETGet the attached media item
/comments/:id/item✨ Extended Info Returns the media item this comment is attached to. The media type can be movie, show, season, episode, or list and it also returns the… - POSTLike a comment
/comments/:id/like🔒 OAuth Required Votes help determine popular comments. Only one like is allowed per comment per user. - DELETERemove like on a comment
/comments/:id/like🔒 OAuth Required Remove a like on a comment. - GETGet all users who liked a comment
/comments/:id/likes📄 Pagination Returns 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… - GETGet replies for a comment
/comments/:id/replies📄 Pagination 😁 Emojis Returns all replies for a comment. It is possible these replies could have replies themselves, so in that case you would… - POSTPost a reply for a comment
/comments/:id/replies🔒 OAuth Required 😁 Emojis Add a new reply to an existing comment. Make sure to allow and encourage *spoilers* to be indicated in your app and…
Countries
- GETGet countries
/countries/:typeGet a list of all countries, including names and codes.
Genres
- GETGet genres
/genres/:typeGet a list of all genres, including names and slugs.
Languages
- GETGet languages
/languages/:typeGet a list of all langauges, including names and codes.
Lists
- GETGet popular lists
/lists/popular📄 Pagination 😁 Emojis Returns the most popular lists. Popularity is calculated using total number of likes and comments. - GETGet trending lists
/lists/trending📄 Pagination 😁 Emojis Returns all lists with the most likes and comments over the last 7 days. - GETGet list
/lists/:id😁 Emojis Returns a single list. Use the /lists/:id/items method to get the actual items this list contains. Note: You must use an integer id, and only… - GETGet all list comments
/lists/:id/comments/:sort📄 Pagination 😁 Emojis Returns all top level comments for a list. By default, the newest comments are returned first. Other sorting options… - GETGet items on a list
/lists/:id/items/:type📄 Pagination Optional ✨ Extended Info 😁 Emojis Get all items on a personal list. Items can be a movie, show, season, episode, or… - GETGet all users who liked a list
/lists/:id/likes📄 Pagination Returns all users who liked a list.
Movies
- GETGet the most anticipated movies
/movies/anticipated📄 Pagination ✨ Extended Info 🎚 Filters Returns the most anticipated movies based on the number of lists a movie appears on. - GETGet the weekend box office
/movies/boxoffice✨ Extended Info Returns the top 10 grossing movies in the U.S. box office last weekend. Updated every Monday morning. - GETGet the most Collected movies
/movies/collected/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most collected (unique users) movies in the specified time period, defaulting to… - GETGet the most played movies
/movies/played/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most played (a single user can watch multiple times) movies in the specified time… - GETGet popular movies
/movies/popular📄 Pagination ✨ Extended Info 🎚 Filters Returns the most popular movies. Popularity is calculated using the rating percentage and the… - GETGet the most recommended movies
/movies/recommended/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most recommended movies in the specified time period, defaulting to weekly. All… - GETGet trending movies
/movies/trending📄 Pagination ✨ Extended Info 🎚 Filters Returns all movies being watched right now. Movies with the most users are returned first. - GETGet recently updated movie Trakt IDs
/movies/updates/id/:start_date📄 Pagination Returns all movie Trakt IDs updated since the specified UTC date and time. We recommended storing the X-Start-Date header you can be… - GETGet recently updated movies
/movies/updates/:start_date📄 Pagination ✨ Extended Info Returns all movies updated since the specified UTC date and time. We recommended storing the X-Start-Date header… - GETGet the most watched movies
/movies/watched/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most watched (unique users) movies in the specified time period, defaulting to… - GETGet a movie
/movies/:id✨ Extended Info Returns a single movie's details. Note: When getting full extended info, the status field can have a value of released, in production,… - GETGet all movie aliases
/movies/:id/aliasesReturns all title aliases for a movie. Includes country where name is different. - GETGet all movie comments
/movies/:id/comments/:sort📄 Pagination 😁 Emojis Returns all top level comments for a movie. By default, the newest comments are returned first. Other sorting options… - GETGet lists containing this movie
/movies/:id/lists/:type/:sort📄 Pagination 😁 Emojis Returns all lists that contain this movie. By default, personal lists are returned sorted by the most popular. - GETGet all people for a movie
/movies/:id/people✨ Extended Info Returns all cast and crew for a movie. Each cast member will have a characters array and a standard person object. The crew object will… - GETGet movie ratings
/movies/:id/ratingsReturns rating (between 0 and 10) and distribution for a movie. - GETGet related movies
/movies/:id/related📄 Pagination ✨ Extended Info Returns related and similar movies. - GETGet all movie releases
/movies/:id/releases/:countryReturns all releases for a movie including country, certification, release date, release type, and note. The release type can be set to unknown, premiere,… - GETGet movie stats
/movies/:id/statsReturns lots of movie stats. - GETGet movie studios
/movies/:id/studiosReturns all studios for a movie. - GETGet all movie translations
/movies/:id/translations/:languageReturns all translations for a movie, including language and translated values for title, tagline and overview. - GETGet users watching right now
/movies/:id/watching✨ Extended Info Returns all users watching this movie right now.
Networks
- GETGet networks
/networksGet a list of all TV networks, including the name.
People
- GETGet recently updated people Trakt IDs
/people/updates/id/:start_date📄 Pagination Returns all people Trakt IDs updated since the specified UTC date and time. We recommended storing the X-Start-Date header you can be… - GETGet recently updated people
/people/updates/:start_date📄 Pagination ✨ Extended Info Returns all people updated since the specified UTC date and time. We recommended storing the X-Start-Date header… - GETGet a single person
/people/:id✨ Extended Info Returns a single person's details. Gender If available, the gender property will be set to male, female, or non_binary. Known For… - GETGet lists containing this person
/people/:id/lists/:type/:sort📄 Pagination 😁 Emojis Returns all lists that contain this person. By default, personal lists are returned sorted by the most popular. - GETGet movie credits
/people/:id/movies✨ Extended Info Returns all movies where this person is in the cast or crew. Each cast object will have a characters array and a standard movie object.… - GETGet show credits
/people/:id/shows✨ Extended Info Returns all shows where this person is in the cast or crew, including the episode_count for which they appear. Each cast object will…
Recommendations
- GETGet movie recommendations
/recommendations/movies?ignore_collected=false&ignore_watchlisted=false🔒 OAuth Required ✨ Extended Info Movie recommendations for a user. By default, 10 results are returned. You can send a limit to get up to 100… - DELETEHide a movie recommendation
/recommendations/movies/:id🔒 OAuth Required Hide a movie from getting recommended anymore. - GETGet show recommendations
/recommendations/shows?ignore_collected=false&ignore_watchlisted=false🔒 OAuth Required ✨ Extended Info TV show recommendations for a user. By default, 10 results are returned. You can send a limit to get up to 100… - DELETEHide a show recommendation
/recommendations/shows/:id🔒 OAuth Required Hide a show from getting recommended anymore.
Scrobble
- POSTPause watching in a media center
/scrobble/pause🔒 OAuth Required Use this method when the video is paused. The playback progress will be saved and /sync/playback can be used to resume the video from… - POSTStart watching in a media center
/scrobble/start🔒 OAuth Required Use this method when the video initially starts playing or is unpaused. This will remove any playback progress if it exists. Note: A… - POSTStop or finish watching in a media center
/scrobble/stop🔒 OAuth Required Use this method when the video is stopped or finishes playing on its own. If the progress is above 80%, the video will be scrobbled…
Search
- GETGet ID lookup results
/search/:id_type/:id?type=movie📄 Pagination ✨ Extended Info Lookup items by their Trakt, IMDB, TMDB, or TVDB ID. If you use the search url without a type it might return… - GETGet text query results
/search/:type?query=tron📄 Pagination ✨ Extended Info 🎚 Filters Search all text fields that a media object contains (i.e. title, overview, etc). Results are…
Shows
- GETGet the most anticipated shows
/shows/anticipated📄 Pagination ✨ Extended Info 🎚 Filters Returns the most anticipated shows based on the number of lists a show appears on. - GETGet the most collected shows
/shows/collected/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most collected (unique users) shows in the specified time period, defaulting to… - GETGet the most played shows
/shows/played/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most played (a single user can watch multiple episodes multiple times) shows in the… - GETGet popular shows
/shows/popular📄 Pagination ✨ Extended Info 🎚 Filters Returns the most popular shows. Popularity is calculated using the rating percentage and the… - GETGet the most recommended shows
/shows/recommended/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most recommended shows in the specified time period, defaulting to weekly. All stats… - GETGet trending shows
/shows/trending📄 Pagination ✨ Extended Info 🎚 Filters Returns all shows being watched right now. Shows with the most users are returned first. - GETGet recently updated show Trakt IDs
/shows/updates/id/:start_date📄 Pagination Returns all show Trakt IDs updated since the specified UTC date and time. We recommended storing the X-Start-Date header you can be… - GETGet recently updated shows
/shows/updates/:start_date📄 Pagination ✨ Extended Info Returns all shows updated since the specified UTC date and time. We recommended storing the X-Start-Date header… - GETGet the most watched shows
/shows/watched/:period📄 Pagination ✨ Extended Info 🎚 Filters Returns the most watched (unique users) shows in the specified time period, defaulting to… - GETGet a single show
/shows/:id✨ Extended Info Returns 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,… - GETGet all show aliases
/shows/:id/aliasesReturns all title aliases for a show. Includes country where name is different. - GETGet all show certifications
/shows/:id/certificationsReturns all content certifications for a show, including the country. - GETGet all show comments
/shows/:id/comments/:sort📄 Pagination 😁 Emojis Returns all top level comments for a show. By default, the newest comments are returned first. Other sorting options… - GETGet last episode
/shows/:id/last_episode✨ Extended Info Returns the most recently aired episode. If no episode is found, a 204 HTTP status code will be returned. - GETGet lists containing this show
/shows/:id/lists/:type/:sort📄 Pagination 😁 Emojis Returns all lists that contain this show. By default, personal lists are returned sorted by the most popular. - GETGet next episode
/shows/:id/next_episode✨ Extended Info Returns the next scheduled to air episode. If no episode is found, a 204 HTTP status code will be returned. - GETGet all people for a show
/shows/:id/people✨ Extended Info Returns all cast and crew for a show, including the episode_count for which they appears. Each cast member will have a characters array… - GETGet show collection progress
/shows/:id/progress/collection?hidden=false&specials=false&count_specials=true🔒 OAuth Required Returns collection progress for a show including details on all aired seasons and episodes. The next_episode will be the next episode… - GETGet show watched progress
/shows/:id/progress/watched?hidden=false&specials=false&count_specials=true🔒 OAuth Required Returns watched progress for a show including details on all aired seasons and episodes. The next_episode will be the next episode… - POSTReset show progress
/shows/:id/progress/watched/reset🔒 OAuth Required 🔥 VIP Only Reset a show's progress when the user started re-watching the show. You can optionally specify the reset_at date to have… - DELETEUndo reset show progress
/shows/:id/progress/watched/reset🔒 OAuth Required 🔥 VIP Only Undo the reset and have watched progress use all watched history for the show. - GETGet show ratings
/shows/:id/ratingsReturns rating (between 0 and 10) and distribution for a show. - GETGet related shows
/shows/:id/related📄 Pagination ✨ Extended Info Returns related and similar shows. - GETGet show stats
/shows/:id/statsReturns lots of show stats. - GETGet show studios
/shows/:id/studiosReturns all studios for a show. - GETGet all show translations
/shows/:id/translations/:languageReturns all translations for a show, including language and translated values for title and overview. - GETGet users watching right now
/shows/:id/watching✨ Extended Info Returns all users watching this show right now.
Seasons
- GETGet all seasons for a show
/shows/:id/seasons✨ Extended Info Returns all seasons for a show including the number of episodes in each season. Episodes If you add ?extended=episodes to the URL, it… - GETGet single season for a show
/shows/:id/seasons/:season?translations=es✨ Extended Info Returns all episodes for a specific season of a show. Translations If you'd like to included translated episode titles and overviews in… - GETGet all season comments
/shows/:id/seasons/:season/comments/:sort📄 Pagination 😁 Emojis Returns all top level comments for a season. By default, the newest comments are returned first. Other sorting options… - GETGet lists containing this season
/shows/:id/seasons/:season/lists/:type/:sort📄 Pagination 😁 Emojis Returns all lists that contain this season. By default, personal lists are returned sorted by the most popular. - GETGet all people for a season
/shows/:id/seasons/:season/people✨ Extended Info Returns all cast and crew for a season, including the episode_count for which they appear. Each cast member will have a characters… - GETGet season ratings
/shows/:id/seasons/:season/ratingsReturns rating (between 0 and 10) and distribution for a season. - GETGet season stats
/shows/:id/seasons/:season/statsReturns lots of season stats. - GETGet all season translations
/shows/:id/seasons/:season/translations/:languageReturns all translations for an season, including language and translated values for title and overview. - GETGet users watching right now
/shows/:id/seasons/:season/watching✨ Extended Info Returns all users watching this season right now.
Episodes
- GETGet a single episode for a show
/shows/:id/seasons/:season/episodes/:episode✨ Extended Info Returns 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… - GETGet all episode comments
/shows/:id/seasons/:season/episodes/:episode/comments/:sort📄 Pagination 😁 Emojis Returns all top level comments for an episode. By default, the newest comments are returned first. Other sorting options… - GETGet lists containing this episode
/shows/:id/seasons/:season/episodes/:episode/lists/:type/:sort📄 Pagination 😁 Emojis Returns all lists that contain this episode. By default, personal lists are returned sorted by the most popular. - GETGet all people for an episode
/shows/:id/seasons/:season/episodes/:episode/people✨ Extended Info Returns all cast and crew for an episode. Each cast member will have a characters array and a standard person object. The crew object… - GETGet episode ratings
/shows/:id/seasons/:season/episodes/:episode/ratingsReturns rating (between 0 and 10) and distribution for an episode. - GETGet episode stats
/shows/:id/seasons/:season/episodes/:episode/statsReturns lots of episode stats. - GETGet all episode translations
/shows/:id/seasons/:season/episodes/:episode/translations/:languageReturns all translations for an episode, including language and translated values for title and overview. - GETGet users watching right now
/shows/:id/seasons/:season/episodes/:episode/watching✨ Extended Info Returns all users watching this episode right now.
Sync
- POSTAdd items to collection
/sync/collection🔒 OAuth Required Add items to a user's collection. Accepts shows, seasons, episodes and movies. If only a show is passed, all episodes for the show… - POSTRemove items from collection
/sync/collection/remove🔒 OAuth Required Remove one or more items from a user's collection. JSON POST Data - GETGet collection
/sync/collection/:type🔒 OAuth Required ✨ Extended Info Get all collected items in a user's collection. A collected item indicates availability to watch digitally or… - POSTAdd items to watched history
/sync/history🔒 OAuth Required Add items to a user's watch history. Accepts shows, seasons, episodes and movies. If only a show is passed, all episodes for the show… - POSTRemove items from history
/sync/history/remove🔒 OAuth Required Remove items from a user's watch history including all watches, scrobbles, and checkins. Accepts shows, seasons, episodes and movies.… - GETGet watched history
/sync/history/:type/:id?start_at=2016-06-01T00:00:00.000Z&end_at=2016-07-01T23:59:59.000Z🔒 OAuth Required 📄 Pagination ✨ Extended Info Returns movies and episodes that a user has watched, sorted by most recent. You can… - GETGet last activity
/sync/last_activities🔒 OAuth Required This method is a useful first step in the syncing process. We recommended caching these dates locally, then you can compare to know… - DELETERemove a playback item
/sync/playback/:id🔒 OAuth Required Remove a playback item from a user's playback progress list. A 404 will be returned if the id is invalid. - GETGet playback progress
/sync/playback/:type?start_at=2016-06-01T00:00:00.000Z&end_at=2016-07-01T23:59:59.000Z🔒 OAuth Required 📄 Pagination Optional Whenever a scrobble is paused, the playback progress is saved. Use this progress to sync up playback… - POSTAdd new ratings
/sync/ratings🔒 OAuth Required Rate one or more items. Accepts shows, seasons, episodes and movies. If only a show is passed, only the show itself will be rated. If… - POSTRemove ratings
/sync/ratings/remove🔒 OAuth Required Remove ratings for one or more items. JSON POST Data - GETGet ratings
/sync/ratings/:type/:rating🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info Get a user's ratings filtered by type. You can optionally filter for a specific… - POSTAdd items to personal recommendations
/sync/recommendations🔒 OAuth Required 😁 Emojis If the user only had 50 movies and TV shows to bring with them on a desert island, what would they be? These… - POSTRemove items from personal recommendations
/sync/recommendations/remove🔒 OAuth Required Remove items from a user's personal recommendations. These recommendations are used to enchance Trakt's social recommendation… - POSTReorder personally recommended items
/sync/recommendations/reorder🔒 OAuth Required Reorder all items on a user's personal recommendations by sending the updated rank of list item ids. Use the /sync/recommendations… - GETGet personal recommendations
/sync/recommendations/:type/:sort🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis If the user only had 50 movies and TV shows to bring with them… - GETGet watched
/sync/watched/:type🔒 OAuth Required ✨ Extended Info Returns all movies or shows a user has watched sorted by most plays. If type is set to _shows_ and you add… - POSTAdd items to watchlist
/sync/watchlist🔒 OAuth Required 😁 Emojis 🔥 VIP Enhanced Add one of more items to a user's watchlist. Accepts shows, seasons, episodes and movies. If only a… - POSTRemove items from watchlist
/sync/watchlist/remove🔒 OAuth Required Remove one or more items from a user's watchlist. JSON POST Data - POSTReorder watchlist items
/sync/watchlist/reorder🔒 OAuth Required Reorder all items on a user's watchlist by sending the updated rank of list item ids. Use the /sync/watchlist method to get all list… - GETGet watchlist
/sync/watchlist/:type/:sort🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis Returns all items in a user's watchlist filtered by type. Notes…
Users
- GETGet hidden items
/users/hidden/:section?type=movie🔒 OAuth Required 📄 Pagination ✨ Extended Info Get hidden items for a section. This will return an array of standard media objects. You… - POSTAdd hidden items
/users/hidden/:section🔒 OAuth Required Hide items for a specific section. Here's what type of items can hidden for each section. Hideable Media Objects JSON POST Data - POSTRemove hidden items
/users/hidden/:section/remove🔒 OAuth Required Unhide items for a specific section. Here's what type of items can unhidden for each section. Unhideable Media Objects JSON POST Data - GETGet follow requests
/users/requests🔒 OAuth Required ✨ Extended Info List a user's pending follow requests so they can either approve or deny them. - GETGet pending following requests
/users/requests/following🔒 OAuth Required ✨ Extended Info List a user's pending following requests that they're waiting for the other user's to approve. - POSTApprove follow request
/users/requests/:id🔒 OAuth Required Approve 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… - DELETEDeny follow request
/users/requests/:id🔒 OAuth Required Deny 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… - GETGet saved filters
/users/saved_filters/:section🔒 OAuth Required 📄 Pagination 🔥 VIP Only Get all saved filters a user has created. The path and query can be used to construct an API path to… - GETRetrieve settings
/users/settings🔒 OAuth Required Get 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… - GETGet user profile
/users/:id🔓 OAuth Optional ✨ Extended Info Get a user's profile information. If the user is private, info will only be returned if you send OAuth and are… - GETGet collection
/users/:id/collection/:type🔓 OAuth Optional ✨ Extended Info Get all collected items in a user's collection. A collected item indicates availability to watch digitally or… - GETGet comments
/users/:id/comments/:comment_type/:type?include_replies=false🔓 OAuth Optional 📄 Pagination ✨ Extended Info Returns the most recently written comments for the user. You can optionally filter by the… - POSTFollow this user
/users/:id/follow🔒 OAuth Required If the user has a private profile, the follow request will require approval (approved_at will be null). If a user is public, they… - DELETEUnfollow this user
/users/:id/follow🔒 OAuth Required Unfollow someone you already follow. - GETGet followers
/users/:id/followers🔓 OAuth Optional ✨ Extended Info Returns all followers including when the relationship began. - GETGet following
/users/:id/following🔓 OAuth Optional ✨ Extended Info Returns all user's they follow including when the relationship began. - GETGet friends
/users/:id/friends🔓 OAuth Optional ✨ Extended Info Returns all friends for a user including when the relationship began. Friendship is a 2 way relationship where… - GETGet watched history
/users/:id/history/:type/:item_id?start_at=2016-06-01T00:00:00.000Z&end_at=2016-07-01T23:59:59.000Z🔓 OAuth Optional 📄 Pagination ✨ Extended Info Returns movies and episodes that a user has watched, sorted by most recent. You can… - GETGet likes
/users/:id/likes/:type🔒 OAuth Optional 📄 Pagination Get items a user likes. This will return an array of standard media objects. You can optionally limit the type… - GETGet a user's personal lists
/users/:id/lists🔓 OAuth Optional 😁 Emojis Returns all personal lists for a user. Use the /users/:id/lists/:list_id/items method to get the actual items a… - POSTCreate personal list
/users/:id/lists🔒 OAuth Required 🔥 VIP Enhanced Create a new personal list. The name is the only required field, but the other info is recommended to ask for. Limits… - GETGet all lists a user can collaborate on
/users/:id/lists/collaborations🔓 OAuth Optional Returns all lists a user can collaborate on. This gives full access to add, remove, and re-order list items. It essentially works… - POSTReorder a user's lists
/users/:id/lists/reorder🔒 OAuth Required Reorder all lists by sending the updated rank of list ids. Use the /users/:id/lists method to get all list ids. - GETGet personal list
/users/:id/lists/:list_id🔓 OAuth Optional 😁 Emojis Returns a single personal list. Use the /users/:id/lists/:list_id/items method to get the actual items this list… - PUTUpdate personal list
/users/:id/lists/:list_id🔒 OAuth Required Update a personal list by sending 1 or more parameters. If you update the list name, the original slug will still be retained so… - DELETEDelete a user's personal list
/users/:id/lists/:list_id🔒 OAuth Required Remove a personal list and all items it contains. - GETGet all list comments
/users/:id/lists/:list_id/comments/:sort🔓 OAuth Optional 📄 Pagination 😁 Emojis Returns all top level comments for a list. By default, the newest comments are returned first.… - POSTAdd items to personal list
/users/:id/lists/:list_id/items🔒 OAuth Required 😁 Emojis 🔥 VIP Enhanced Add one or more items to a personal list. Items can be movies, shows, seasons, episodes, or people.… - POSTRemove items from personal list
/users/:id/lists/:list_id/items/remove🔒 OAuth Required Remove one or more items from a personal list. JSON POST Data - POSTReorder items on a list
/users/:id/lists/:list_id/items/reorder🔒 OAuth Required Reorder all items on a list by sending the updated rank of list item ids. Use the /users/:id/lists/:list_id/items method to get all… - GETGet items on a personal list
/users/:id/lists/:list_id/items/:type🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info 😁 Emojis Get all items on a personal list. Items can be a movie, show,… - POSTLike a list
/users/:id/lists/:list_id/like🔒 OAuth Required Votes help determine popular lists. Only one like is allowed per list per user. - DELETERemove like on a list
/users/:id/lists/:list_id/like🔒 OAuth Required Remove a like on a list. - GETGet all users who liked a list
/users/:id/lists/:list_id/likes🔓 OAuth Optional 📄 Pagination Returns all users who liked a list. - GETGet ratings
/users/:id/ratings/:type/:rating🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info Get a user's ratings filtered by type. You can optionally filter for a specific… - GETGet personal recommendations
/users/:id/recommendations/:type/:sort🔒 OAuth Required 📄 Pagination Optional ✨ Extended Info 😁 Emojis Returns the top 50 items a user personally recommendeds to… - GETGet stats
/users/:id/stats🔓 OAuth Optional Returns stats about the movies, shows, and episodes a user has watched, collected, and rated. - GETGet watched
/users/:id/watched/:type🔓 OAuth Optional ✨ Extended Info Returns all movies or shows a user has watched sorted by most plays. If type is set to _shows_ and you add… - GETGet watching
/users/:id/watching🔓 OAuth Optional ✨ Extended Info Returns a movie or episode if the user is currently watching something. If they are not, it returns no data… - GETGet watchlist
/users/:id/watchlist/:type/:sort🔓 OAuth Optional 📄 Pagination Optional ✨ Extended Info 😁 Emojis Returns all items in a user's watchlist filtered by type. Notes…
API details
- Base URL
https://api.trakt.tv- Authentication
- OAuth 2.0 (authorization code flow)
- Operations
- 183 operations on 170 pathsGET 136POST 34DELETE 11PUT 2
- Main resources
- Users 40Shows 27Movies 22Sync 21Comments 13Calendars 10Seasons 9Episodes 8Lists 6People 6
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Trakt API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Trakt API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Authorize Application” (GET /oauth/authorize?response_type=code&client_id= &redirect_uri= &state= ), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Trakt API?
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… It is listed under Other and has 183 endpoints.
Who publishes the Trakt API?
It is listed from Trakt's public API description (an OpenAPI document), not published by Trakt on Swastik Codes. Anyone who controls trakt.tv can claim the profile by adding a DNS TXT record.
What is the base URL of the Trakt API?
Requests go to https://api.trakt.tv. Endpoint paths are added to this base URL.
How do I authenticate with the Trakt API?
With OAuth 2.0 (authorization code flow).
How many endpoints does the Trakt API have?
183 operations on 170 paths (136 GET, 34 POST, 11 DELETE, 2 PUT). The largest groups are Users, Shows, Movies, Sync.
Is forking the Trakt API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.