API Docs

» show/checkin

This method requires a developer API key with check in permissions.

Summary

Check into a show on trakt. Think of this method as in between a seen and a scrobble. After checking in, the trakt will automatically display it as watching then switch over to watched status once the duration has elapsed.

URL

http://api.trakt.tv/show/checkin/apikey

Supported formats

json

Supported request methods

POST

Requires authentication

true (details)

Required Parameters

  • apikey

    Requires a developer API key. Details here.

  • JSON POST

    • username

      trakt username.

    • password

      SHA1 hash of trakt password.

    • tvdb_id

      TVDB ID for the show

      If you don't have the TVDB ID, make sure the title and year match trakt exactly.

    • title

      Show title.

    • year

      Show year.

    • season

      Show season. Send 0 if watching a special.

    • episode

      Show episode.

    • episode_tvdb_id (optional)

      TVDB ID for the specific episode. If not found, it will fall back to a show, season, and episode lookup.

    • duration (optional)

      Duration in minutes. If not sent, the episode runtime will be used.

    • venue_id (optional)

      Foursquare venue ID.

    • venue_name (optional)

      Custom venue name for display purposes.

    • share (optional)

      Control how the check in shared to the user's connected social networks. If you send true for a connected social network. If you send false or that social network is not connected it won't send anything.

      "share": {
      	"facebook": true,
      	"twitter": true,
      	"tumblr": false
      }

    • message (optional)

      The message to use for sharing. If not sent, it will use the localized watching string set on the connections page. The message will be truncated to 100 characters to make sure it fits in the tweet with the url and hashtag.

    • app_version

      Version number of the app, be as specific as you can including nightly build number, etc. Used to help debug.

    • app_date

      Build date of the media center. Used to help debug.

Example JSON POST

{
	"username": "username",
	"password": "sha1hash",
	"imdb_id": "tt1520211",
	"tvdb_id": 153021,
	"title": "The Walking Dead",
	"year": 2010,
	"season": 1,
	"episode": 1,
	"duration": 60,
	"app_version": "1.0",
	"app_date": "June 4 2011",
	"venue_id": 1234,
	"shared": {
		"facebook": true,
		"twitter": false
	}
	"message": "I'm revisiting the first season of The Walking Dead"
}

Example Response

{
	"status": "success",
	"message": "checked in to The Walking Dead 1x01",
	"timestamps": {
		"start": 1330670727,
		"end": 1330674327,
		"active_for": 3600
	},
	"show": {
		"title": "The Walking Dead",
		"year": 2010,
		"imdb_id": "tt1520211",
		"tvdb_id": 153021
	},
	"facebook": false,
	"twitter": false,
	"tumblr": false,
	"foursquare": false
}

If there is already a recent checkin, it will error out. You can then ask the user if they want to cancel their previous checkin or wait the indicated time.

{
   "status":"failure",
   "error":"There is already a checkin in progress. Either cancel this checkin or wait 3 minutes before you can check in again.",
   "wait":180
}
loading...
Join trakt

Sign in to trakt

forgot?

Sign In
Forgot your password?
Check your email for further instructions!
We couldn't find that e-mail!

Create your new password