curl --request POST \
  --url 'https://api.simkl.com/scrobble/stop?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --data '
{
  "movie": {
    "ids": {
      "simkl": 752138
    }
  }
}
'

{
  "id": 35148632,
  "action": "pause",
  "progress": 30,
  "movie": {
    "title": "The Matrix",
    "year": 1999,
    "ids": {
      "simkl": 53992,
      "slug": "the-matrix",
      "imdb": "tt0133093",
      "tmdb": "603",
      "tvdb": "169",
      "tvdbslug": "the-matrix",
      "traktslug": "the-matrix-1999",
      "letterboxd": "the-matrix"
    }
  }
}

Stop

Finalizes the user’s playback session. The action field in the response tells you what Simkl did:

`progress`	`action`	Result
≥ 80	`scrobble`	Item is marked watched.
< 80	`pause`	Session is saved as a paused playback.

When progress < 80, the session is kept as a resumable playback, retrievable cross-device via GET /sync/playback/{type}. When progress ≥ 80, the item is marked watched and no playback is saved. See the Playback overview for retention.

Body shape is identical to /scrobble/start.

Duplicate prevention

Stopping a session that’s already been finalized within the past hour returns 409 Conflict with watched_at and expires_at so you know when the prior scrobble expires:

{
 "watched_at": "2024-05-01T18:00:00-05:00",
 "expires_at": "2024-05-01T19:00:00-05:00"
}

Three separate windows guard this endpoint, and they are easy to mix up:

Window	Applies to	What happens
20 seconds	Any scrobble call, per user	A second in-flight call collides with the per-user lock and returns `400` with `RATE_LIMIT`.
1 hour	Re-stopping the same item	Returns `409 Conflict` with `watched_at` / `expires_at`, as above. The watch is already recorded.
2 days	Rewatches only (`?allow_rewatch=yes`)	Two watches of the same movie or episode must be at least 2 days apart. Anything closer is absorbed into the existing session and reports `rewatch_status: "too_soon"`.

The 2-day gap is deliberate: it absorbs player retries, scrubbing back and forth across the 80% mark, and importer re-runs, which would otherwise fill the user’s history with phantom sessions. It is not an error and must not be retried. See The 2-day gap.

Seek and scrub behavior

The ≥80% auto-scrobble rule applies to the progress you send with this call — not to anywhere the user temporarily scrubbed during playback. A user who scrubbed to 95% mid-watch but then rewinds and stops at 30% sends progress: 30, and the server stores action: "pause". Only the value at the moment of stop matters.

Note: A 20-second per-user lock collision returns HTTP 400 with RATE_LIMIT, not 429 — the lock failure is treated as a malformed request from a duplicate-fire client.

Scrobble guide — full walkthrough

Real-time playback tracking — /start, /pause, /stop lifecycle, paused-playback resumption across devices, when scrobble auto-completes, and the difference between /scrobble/checkin (fire-and-forget) and /scrobble/start (active tracking).

Alternative to episode.season + episode.number: pass episode.ids with tvdb or anidb to identify the exact episode by external episode ID. Useful for Plex / media-server integrations that have a TVDB or AniDB episode ID but not the season/number mapping. (Episode-level imdb and tmdb IDs are not accepted — those exist only at the show/movie level. Use the show/anime object’s ids for those.) If both forms are sent, episode.ids takes precedence.

Which IDs can I send/expect? All accepted input identifiers and the keys you’ll see echoed back in responses are listed at Standard media objects → Supported ID keys. Send every ID you have on writes — Simkl picks the first that resolves and ignores the rest. Reminder: slug is response-only (never send it on a request).

Rewatches

A /scrobble/stop with progress ≥ 80 marks the item watched — but when the user has already completed that item, that write is a no-op: the server detects the duplicate and skips it. To record it as a separate rewatch session instead, send ?allow_rewatch=yes. Detection is automatic from the outcome; there is no per-item flag on this endpoint.

The 80 threshold still gates everything. A rewatch can only exist where a watch does, so a stop below 80 resolves to action: "pause" — resume position saved, nothing marked, and no rewatch_* keys in the response whether or not you sent the flag. If rewatch_status is missing, read action first: "pause" means the progress was too low, not that the rewatch was rejected.

Send the flag on /scrobble/stop or /scrobble/checkin — never on /start or /pause. Those two mark nothing watched, so they can’t produce a session for the item in the request. Worse, /start auto-scrobbles the user’s previous outstanding playback once its progress passes 80%, and that path honours the flag: the previous row may belong to a different title, and no response field reports it, so the flag on /start can silently open a rewatch on something the user isn’t looking at.

Simkl PRO / VIP only. Free-tier callers get rewatch_status: "pro_required" and no session — unlike POST /sync/history, which fails silently, so you can read the reason straight off the response. Still worth gating client-side: check account.type from GET /users/settings at sign-in and enable the flag only for "pro" / "vip". Cache that value; refetch only when activities.settings.all from GET /sync/activities bumps. Expose a per-user Track rewatches toggle that defaults to off. Full pattern in the Rewatches guide.

When the flag is set, two keys are added to a scrobble response:

Key	Notes
`rewatch_id`	The session this watch landed on, or `null`. A session that is already running reports its id even when it rejected this watch — read `rewatch_status`, never the presence of an id, to find out whether the watch was recorded.
`rewatch_status`	What happened to this watch.

`rewatch_status`	Meaning
`active`	Recorded on a session that is still in progress. Typical for TV / anime.
`completed`	Recorded on a session that is now complete. Movie sessions are created complete, so a movie rewatch reports `completed`, not `active`.
`closed`	Recorded on a session that was manually closed or left partial.
`first_watch`	Not a re-viewing. This is the original watch, and no session was created.
`too_soon`	Rejected by the 2-day gap required between two watches of the same item.
`not_eligible`	The item’s watchlist status is plan-to-watch.
`pro_required`	The account is not Simkl PRO or VIP.
`null`	The watch itself failed to record, so no rewatch was attempted.

On /scrobble/checkin these keys are absent, because a check-in doesn’t mark anything watched at request time. The flag is remembered on the check-in and applied when it matures. You find out what happened by reading the sessions back from GET /sync/all-items?allow_rewatch=yes, not from the response.

POST

scrobble

stop

curl --request POST \
  --url 'https://api.simkl.com/scrobble/stop?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --data '
{
  "movie": {
    "ids": {
      "simkl": 752138
    }
  }
}
'

{
  "id": 35148632,
  "action": "pause",
  "progress": 30,
  "movie": {
    "title": "The Matrix",
    "year": 1999,
    "ids": {
      "simkl": 53992,
      "slug": "the-matrix",
      "imdb": "tt0133093",
      "tmdb": "603",
      "tvdb": "169",
      "tvdbslug": "the-matrix",
      "traktslug": "the-matrix-1999",
      "letterboxd": "the-matrix"
    }
  }
}

Authorizations

client_id

string

query

default:YOUR_CLIENT_ID

required

Preferred form: your client_id as a URL query parameter on every request. Self-describing in logs and curl commands. See Headers and required parameters.

Authorization

string

header

default:YOUR_ACCESS_TOKEN

required

A user access_token, sent as Authorization: Bearer .... Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See Set up authentication.

Headers

User-Agent

string

required

Descriptive identifier for your app, ideally name/version. Examples: PlexMediaServer/1.43.1.10540, kodi-simkl/0.9.2, MyApp/2.4.1 (https://myapp.com).

Query Parameters

client_id

string

required

Your client_id from your Simkl developer settings. Required on every request.

app-name

string

required

Short, lowercase identifier for your app (e.g. plex-scrobbler, kodi-bridge). Helps Simkl identify which apps are using the API.

app-version

string

required

Your app's current version (e.g. 1.0, 2.4.1). Helps Simkl debug issues you report.

allow_rewatch

enum<string>

default:no

Opt into rewatch tracking. When yes and the account is Simkl PRO or VIP, a /scrobble/stop with progress ≥ 80 on an already-completed item records a separate rewatch session instead of being a no-op, and the response gains rewatch_id + rewatch_status. Below 80 the stop is a pause, so nothing is marked and no rewatch fields are returned.

Send this on /scrobble/stop only. The flag is accepted here for consistency, but on /scrobble/start and /scrobble/checkin it applies to the user's previous outstanding playback rather than the item in this request, and nothing in the response reports that. See the /scrobble/stop description for the full rule.

Also supported on POST /scrobble/checkin, where the opt-in is stored on the check-in and applied later, when the check-in matures into a watch. The check-in response carries no rewatch fields because nothing has happened yet.

Read the Rewatches guide before enabling this. Gate it behind explicit user intent, a dedicated "Rewatch" button, never on automatic scrobble events, and expose a per-user Track rewatches toggle in your app settings that defaults to off. Used carelessly it pollutes the user's history stats and rewatches panel with phantom sessions.

Available options:

yes,

no

Body

application/json

Movie
TV episode
Anime episode

Request body for the four scrobble endpoints. Send exactly one of movie, show+episode, or anime+episode — all keys are singular objects (one item per request). For batch sync writes the keys are plural arrays: see /sync/history etc. progress is required for /scrobble/start, /scrobble/pause, and /scrobble/stop; on /scrobble/checkin it is optional and ignored server-side.

Anime under show? Yes — if you don't know whether a title is anime (e.g. you only have TMDB/TVDB data), send it under show and Simkl resolves it to the correct catalog automatically. The anime key is only needed when you want to pass anidb / mal / anilist IDs that don't exist at the TV-show level.

movie

object

required

Movie reference. Use ids (any one external ID) and optionally title / year. Movies have no episode block.

Hide child attributes

movie.ids

object

required

External IDs for a movie. Pass any one or more — Simkl resolves the canonical record by walking these in priority order. simkl is the most reliable when you have it.

Hide child attributes

movie.ids.simkl

integer

Simkl movie ID.

Example:

472214

movie.ids.slug

string

Simkl URL slug (echoed back in responses).

Example:

"inception"

movie.ids.imdb

string

IMDb ID, e.g. tt1375666.

Example:

"tt1375666"

movie.ids.tmdb

string

TMDb movie ID.

Example:

"27205"

movie.ids.netflix

string

Netflix movie ID.

movie.ids.traktslug

string

Trakt movie slug, e.g. inception-2010.

movie.ids.letterboxd

string

Letterboxd slug, e.g. inception.

movie.ids.boxd

string

Letterboxd numeric ID (alternative to letterboxd).

movie.title

string

Example:

"Inception"

movie.year

integer

Example:

2010

progress

number<float>

Playback percentage 0-100. Up to 2 decimals. Required for /scrobble/start, /scrobble/pause, /scrobble/stop. Optional (and ignored) for /scrobble/checkin.

Required range: 0 <= x <= 100

show

object

TV show reference (must be paired with episode).

Hide child attributes

show.ids

object

required

External IDs for a TV show. Pass any one or more.

Hide child attributes

show.ids.simkl

integer

Simkl show ID.

Example:

548312

show.ids.slug

string

Simkl URL slug (echoed back in responses).

Example:

"stranger-things"

show.ids.imdb

string

IMDb ID, e.g. tt4574334.

Example:

"tt4574334"

show.ids.tmdb

string

TMDb show ID.

Example:

"66732"

show.ids.tvdb

string

TVDB show ID (integer) or slug (string).

Example:

"305288"

show.ids.netflix

string

Netflix show ID.

show.ids.hulu

string

Hulu show ID.

show.ids.traktslug

string

Trakt show slug.

show.ids.zap2it

string

Zap2it ID.

show.ids.tvcom

string

TV.com ID.

show.ids.mdl

string

MyDramaList slug or ID.

show.title

string

Example:

"Stranger Things"

show.year

integer

Example:

2016

anime

object

Anime reference. Pair with episode for series; an anime alone (no episode) is treated as an anime movie / OVA.

Hide child attributes

anime.ids

object

required

External IDs for an anime. Any one is enough; mal / anidb / anilist / kitsu are most useful for anime-only sources, while simkl, imdb, tmdb, and tvdb work for the cross-domain mapping.

Hide child attributes

anime.ids.simkl

integer

Simkl anime ID.

Example:

39687

anime.ids.slug

string

Simkl URL slug.

Example:

"shingeki-no-kyojin"

anime.ids.imdb

string

IMDb ID.

Example:

"tt2560140"

anime.ids.tmdb

string

TMDb show or movie ID (depending on anime_type).

Example:

"1429"

anime.ids.tvdb

string

TVDB show ID (integer) or slug (string).

Example:

"267440"

anime.ids.mal

string

MyAnimeList ID.

Example:

"16498"

anime.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"9541"

anime.ids.anilist

string

AniList ID.

Example:

"16498"

anime.ids.kitsu

string

Kitsu ID.

Example:

"7442"

anime.ids.anisearch

string

aniSearch ID.

anime.ids.animeplanet

string

Anime-Planet slug.

anime.ids.livechart

string

LiveChart ID.

anime.ids.anfo

string

AnimeNewsNetwork-style anfo ID.

anime.ids.ann

string

AnimeNewsNetwork ID.

anime.title

string

Example:

"Shingeki no Kyojin"

anime.year

integer

Example:

2013

episode

By season + number · object

Episode identifier. Use season + number, OR ids with a tvdb / anidb episode ID. If both are sent, episode.ids takes precedence (matches Plex-style integrations that have an episode ID but no season/number mapping).

By season + number
By episode ID

Hide child attributes

episode.season

integer

required

Season number. 0 is the specials season.

Required range: x >= 0

Example:

1

episode.number

integer

required

Episode number within the season.

Required range: x >= 1

Example:

3

episode.ids

object

External IDs for an episode. Only tvdb and anidb are accepted as scrobble episode-ID lookups. Pass either; if both are sent, tvdb is tried first.

Hide child attributes

episode.ids.tvdb

string

TVDB episode ID.

Example:

"4274616"

episode.ids.anidb

string

AniDB episode ID.

Example:

"142278"

Response

Created

Response for /scrobble/start, /scrobble/pause, /scrobble/stop and /scrobble/checkin.

rewatch_id and rewatch_status are present only on a scrobble action (a /scrobble/stop with progress >= 80) that was sent with ?allow_rewatch=yes. On every other call they are absent entirely.

integer

Playback event id for this call. 0 on /scrobble/start (the handler only assigns an id once the session is no longer just opening). Pass it to the playback-removal endpoint to undo a stop.

action

enum<string>

start for /start, pause for /pause and for /stop with progress<80, scrobble for /stop with progress≥80 (item marked watched).

Available options:

start,

pause,

scrobble

progress

number

Echo of the request progress, normalized.

movie

object

Standard movie object. See the Standard Media Objects guide.

Hide child attributes

movie.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

movie.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

movie.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

movie.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

movie.ids.tmdb

string

TMDb ID.

Example:

"296"

movie.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

movie.ids.mal

string

MyAnimeList ID.

Example:

"4246"

movie.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

movie.ids.anilist

string

AniList ID.

Example:

"21"

movie.ids.kitsu

string

Kitsu ID.

Example:

"12"

movie.ids.anisearch

string

aniSearch ID.

Example:

"2227"

movie.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

movie.ids.livechart

string

LiveChart ID.

Example:

"321"

movie.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

movie.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

movie.ids.hulu

string

Hulu episode ID.

movie.ids.crunchyroll

string

Crunchyroll episode ID.

movie.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

movie.title

string

Example:

"Terminator 3: Rise of the Machines"

movie.year

integer

Example:

2003

show

object

Standard show object. May include nested seasons/episodes for partial sync.

Hide child attributes

show.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

show.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

show.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

show.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

show.ids.tmdb

string

TMDb ID.

Example:

"296"

show.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

show.ids.mal

string

MyAnimeList ID.

Example:

"4246"

show.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

show.ids.anilist

string

AniList ID.

Example:

"21"

show.ids.kitsu

string

Kitsu ID.

Example:

"12"

show.ids.anisearch

string

aniSearch ID.

Example:

"2227"

show.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

show.ids.livechart

string

LiveChart ID.

Example:

"321"

show.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

show.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

show.ids.hulu

string

Hulu episode ID.

show.ids.crunchyroll

string

Crunchyroll episode ID.

show.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

show.title

string

Example:

"The Walking Dead"

show.year

integer

Example:

2010

show.seasons

object[]

Hide child attributes

show.seasons.number

integer

show.seasons.episodes

object[]

Hide child attributes

show.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

show.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

show.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

"2014-09-01T09:10:11Z"

show.seasons.episodes.ids

object

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

show.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

show.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

show.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

show.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

show.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

show.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

show.seasons.episodes.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

show.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

show.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

show.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

show.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

show.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

show.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

show.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

show.seasons.episodes.ids.hulu

string

Hulu episode ID.

show.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

show.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

anime

object

Standard anime object. Like Show, but may include anime_type. Episode numbering follows AniDB.

Hide child attributes

anime.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

anime.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

anime.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

anime.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

anime.ids.tmdb

string

TMDb ID.

Example:

"296"

anime.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

anime.ids.mal

string

MyAnimeList ID.

Example:

"4246"

anime.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

anime.ids.anilist

string

AniList ID.

Example:

"21"

anime.ids.kitsu

string

Kitsu ID.

Example:

"12"

anime.ids.anisearch

string

aniSearch ID.

Example:

"2227"

anime.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

anime.ids.livechart

string

LiveChart ID.

Example:

"321"

anime.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

anime.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

anime.ids.hulu

string

Hulu episode ID.

anime.ids.crunchyroll

string

Crunchyroll episode ID.

anime.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

anime.title

string

Example:

"Attack on Titan"

anime.year

integer

Example:

2013

anime.anime_type

enum<string>

Anime production format. tv is the common case; movies, OVAs, ONAs, and music videos all surface through the /anime/* endpoints with the same response shape.

Available options:

tv,

movie,

special,

ova,

ona,

music video

anime.episodes

object[]

Hide child attributes

anime.episodes.season

integer

Required range: x >= 0

Example:

1

anime.episodes.number

integer

Required range: x >= 1

Example:

2

anime.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

"2014-09-01T09:10:11Z"

anime.episodes.ids

object

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

anime.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

anime.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

anime.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

anime.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

anime.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

anime.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

anime.episodes.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

anime.episodes.ids.anilist

string

AniList ID.

Example:

"21"

anime.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

anime.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

anime.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

anime.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

anime.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

anime.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

anime.episodes.ids.hulu

string

Hulu episode ID.

anime.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

anime.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

episode

object

Episode object returned by the /scrobble/* endpoints. This is not the same shape as the Episode object accepted in sync request bodies: it carries a resolved title, and it has no ids map.

Hide child attributes

episode.season

integer

Simkl season number of the resolved episode.

episode.number

integer

Simkl episode number of the resolved episode.

episode.title

string

Episode title. Falls back to Episode <number> when no title is on file.

episode.tvdb_season

integer

Anime only, and only when the AniDB mapping differs: the original TVDB season number. Omitted for movies, for TV shows, and for anime movies.

episode.tvdb_number

integer

Anime only, and only when the AniDB mapping differs: the original TVDB episode number. Omitted for movies, for TV shows, and for anime movies.

rewatch_id

integer | null

Type 4 null — the watch did not land on a rewatch session. See Null and missing values.

The rewatch session this watch was recorded on. Present only when ?allow_rewatch=yes was sent and action is scrobble — otherwise the key is absent entirely.

A session that is already running reports its id even when it rejected this watch (for example inside the 2-day gap), so this field alone does not tell you the watch was recorded. Read rewatch_status for that.

rewatch_status

enum<string> | null

Type 4 null — the watch itself failed to record, so no rewatch was attempted. See Null and missing values.

What happened to this watch. Present only when ?allow_rewatch=yes was sent and action is scrobble — otherwise the key is absent entirely.

The first three values are session states, and mean the watch was recorded on a session of that state. The rest explain why no session took it. Note this is a superset of the three-value rewatch_status returned by GET /sync/all-items — do not reuse that enum here.

active — recorded on a session still in progress (typical for TV / anime). completed — recorded on a session that is now complete; movie sessions are created complete. closed — recorded on a session that was manually closed or left partial. first_watch — not a re-viewing; this is the original watch. too_soon — rejected by the 2-day gap between two watches of the same item. not_eligible — the item's watchlist status is plan-to-watch. pro_required — the account is not Simkl PRO or VIP.

Available options:

active,

completed,

closed,

first_watch,

too_soon,

not_eligible,

pro_required,

null

⌘I

API Reference

Trending

Calendar

Redirect

Auth

Scrobble

Playback

Sync

Custom Lists

Search

TV

Anime

Movies

Ratings

Users

Changes

Stop

Duplicate prevention

Seek and scrub behavior

Scrobble guide — full walkthrough

Rewatches

Authorizations

Headers

Query Parameters

Body

Response