- Overview
- Authentication
- Errors
- Images
- Advanced Ratings
- Scrobbling vs. Checkins
- Syncing with trakt
-
Account
-
Activity
-
Calendar
-
Comment
-
Genres
-
Lists
-
Movie
-
Movies
-
Network
-
Rate
-
Recommendations
-
Search
-
Server
-
Show
- show/cancelcheckin
- show/cancelwatching
- show/checkin
- show/comments
- show/episode/comments
- show/episode/library
- show/episode/seen
- show/episode/summary
- show/episode/unlibrary
- show/episode/unseen
- show/episode/unwatchlist
- show/episode/watchingnow
- show/episode/watchlist
- show/library
- show/related
- show/scrobble
- show/season
- show/season/library
- show/season/seen
- show/seasons
- show/seen
- show/summary
- show/unlibrary
- show/unwatchlist
- show/watching
- show/watchingnow
- show/watchlist
-
Shows
-
User
- user/calendar/shows
- user/lastactivity
- user/library/movies/all
- user/library/movies/collection
- user/library/movies/watched
- user/library/shows/all
- user/library/shows/collection
- user/library/shows/watched
- user/list
- user/lists
- user/network/followers
- user/network/following
- user/network/friends
- user/profile
- user/progress/collected
- user/progress/watched
- user/ratings/episodes
- user/ratings/movies
- user/ratings/shows
- user/watching
- user/watchlist/episodes
- user/watchlist/movies
- user/watchlist/shows
-
Deprecated
- friends/add
- friends/all
- friends/approve
- friends/delete
- friends/deny
- friends/requests
- movie/shouts
- shout/episode
- shout/movie
- shout/show
- show/episode/shouts
- show/shouts
- user/friends
- user/library/movies/hated
- user/library/movies/loved
- user/library/shows/hated
- user/library/shows/loved
- user/watched
- user/watched/episodes
- user/watched/movies
API Key Errors
An invalid API key will return a JSON error and set a HTTP/1.1 401 Unauthorized http status.
Example error response
{
"status": "failure",
"error": "invalid API key"
}
{
"status": "failure",
"error": "invalid development API key"
}
{
"status": "failure",
"error": "invalid development API permission (scrobble)"
}
Authentication Errors
Invalid user credentials (username or password) will return a JSON error and set a HTTP/1.1 401 Unauthorized http status.
Example error response
{
"status": "failure",
"error": "failed authentication",
}
Server Over Capcity
If the server is over capacity, it will return a JSON error and set a HTTP/1.1 503 Service Unavailable http status. If you encounter this error, we recommend waiting 10 seconds or so, then retry the API call. This error typically indicates a temporary server issue that should resolve itself quickly, so the 2nd call will likely go through. Its worth putting a retry cap just to make sure it's not infinitely retrying in the event a true outage.
Example error response
{
"status": "failure",
"error": "server is over capacity"
}



