Skip to main content
GET
/
search
/
id
curl -H "User-Agent: my-app-name/1.0" \ "https://api.simkl.com/search/id?imdb=tt1375666&client_id=YOUR_CLIENT_ID&app-name=my-app-name&app-version=1.0"
[ { "type": "movie", "title": "Inception", "poster": "14/14017865947c9d3d0d", "year": 2010, "status": "released", "ids": { "simkl": 472214, "slug": "inception" } } ]

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.

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.

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

simkl
integer

Simkl id.

hulu
integer

hulu_id. All other parameters can be empty if this one specified.

netflix
integer

Netflix movieid, this parameter is in beta and may not work.

mal
integer

MyAnimeList id.

tvdb
string

TVDB ID. All other parameters can be empty if this one specified.

tmdb
integer

The Movie Database (TMDb) ID. All other parameters can be empty if this one specified. type parameter is required if you want to search for TV Shows

imdb
string

can be IMDB ID or full IMDB URL. All other parameters can be empty if this one specified.

Pattern: ^tt\d+$
anidb
integer

AniDB ID. All other parameters can be empty if this one specified.

crunchyroll
string

Crunchyroll ID. You can pass episode ID or url ID(sword-art-online)

anilist
integer

AniList ID

kitsu
integer

Kitsu ID

livechart
integer

LiveChart ID

anisearch
integer

aniSearch ID

animeplanet
string

Anime-Planet ID

type
enum<string>

Only used when sending tmdb.

Available options:
show,
movie
title
string

TV show, anime, or movie title. If this title has more then 1 item then null will be returned, add more fields to narrow down the search to 1 item(such as type,year etc.)

year
integer

release year.

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.

anfo
string

AniFox / anfo.org ID. Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

ann
integer

Anime News Network (ANN) ID. Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

tvcom
string

TV.com ID (legacy). Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

zap2it
string

Zap2it (TVScheduleDirect) ID. Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

traktslug
string

Trakt URL slug. Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

letterboxd
string

Letterboxd film slug (movies). Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

boxd
string

Letterboxd alias — same as letterboxd. Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

mdl
string

MyDramaList slug or ID (Korean / Asian dramas). Returns the matching Simkl title(s). See Standard media objects → Supported ID keys.

Response

Array of matching catalog records — [] when no record matches the supplied IDs. There is no 404 for unknown IDs; an empty array is the not-found shape (Type 3 null — see Null and missing values).

type
enum<string>
required

Catalog category. Determines which detail endpoint to call next (/movies/{id} vs /tv/{id} vs /anime/{id}).

Available options:
movie,
tv,
anime
title
string
required

Display title in the canonical (often non-English) form. For an English-localized title use the per-type detail endpoint.

status
enum<string>
required

Release / airing status. released / upcoming apply to movies; ended / aired / tba apply to TV and anime. Note this enum is broader than the closed {tba, ended, airing} set the detail endpoints (/tv/{id}, /anime/{id}) use — /search/id is built on a different code path.

Available options:
released,
upcoming,
ended,
aired,
tba
ids
object
required

Identifiers returned inside each /search/id result item. The server returns ONLY simkl and slug here — even when you queried by imdb, tmdb, tvdb, mal, etc., the response does NOT echo the input ID back in this block. To get the full canonical external-ID set for the matched record, follow up with the per-type detail endpoint (GET /movies/{simkl}, GET /tv/{simkl}, GET /anime/{simkl}) — those carry the full ID set.

poster
string | null

Type 4 null — data not on file in that field's slot. See Null and missing values. Poster image path. See Images for how to build the URL.

year
integer | null

Type 4 null — data not on file in that field's slot. See Null and missing values.

total_episodes
integer

Total episode count. Omitted for movies (only present on type: tv and type: anime).

anime_type
enum<string>

Only present on type: anime items. Distinguishes the anime catalog format (tv, movie, ova, ona, special, music video).

Available options:
tv,
movie,
special,
ova,
ona,
music video
mal
object

Only present on type: anime items when Simkl has MAL metadata on file. {id, type} echoes the MyAnimeList record this entry maps to.