> ## Documentation Index
> Fetch the complete documentation index at: https://api.simkl.org/llms.txt
> Use this file to discover all available pages before exploring further.
# Movie details
> Full detail record for one movie — title, overview, year, runtime, country, language, certification, genres, director, ratings, posters, fanart, external IDs, alternate titles, release-date list per region, budget, revenue, trailers, similar-movie recommendations. The default response is already complete; no flags needed.
Responses are **Cloudflare-cached by Simkl ID**, so repeat lookups of popular titles are near-free. Parallel requests against this endpoint are explicitly allowed (see [Rate limits → Parallel requests](/resources/rate-limits#parallel-requests--when-allowed)).
**Cache invalidation is automatic.** When Simkl updates the underlying record (admin edits, automated metadata refresh, image swap, related-titles change, etc.), the corresponding Cloudflare cache entry is purged server-side. The next call to this endpoint returns the fresh data — there's no TTL to wait out and no client-side cache-busting needed. Your own app-level cache, if any, still has to be invalidated by your client.
Use a Simkl ID for the lookup. If you only have an external ID, resolve it via [`GET /redirect`](/api-reference/redirect) first.
**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**](/conventions/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).
## OpenAPI
````yaml /openapi.json get /movies/{id}
openapi: 3.1.0
info:
title: Simkl API
version: 1.0.0
description: >-
The **Simkl API** lets you build apps that track Movies, TV Shows, and Anime
— scrobble playback, sync watch history, and pull rich metadata.
All requests use HTTPS and return JSON. The base URL is
`https://api.simkl.com`.
**Every request needs three URL parameters and a `User-Agent` header:**
```
/endpoint?client_id=YOUR_CLIENT_ID&app-name=my-app&app-version=1.0
```
See [Headers and required parameters](/conventions/headers) for the full
reference. Endpoints that read or modify a user's data also need an
`Authorization: Bearer ` header — see [OAuth
2.0](/api-reference/oauth) or the [PIN flow](/api-reference/pin).
> ⚠️ **About the auto-rendered cURL examples on each endpoint page:** they
omit `?client_id=…&app-name=…&app-version=…` from the URL for brevity. **You
must add them yourself when copy-pasting**, or use the interactive **"Try
it"** playground (it fills them in for you). This is a Mintlify rendering
convention — every Mintlify-built API doc behaves the same way.
**Get started**
- [Quickstart](/quickstart) — first request in 60 seconds
- [API rules](/api-rules) — what's allowed, what isn't
- [Standard media objects](/conventions/standard-media-objects) — the shapes
every endpoint speaks
- [Errors](/conventions/errors) — every status code Simkl returns
contact:
name: Simkl Developer Support
url: https://support.simkl.com
termsOfService: https://simkl.com/about/policies/terms/
license:
name: Simkl API Terms of Use
url: https://simkl.com/about/policies/terms/
x-logo:
url: https://i.simkl.com/img_tv/apiary_logo_api.png
backgroundColor: '#0E5DAB'
altText: Simkl
servers:
- url: https://api.simkl.com
description: Production API
- url: https://data.simkl.in
description: CDN for static, public data files (Calendar + Trending). No auth required.
security:
- clientId: []
- simklApiKey: []
tags:
- name: OAuth 2.0
description: >-
OAuth 2.0 authorization-code flow for web and mobile apps. The user is
redirected to Simkl, signs in, approves your app, and is redirected back
with a `code` you exchange for an `access_token`. Long-lived tokens — no
refresh-token flow needed.
externalDocs:
description: OAuth 2.0 walkthrough
url: https://api.simkl.org/api-reference/oauth
- name: PIN
description: >-
Device flow for TVs, consoles, smart watches, CLI tools — anywhere typing
a URL is hard. Show a 5-character code; user enters it on simkl.com/pin;
you poll for the access token. **No `client_secret` required.**
externalDocs:
description: PIN flow walkthrough
url: https://api.simkl.org/api-reference/pin
- name: Redirect
description: >-
Helper redirects for one-click "mark as watched", trailers, sharing, and
more.
- name: Search
description: Find shows, movies, and anime by ID, text query, file name, or randomly.
externalDocs:
description: Search guide
url: https://api.simkl.org/guides/search
- name: Movies
description: >-
Browse the Simkl movies catalog: details, premieres, top-of-best, and
genre filters.
- name: TV
description: >-
Browse the Simkl TV catalog: details, episodes, what's airing, premieres,
top-of-best, and genre filters.
- name: Anime
description: >-
Browse the Simkl anime catalog: details, episodes, what's airing,
premieres, top-of-best, and genre filters.
- name: Ratings
description: >-
Read Simkl's average community rating, rank, drop rate, and external
ratings (IMDB, MAL) for any item, or for every item in a user's lists.
- name: Scrobble
description: >-
Report real-time playback to Simkl with `start`, `pause`, and `stop`. At ≥
80 % progress Simkl marks the item as watched automatically; below 80 %
the session is saved as a paused playback the user can resume from any
device.
See [Standard media objects](/conventions/standard-media-objects) for the
supported ID keys.
### Supported ID keys
Inside any `ids` object, pass as many of these as you have. Simkl resolves
to the canonical record.
| ID key | Type | Example |
|---|---|---|
| `simkl` | integer | `49108`. Simkl's canonical ID. Most reliable. |
| `imdb` | string | `tt1520211` |
| `tmdb` | integer | `76757` (for TV, specify `type`) |
| `tvdb` | int / string | `153021` or `the-walking-dead` |
| `mal` | integer | `4246` (MyAnimeList) |
| `anidb` | integer | `10846`. Specifying just this is enough for anime
lookups. |
| `anilist` | integer | `21` |
| `kitsu` | integer | `12` |
| `anisearch` | integer | `2227` |
| `animeplanet` | string | `one-piece` |
| `livechart` | integer | `321` |
| `letterboxd` | string | `the-truman-show` |
| `netflix` | integer | `70210890` (movie ID) |
| `traktslug` | string | `john-wick-chapter-4-2023` |
> 📖 Full reference: [Standard media
objects](/conventions/standard-media-objects)
externalDocs:
description: Scrobble guide
url: https://api.simkl.org/guides/scrobble
- name: Sync
description: >-
Use Simkl as a cloud backup for the user's watch history and lists
(Watching, Plan to Watch, On Hold, Dropped, Completed). **Always check
[`/sync/activities`](/api-reference/simkl/get-activities) first** and sync
only the lists that have moved.
All write endpoints accept arrays — batch aggressively. See [Standard
media objects](/conventions/standard-media-objects) for the supported ID
keys.
### Supported ID keys
Inside any `ids` object, pass as many of these as you have. Simkl resolves
to the canonical record.
| ID key | Type | Example |
|---|---|---|
| `simkl` | integer | `49108`. Simkl's canonical ID. Most reliable. |
| `imdb` | string | `tt1520211` |
| `tmdb` | integer | `76757` (for TV, specify `type`) |
| `tvdb` | int / string | `153021` or `the-walking-dead` |
| `mal` | integer | `4246` (MyAnimeList) |
| `anidb` | integer | `10846`. Specifying just this is enough for anime
lookups. |
| `anilist` | integer | `21` |
| `kitsu` | integer | `12` |
| `anisearch` | integer | `2227` |
| `animeplanet` | string | `one-piece` |
| `livechart` | integer | `321` |
| `letterboxd` | string | `the-truman-show` |
| `netflix` | integer | `70210890` (movie ID) |
| `traktslug` | string | `john-wick-chapter-4-2023` |
> 📖 Full reference: [Standard media
objects](/conventions/standard-media-objects)
externalDocs:
description: Sync guide
url: https://api.simkl.org/guides/sync
- name: Users
description: User profile, settings, and watch statistics.
externalDocs:
description: Simkl API documentation
url: https://api.simkl.org
paths:
/movies/{id}:
get:
tags:
- Movies
summary: Movie details
description: >-
Full detail record for one movie — title, overview, year, runtime,
country, language, certification, genres, director, ratings, posters,
fanart, external IDs, alternate titles, release-date list per region,
budget, revenue, trailers, similar-movie recommendations. The default
response is already complete; no flags needed.
Responses are **Cloudflare-cached by Simkl ID**, so repeat lookups of
popular titles are near-free. Parallel requests against this endpoint
are explicitly allowed (see [Rate limits → Parallel
requests](/resources/rate-limits#parallel-requests--when-allowed)).
**Cache invalidation is automatic.** When Simkl updates the underlying
record (admin edits, automated metadata refresh, image swap,
related-titles change, etc.), the corresponding Cloudflare cache entry
is purged server-side. The next call to this endpoint returns the fresh
data — there's no TTL to wait out and no client-side cache-busting
needed. Your own app-level cache, if any, still has to be invalidated by
your client.
Use a Simkl ID for the lookup. If you only have an external ID, resolve
it via [`GET /redirect`](/api-reference/redirect) first.
**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**](/conventions/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).
operationId: get-movies-id
parameters:
- name: id
in: path
description: >-
**Simkl ID** for the item. Simkl IDs are stable, unambiguous, and
the response is Cloudflare-cached by Simkl ID, so repeat lookups are
very fast.
**If you only have an external ID** (IMDb, TMDB, TVDB, MAL, AniDB,
etc.), resolve it to a Simkl ID first via [`GET
/redirect`](/api-reference/redirect) — it returns the Simkl ID in
the `Location` header without a JSON payload, and the follow-up
detail call is Cloudflare-cached.
required: true
schema:
type: string
example: '472214'
- $ref: '#/components/parameters/ClientIdQuery'
- $ref: '#/components/parameters/AppNameQuery'
- $ref: '#/components/parameters/AppVersionQuery'
- $ref: '#/components/parameters/UserAgentHeader'
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/MovieDetail'
- type: array
items: {}
maxItems: 0
title: Empty (unknown Simkl ID)
description: Empty array `[]` — see `unknown_id_empty` example below.
examples:
inception:
summary: Modern blockbuster (Inception, simkl 472214)
description: >-
Full record for a popular modern movie. Carries the standard
`simkl`/`imdb` ratings, the common social-media IDs (`fb`,
`letterslug`, `traktmslug`, `jwslug`, `tvdbm`, etc.), an
extensive `release_dates` timeline per ISO 3166-1 country,
and the recommended-titles list. Examples below are
truncated to keep the doc compact; live responses carry the
full arrays.
value:
title: Inception
year: 2010
type: movie
ids:
simkl: 472214
slug: inception
tmdb: '27205'
imdb: tt1375666
tvdbmslug: inception
tvdbm: '113'
fb: inception
offen: http://inceptionmovie.warnerbros.com/
letterslug: inception
traktmslug: inception-2010
jwslug: inception
rank: 20
droprate: 0.1%
poster: 14/14017865947c9d3d0d
fanart: 27/2745964f37d66f1bb
released: '2010-07-15'
runtime: 148
director: Christopher Nolan
certification: PG-13
budget: 160000000
revenue: 839030630
overview: >-
Cobb, a skilled thief who commits corporate espionage by
infiltrating the subconscious of his targets is offered a
chance to regain his old life as payment for a task
considered to be impossible: "inception", the implantation
of another person's idea into a target's subconscious.
genres:
- Action
- Adventure
- Science Fiction
- Thriller
country: US
language: EN
alt_titles:
- name: Origine
lang: 17
type: official
- name: Inception
lang: 22
type: official
- name: Origine
lang: 7
type: synonym
ratings:
simkl:
rating: 8.6
votes: 11454
imdb:
rating: 8.8
votes: 2816410
trailers:
- name: Official Trailer
youtube: Jvurpf91omw
size: 1080
- name: Official New UK Trailer
youtube: JE9z-gy4De4
size: 1080
release_dates:
- iso_3166_1: US
results:
- type: 1
release_date: '2010-07-13'
- type: 3
release_date: '2010-07-16'
- type: 5
release_date: '2010-12-07'
- iso_3166_1: GB
results:
- type: 1
release_date: '2010-07-08'
- type: 3
release_date: '2010-07-16'
users_recommendations:
- title: Interstellar
year: 2014
poster: 20/2052598c2716ef054
type: movie
ids:
simkl: 250822
slug: interstellar
- title: The Dark Knight
year: 2008
poster: 16/16943077cdd27f0cc6
type: movie
ids:
simkl: 53282
slug: the-dark-knight
- title: Fight Club
year: 1999
poster: 53/53342766816af5a20
type: movie
ids:
simkl: 53894
slug: fight-club
classic_with_social_ids:
summary: >-
Classic film with extended social IDs (The Godfather, simkl
53434)
description: >-
A pre-internet classic. Notable because `ids` includes
`instagram` and `tw` (Twitter/X) handles that newer titles
often don't carry. Most fields are otherwise identical in
shape to the modern example.
value:
title: The Godfather
year: 1972
type: movie
ids:
simkl: 53434
slug: the-godfather
tmdb: '238'
imdb: tt0068646
fb: TheGodfather
instagram: TheGodfather
tw: thegodfather
letterslug: the-godfather
traktmslug: the-godfather-1972
jwslug: the-godfather
country: US
language: EN
released: '1972-03-14'
runtime: 175
director: Francis Ford Coppola
certification: R
genres:
- Drama
- Crime
ratings:
simkl:
rating: 8.9
votes: 3500
imdb:
rating: 9.2
votes: 2000000
unknown_id_empty:
summary: Unknown Simkl ID — empty array (Type 3 null)
description: >-
When the path Simkl ID is well-formed (numeric) but no
catalog record exists at that ID, the response is `200 []`,
not `404`. Treat as 'not found' — see [Null and missing
values · Type 3](/conventions/null-values#type-3). Empty
results are also cached.
value: []
'404':
$ref: '#/components/responses/NotFound'
'412':
$ref: '#/components/responses/ClientIdFailed'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/ServerError'
security:
- simklApiKey: []
components:
parameters:
ClientIdQuery:
name: client_id
in: query
required: true
description: >-
Your **`client_id`** from your [Simkl developer
settings](https://simkl.com/settings/developer/). Required on every
request.
schema:
type: string
example: YOUR_CLIENT_ID
AppNameQuery:
name: app-name
in: query
required: true
description: >-
Short, lowercase identifier for your app (e.g. `plex-scrobbler`,
`kodi-bridge`). Helps Simkl identify which apps are using the API.
schema:
type: string
example: my-app
AppVersionQuery:
name: app-version
in: query
required: true
description: >-
Your app's current version (e.g. `1.0`, `2.4.1`). Helps Simkl debug
issues you report.
schema:
type: string
example: '1.0'
UserAgentHeader:
name: User-Agent
in: header
required: true
description: >-
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)`.
schema:
type: string
example: my-app/1.0
schemas:
MovieDetail:
type: object
description: >-
Full movie record returned by `GET /movies/{id}`. The response shape is
the same regardless of any `extended` query value — the parameter is a
legacy no-op for this endpoint. Responses are Cloudflare-cached by Simkl
ID. See [Null and missing values](/conventions/null-values) for the
nullable-field semantics used below.
required:
- title
- year
- type
- ids
properties:
title:
type: string
description: >-
Display title in the response language (defaults to English unless
the request's `language` overrides it).
year:
type: integer
description: Release year.
type:
type: string
enum:
- movie
description: Always `movie` on this endpoint.
ids:
$ref: '#/components/schemas/Ids'
rank:
type:
- integer
- 'null'
description: >-
Type 4 null — data not on file in that field's slot. See [Null and
missing values](/conventions/null-values). Position in Simkl's
popularity ranking. Null when not ranked.
droprate:
type:
- string
- 'null'
description: >-
Percentage of users who started watching but dropped, e.g. `"0.1%"`.
Type 4 null when the metric isn't computed.
poster:
type:
- string
- 'null'
description: >-
Poster image path. Compose the full URL via
[Images](/conventions/images). Type 4 null when no poster on file.
fanart:
type:
- string
- 'null'
description: Background/hero image path. Type 4 null when no fanart on file.
released:
type:
- string
- 'null'
format: date
description: Initial release date (`YYYY-MM-DD`). Type 4 null when unknown.
runtime:
type:
- integer
- 'null'
description: Runtime in minutes. Type 4 null when not on file.
director:
type:
- string
- 'null'
description: Primary director. Type 4 null when unknown.
certification:
type:
- string
- 'null'
description: >-
Content rating (e.g. `PG-13`, `R`). Type 4 null when not rated for
the response country.
budget:
type:
- integer
- 'null'
description: Production budget in USD. Type 4 null when not on file.
revenue:
type:
- integer
- 'null'
description: Box-office revenue in USD. Type 4 null when not on file.
overview:
type:
- string
- 'null'
description: Plot synopsis. Type 4 null when no overview is available.
genres:
type: array
items:
type: string
description: Genre names.
country:
type: string
description: ISO 3166-1 alpha-2 production country code.
language:
type: string
description: ISO 639-1 language code in UPPERCASE.
alt_titles:
type: array
description: >-
Localized and alternate titles. May contain many entries for popular
titles.
items:
type: object
properties:
name:
type: string
lang:
type: integer
description: Simkl internal language code.
type:
$ref: '#/components/schemas/AltTitleType'
ratings:
type: object
description: Ratings keyed by source. Movies always carry `simkl` and `imdb`.
properties:
simkl:
$ref: '#/components/schemas/ExternalRating'
imdb:
$ref: '#/components/schemas/ExternalRating'
additionalProperties:
$ref: '#/components/schemas/ExternalRating'
trailers:
type:
- array
- 'null'
description: >-
YouTube-hosted trailers and promo clips. Type 4 null when no
trailers on file.
items:
type: object
required:
- youtube
properties:
name:
type:
- string
- 'null'
description: >-
Type 4 null — data not on file in that field's slot. See [Null
and missing values](/conventions/null-values).
youtube:
type: string
description: YouTube video ID (not a full URL).
size:
type:
- integer
- 'null'
description: >-
Type 4 null — data not on file in that field's slot. See [Null
and missing values](/conventions/null-values). Max video
resolution height (720, 1080, 2160).
release_dates:
type: array
description: Per-country release event timeline.
items:
type: object
required:
- iso_3166_1
- results
properties:
iso_3166_1:
type: string
description: ISO 3166-1 alpha-2 country code.
results:
type: array
items:
type: object
required:
- type
- release_date
properties:
type:
type: integer
description: >-
Release-event type: 1 = premiere, 2 = theatrical
limited, 3 = theatrical wide, 4 = digital, 5 = physical,
6 = TV.
release_date:
type: string
format: date
users_recommendations:
type: array
description: Mini media objects suggested by Simkl based on this title's viewers.
items:
type: object
properties:
title:
type: string
year:
type:
- integer
- 'null'
description: >-
Type 4 null — data not on file in that field's slot. See [Null
and missing values](/conventions/null-values).
poster:
type:
- string
- 'null'
description: >-
Type 4 null — data not on file in that field's slot. See [Null
and missing values](/conventions/null-values).
type:
type: string
ids:
type: object
properties:
simkl:
type: integer
slug:
type: string
additionalProperties: true
Ids:
type: object
description: >-
External and internal identifiers for an item. Pass as many as you have
— Simkl resolves to the canonical record.
properties:
simkl:
type: integer
description: Simkl internal ID. Most reliable.
example: 53536
slug:
type: string
description: URL-safe slug returned in responses.
example: attack-on-titan
imdb:
type: string
description: IMDb ID.
example: tt0181852
tmdb:
type: string
description: TMDb ID.
example: '296'
tvdb:
oneOf:
- type: integer
- type: string
description: TVDB ID or slug.
example: 153021
mal:
type: string
description: MyAnimeList ID.
example: '4246'
anidb:
type: string
description: AniDB ID. Specifying just this is enough for anime lookups.
example: '10846'
anilist:
type: string
description: AniList ID.
example: '21'
kitsu:
type: string
description: Kitsu ID.
example: '12'
anisearch:
type: string
description: aniSearch ID.
example: '2227'
animeplanet:
type: string
description: Anime-Planet slug.
example: one-piece
livechart:
type: string
description: LiveChart ID.
example: '321'
letterboxd:
type: string
description: Letterboxd slug.
example: the-truman-show
netflix:
type: string
description: Netflix movie ID.
example: '70210890'
hulu:
type: string
description: Hulu episode ID.
crunchyroll:
type: string
description: Crunchyroll episode ID.
traktslug:
type: string
description: Trakt slug.
example: john-wick-chapter-4-2023
additionalProperties: true
example:
simkl: 53536
imdb: tt0181852
tmdb: 296
AltTitleType:
type: string
enum:
- official
- short
- synonym
- original
description: >-
Classification of an entry in `alt_titles`. `official` =
broadcaster/distributor-supplied localization, `short` = shortened form,
`synonym` = community-supplied alias, `original` = original-language
title (typically Japanese for anime).
ExternalRating:
type: object
description: External-source rating.
properties:
rating:
type: number
minimum: 0
maximum: 10
description: Rating value (0–10).
votes:
type: integer
description: Number of votes contributing to the rating.
ErrorResponse:
type: object
description: >-
Standard error envelope for 4xx and 5xx responses. Branch on `error`
(machine-readable identifier) — `message`, when present, is
human-readable guidance and is **not stable across releases**.
properties:
error:
type: string
description: >-
Machine-readable error identifier. Stable across responses — use
this for programmatic branching in client code. Examples:
`user_token_failed`, `client_id_failed`, `empty_field`,
`wrong_parameter`, `id_err`, `rate_limit`.
example: user_token_failed
code:
type: integer
description: >-
HTTP status code echoed in the body for convenience — same value as
the response status line. Always an integer.
example: 401
message:
type: string
description: >-
Human-readable error guidance. Optional — present on most errors,
but not guaranteed. May reference the specific field or value that
triggered the error. NOT stable; do not parse.
example: Your client_id is wrong. Try another one
required:
- error
- code
responses:
NotFound:
description: The requested item ID or URL does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: id_err
code: 404
ClientIdFailed:
description: >-
Your `client_id` is missing, wrong, disabled, or has hit a request
limit. Verify in your [developer
settings](https://simkl.com/settings/developer/).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: client_id_failed
code: 412
message: Your client_id is wrong. Try another one
RateLimited:
description: >-
Too many requests in too short a window. Back off and retry with
exponential backoff — see [Rate limits](/resources/rate-limits) for the
playbook.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: rate_limit
code: 429
ServerError:
description: >-
Something is broken on Simkl's side. Retry after a short delay. If it
persists, report on the [Simkl Discord](https://discord.gg/MJsWNE4).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: internal
code: 500
securitySchemes:
clientId:
type: apiKey
in: query
name: client_id
description: >-
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](/conventions/headers).
x-default: YOUR_CLIENT_ID
simklApiKey:
type: apiKey
in: header
name: simkl-api-key
description: >-
Optional alias for the `client_id` query parameter. Simkl accepts your
`client_id` either as the `simkl-api-key` request header **or** as the
`?client_id=…` query parameter — pick one. The query-parameter form is
preferred because it makes the request fully self-describing in URL
form.
x-default: YOUR_CLIENT_ID
````