curl --request POST \
  --url 'https://api.simkl.com/sync/add-to-list?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --data '{}'

{
  "added": {
    "movies": [],
    "shows": [
      {
        "to": "completed",
        "ids": {
          "simkl": 831411
        },
        "type": "show",
        "anime_type": "tv"
      }
    ]
  },
  "not_found": {
    "movies": [],
    "shows": []
  }
}

Add to Watchlist

Move an item into one of the user’s Watchlist statuses. The body’s per-item to field selects the destination:

Most apps prefer POST /sync/history for sync flows. Use this endpoint (/sync/add-to-list) only when your app has explicit “Add to Plan to Watch” / “Move to Hold” UI buttons — i.e. setting watchlist status without recording a watch event. For backfill from another tracker, scrobbling, or marking-watched UI, send to /sync/history instead (which carries status, rating, memo, AND the watch event in one shape).

Don’t chain /sync/history then /sync/add-to-list — the history call already moves the item. POST /sync/history automatically places (and re-classifies) the item on the right Watchlist based on the watch event. Read added.statuses[].response.status in the history response to see the resolved status — e.g. a "completed" write on a still-airing show is silently downgraded to "watching" and reflected there. A follow-up /sync/add-to-list call is redundant and may overwrite the server’s smarter decision.

See the Sync guide for the two-phase pull/delta pattern.

This endpoint does not save memos. If you include a memo field per item, the request succeeds and the memo is echoed back in the response — but the value is not persisted; reading the item with ?memos=yes afterwards returns memo: {}. To set or update a memo, send the item to POST /sync/history with ids + status + memo. /sync/history also auto-adds the item to the watchlist if it wasn’t there yet, so a single call covers both “add the item” and “set the memo”.

`to` value	Destination
`watching`	Currently watching. (For movies, automatically becomes `completed` since movies are atomic.)
`plantowatch`	Plan to watch.
`hold`	On hold.
`dropped`	Dropped.
`completed`	Completed.

to is per-item (each entry in the array carries its own destination). The legacy top-level to shape is not accepted — the server returns 400 empty_field (Missed "to" parameter) when to only appears at the top level.

You don’t need a Simkl ID. The server resolves any combination of identifiers via its internal Search — pass whatever IDs your app already has and skip the /redirect lookup step. Identifier slots accepted on each item:

Slot	Notes
`ids.simkl`	Simkl internal ID. Always wins when present.
`ids.imdb`	IMDb ID (e.g. `tt1375666`). Works for movies and shows.
`ids.tmdb`	TMDB ID. Works for movies and shows.
`ids.tvdb`	TVDB ID. Most-used canonical for TV in media-server stacks (Plex, Sonarr, Jellyfin, Kodi).
`ids.mal` / `ids.anidb` / `ids.anilist` / `ids.kitsu`	Anime catalogs. Send any/all you have.
`ids.slug`	URL slug — useful when you only have a Simkl-shaped link.
`title` + `year` (no `ids` at all)	Text fallback. Fuzzy match; ambiguous titles may miss — inspect `not_found` in the response.

Send everything you have. The server picks the first identifier that resolves and accepts the extras. This is the canonical shape for migrations from another tracker (Trakt → Simkl, IMDb-list import, Letterboxd export, etc.) — just forward whatever the source carried.

{
 "movies": [
 {
 "to": "completed",
 "title": "Inception",
 "year": 2010,
 "ids": {
 "simkl": 472214,
 "imdb": "tt1375666",
 "tmdb": "27205"
 }
 }
 ],
 "shows": [
 {
 "to": "watching",
 "title": "Game of Thrones",
 "year": 2011,
 "ids": {
 "simkl": 17465,
 "slug": "game-of-thrones",
 "imdb": "tt0944947",
 "tmdb": "1399",
 "tvdb": "121361"
 }
 }
 ]
}

Optional per-item fields: watched_at, added_at.

To remove an item, use POST /sync/history/remove. This endpoint operates on the Watchlist (the five statuses above); the canonical un-track / delete-from-list path is /sync/history/remove, which writes to the same backing store and returns the same kind of result envelope. A legacy to: "remove" value is accepted by this endpoint for backwards compatibility, but it is undocumented and should not be used in new integrations — Simkl reserves the right to change its behavior without notice.

Response: `added` and `not_found`

The response always returns 201 (even on partial failures) with two arrays per media-type:

{
 "added": {
 "movies": [{ "to": "completed", "ids": {...}, "type": "movie" }],
 "shows": [{ "to": "watching", "ids": {...}, "type": "show" }]
 },
 "not_found": {
 "movies": [{ "title": "Definitely Not A Real Movie", "year": 9999 }],
 "shows": []
 }
}

Items the server’s resolver matched land in added. Items it couldn’t match (typos, fuzzy title misses, IDs not in Simkl’s catalog yet) land in not_found — verbatim copies of the input so you can show “we couldn’t add: …” in your UI. Always inspect both arrays after a bulk call.

Errors: 400 empty_field if to is missing on an item; 400 wrong_parameter if to is not one of the values above.

Silent `to` rewrites

The server may downgrade your requested to value when an item isn’t in a state where that status applies:

Movies with to: "watching" → silently rewritten to completed (movies are atomic; you can’t “be watching” a movie).
Shows that aren’t ready for completed (still airing, or pre-release) get rewritten to watching or plantowatch respectively, depending on whether any episode has aired.

The rewrites happen server-side; the consumer just sees the actual stored value in added.<type>[i].to. There is no error code surfaced for the rewrite — the only way to detect it is to compare the value you sent against the value that came back.

Note: this endpoint operates on the Simkl Watchlist (the five canonical statuses above). Custom user-created lists will get their own API in a future release.

Sync guide — full walkthrough

Two-phase model (initial pull → activities-checked delta loop), date_from semantics, deletion reconciliation, edge cases, and reference implementations in Node and Python.

Anime titles: can go in either the anime[] array OR the shows[] array — both are accepted. The server normalizes anime into the response’s shows array with "type": "show" per-item, since anime are TV-like in the cross-catalog data model. AniDB-specific IDs (mal, anidb, anilist, kitsu) belong inside each item’s ids object regardless of which array it lives in. See Anime under shows[].

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).

POST

sync

add-to-list

curl --request POST \
  --url 'https://api.simkl.com/sync/add-to-list?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --data '{}'

{
  "added": {
    "movies": [],
    "shows": [
      {
        "to": "completed",
        "ids": {
          "simkl": 831411
        },
        "type": "show",
        "anime_type": "tv"
      }
    ]
  },
  "not_found": {
    "movies": [],
    "shows": []
  }
}

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.

Body

application/json

Body for POST /sync/add-to-list. Moves items into one of the user's Watchlist statuses. Items go under movies[], shows[], or anime[] — Simkl resolves anime titles correctly under either shows[] or anime[], so match the field to your data type when known.

enum<string>

required

User watchlist status. Movies skip watching and hold — see /conventions/list-statuses.

Available options:

watching,

plantowatch,

hold,

completed,

dropped

movies

object[]

Hide child attributes

movies.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

movies.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

movies.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

movies.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

movies.ids.tmdb

string

TMDb ID.

Example:

"296"

movies.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

movies.ids.mal

string

MyAnimeList ID.

Example:

"4246"

movies.ids.anidb

string

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

Example:

"10846"

movies.ids.anilist

string

AniList ID.

Example:

"21"

movies.ids.kitsu

string

Kitsu ID.

Example:

"12"

movies.ids.anisearch

string

aniSearch ID.

Example:

"2227"

movies.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

movies.ids.livechart

string

LiveChart ID.

Example:

"321"

movies.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

movies.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

movies.ids.hulu

string

Hulu episode ID.

movies.ids.crunchyroll

string

Crunchyroll episode ID.

movies.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

movies.title

string

Example:

"Terminator 3: Rise of the Machines"

movies.year

integer

Example:

2003

shows

object[]

Hide child attributes

shows.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

shows.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

shows.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

shows.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

shows.ids.tmdb

string

TMDb ID.

Example:

"296"

shows.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

shows.ids.mal

string

MyAnimeList ID.

Example:

"4246"

shows.ids.anidb

string

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

Example:

"10846"

shows.ids.anilist

string

AniList ID.

Example:

"21"

shows.ids.kitsu

string

Kitsu ID.

Example:

"12"

shows.ids.anisearch

string

aniSearch ID.

Example:

"2227"

shows.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

shows.ids.livechart

string

LiveChart ID.

Example:

"321"

shows.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

shows.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

shows.ids.hulu

string

Hulu episode ID.

shows.ids.crunchyroll

string

Crunchyroll episode ID.

shows.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

shows.title

string

Example:

"The Walking Dead"

shows.year

integer

Example:

2010

shows.seasons

object[]

Hide child attributes

shows.seasons.number

integer

shows.seasons.episodes

object[]

Hide child attributes

shows.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

shows.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

shows.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

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

shows.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

shows.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

shows.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

shows.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

shows.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

shows.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

shows.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

shows.seasons.episodes.ids.anidb

string

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

Example:

"10846"

shows.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

shows.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

shows.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

shows.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

shows.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

shows.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

shows.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

shows.seasons.episodes.ids.hulu

string

Hulu episode ID.

shows.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

shows.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

anime

object[]

Array of anime entries (same shape as shows[]).

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:

"The Walking Dead"

anime.year

integer

Example:

2010

anime.seasons

object[]

Hide child attributes

anime.seasons.number

integer

anime.seasons.episodes

object[]

Hide child attributes

anime.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

anime.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

anime.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

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

anime.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

anime.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

anime.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

anime.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

anime.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

anime.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

anime.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

anime.seasons.episodes.ids.anidb

string

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

Example:

"10846"

anime.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

anime.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

anime.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

anime.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

anime.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

anime.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

anime.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

anime.seasons.episodes.ids.hulu

string

Hulu episode ID.

anime.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

anime.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

Response

Response from POST /sync/add-to-list.

added

object

Hide child attributes

added.movies

object[]

Hide child attributes

added.movies.title

string

Example:

"The Walking Dead"

added.movies.year

integer

Example:

2010

added.movies.to

enum<string>

User watchlist status. Movies skip watching and hold — see /conventions/list-statuses.

Available options:

watching,

plantowatch,

hold,

completed,

dropped

added.movies.ids

object

Echoed IDs from the request.

added.shows

object[]

Hide child attributes

added.shows.title

string

Example:

"The Walking Dead"

added.shows.year

integer

Example:

2010

added.shows.to

enum<string>

User watchlist status. Movies skip watching and hold — see /conventions/list-statuses.

Available options:

watching,

plantowatch,

hold,

completed,

dropped

added.shows.ids

object

Echoed IDs from the request.

added.anime

object[]

Hide child attributes

added.anime.title

string

Example:

"The Walking Dead"

added.anime.year

integer

Example:

2010

added.anime.to

enum<string>

User watchlist status. Movies skip watching and hold — see /conventions/list-statuses.

Available options:

watching,

plantowatch,

hold,

completed,

dropped

added.anime.ids

object

Echoed IDs from the request.

not_found

object

Items Simkl could not match. Inspect this to surface diagnostics back to your users. Anime entries that fail to resolve land in shows regardless of which top-level array they were sent under — there is no separate anime bucket in not_found.

Hide child attributes

not_found.movies

object[]

Hide child attributes

not_found.movies.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

not_found.movies.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

not_found.movies.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

not_found.movies.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

not_found.movies.ids.tmdb

string

TMDb ID.

Example:

"296"

not_found.movies.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

not_found.movies.ids.mal

string

MyAnimeList ID.

Example:

"4246"

not_found.movies.ids.anidb

string

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

Example:

"10846"

not_found.movies.ids.anilist

string

AniList ID.

Example:

"21"

not_found.movies.ids.kitsu

string

Kitsu ID.

Example:

"12"

not_found.movies.ids.anisearch

string

aniSearch ID.

Example:

"2227"

not_found.movies.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

not_found.movies.ids.livechart

string

LiveChart ID.

Example:

"321"

not_found.movies.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

not_found.movies.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

not_found.movies.ids.hulu

string

Hulu episode ID.

not_found.movies.ids.crunchyroll

string

Crunchyroll episode ID.

not_found.movies.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

not_found.movies.title

string

Example:

"Terminator 3: Rise of the Machines"

not_found.movies.year

integer

Example:

2003

not_found.shows

object[]

Hide child attributes

not_found.shows.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

not_found.shows.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

not_found.shows.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

not_found.shows.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

not_found.shows.ids.tmdb

string

TMDb ID.

Example:

"296"

not_found.shows.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

not_found.shows.ids.mal

string

MyAnimeList ID.

Example:

"4246"

not_found.shows.ids.anidb

string

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

Example:

"10846"

not_found.shows.ids.anilist

string

AniList ID.

Example:

"21"

not_found.shows.ids.kitsu

string

Kitsu ID.

Example:

"12"

not_found.shows.ids.anisearch

string

aniSearch ID.

Example:

"2227"

not_found.shows.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

not_found.shows.ids.livechart

string

LiveChart ID.

Example:

"321"

not_found.shows.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

not_found.shows.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

not_found.shows.ids.hulu

string

Hulu episode ID.

not_found.shows.ids.crunchyroll

string

Crunchyroll episode ID.

not_found.shows.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

not_found.shows.title

string

Example:

"The Walking Dead"

not_found.shows.year

integer

Example:

2010

not_found.shows.seasons

object[]

Hide child attributes

not_found.shows.seasons.number

integer

not_found.shows.seasons.episodes

object[]

Hide child attributes

not_found.shows.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

not_found.shows.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

not_found.shows.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

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

not_found.shows.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

not_found.shows.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

not_found.shows.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

not_found.shows.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

not_found.shows.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

not_found.shows.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

not_found.shows.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

not_found.shows.seasons.episodes.ids.anidb

string

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

Example:

"10846"

not_found.shows.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

not_found.shows.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

not_found.shows.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

not_found.shows.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

not_found.shows.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

not_found.shows.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

not_found.shows.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

not_found.shows.seasons.episodes.ids.hulu

string

Hulu episode ID.

not_found.shows.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

not_found.shows.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

not_found.episodes

object[]

Hide child attributes

not_found.episodes.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

not_found.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

not_found.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

not_found.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

not_found.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

not_found.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

not_found.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

not_found.episodes.ids.anidb

string

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

Example:

"10846"

not_found.episodes.ids.anilist

string

AniList ID.

Example:

"21"

not_found.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

not_found.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

not_found.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

not_found.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

not_found.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

not_found.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

not_found.episodes.ids.hulu

string

Hulu episode ID.

not_found.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

not_found.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

not_found.episodes.title

string

Example:

"The Walking Dead"

not_found.episodes.year

integer

Example:

2010

not_found.episodes.seasons

object[]

Hide child attributes

not_found.episodes.seasons.number

integer

not_found.episodes.seasons.episodes

object[]

Hide child attributes

not_found.episodes.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

not_found.episodes.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

not_found.episodes.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

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

not_found.episodes.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

not_found.episodes.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

not_found.episodes.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

not_found.episodes.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

not_found.episodes.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

not_found.episodes.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

not_found.episodes.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

not_found.episodes.seasons.episodes.ids.anidb

string

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

Example:

"10846"

not_found.episodes.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

not_found.episodes.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

not_found.episodes.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

not_found.episodes.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

not_found.episodes.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

not_found.episodes.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

not_found.episodes.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

not_found.episodes.seasons.episodes.ids.hulu

string

Hulu episode ID.

not_found.episodes.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

not_found.episodes.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

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

⌘I

API Reference

Trending

Calendar

Redirect

Auth

Scrobble

Playback

Sync

Custom Lists

Search

TV

Anime

Movies

Ratings

Users

Changes

Add to Watchlist

Response: `added` and `not_found`

Silent `to` rewrites

Sync guide — full walkthrough

Authorizations

Headers

Query Parameters

Body

Response