API 레퍼런스는 영어로만 제공됩니다.
Discoverylookup
GET/v1/ lookup
Turn one external identifier - IMDb, TMDB, TVDB - or a catalog UUID into our title id, with every identifier we hold for it. Spends no verification.
파라미터
- imdb_idstring선택 사항
An IMDb id, e.g.
tt9218128. Supply exactly one of the four identifiers.더 보기
An IMDb id (for example
tt9218128). Supply exactly ONE ofimdb_id,tmdb_id,tvdb_idanduuid; none or several is a 400. - tmdb_idstring선택 사항
A TMDB id. Exactly one identifier; a number shared by a film and a series is a 409.
더 보기
A TMDB id. Supply exactly one identifier. TMDB numbers films, series, seasons and episodes separately, so a number that matches more than one of them is a 409 rather than a guess.
- tvdb_idstring선택 사항
A TVDB id. Exactly one identifier.
더 보기
A TVDB id. Supply exactly one of the four identifiers.
- uuidstring · uuid선택 사항
A catalog UUID. Exactly one identifier.
더 보기
A catalog UUID in canonical 8-4-4-4-12 form. Supply exactly one of the four identifiers.
- languagestring선택 사항
Response language, a supported BCP-47 tag. Default
en.더 보기
A supported BCP-47 tag. Defaults to
en. An UNSUPPORTED tag is a 400 naming the accepted set, never a silent fallback - the catalogue stores match the 17 tags as exact strings, so degrading would answer an empty 200 that an integrator would ship before noticing.
응답 필드
- idstring
- uuidstring · uuid
- typestring
- titlestring
- yearintegernull 허용
- matched_onpublic_id | uuid | slug | imdb_id | tmdb_id | tvdb_id
WHICH identifier resolved the lookup. The one field of this response a caller cannot derive from the rest, and the reason a caller passing a mixed batch can tell what we matched on.
- external_idsobject · ExternalIds
EVERY external id we hold, not just the one asked with. The point of a lookup is to cross a namespace, so echoing back only the key supplied would answer nothing.
응답 헤더
- X-Request-ID
The id of this request, on every response - success or error. Quote it to support: it is how we find your request in our logs. An
X-Request-IDyou send is honoured and echoed back, so you can use your own; otherwise we generate one./v1error bodies carry no trace id of their own. - X-Quota-Reset
RFC 3339 instant at which the billing period rolls. Present on every response to a request whose key was metered - every 2xx, every error a handler returned, and the quota 429. Absent on a refusal that happens before metering: a missing or unknown key (401), a restricted key or a plan that does not carry the endpoint (403), a public demo-key gate refusal, and the pre-authentication flood throttle.
- X-Calls-Remaining
Requests left in the period after this one, never below 0. Present whenever
X-Quota-Resetis (see there for when a response carries no quota headers). - X-Verifications-Remaining
How many verifications you can still make before a limit stops you. The daily limit and the monthly allowance are counted separately; this is whichever of the two runs out first. Sent whenever
X-Quota-Resetis. - X-Quota-Grace
truewhen THIS request fell inside the 10% grace band above a monthly ceiling. A grace request is served and is not billed; treattrueas "back off now", not as headroom. Alwaystrueorfalse, never absent when the other quota headers are present. - Retry-After429
Seconds to wait before retrying. On every 429 - the quota hard stop, the public demo key's limits, and the pre-authentication flood throttle (which carries this header alone, because no key has been read yet).
- X-Demo-Challenge-Mode데모 키에서만
Sent only on responses to the public demo key. The value
interactiveasks the documentation page to show the visible verification widget - it is sent once a browser has made more than five runs in ten minutes or has received a 429. The page then repeats the header,X-Demo-Challenge-Mode: interactive, on its next request, with the widget's token inX-Demo-Challenge. Requests made with your own key never receive it.
오류
세부 정보
Cross-namespace identity resolution.
Exactly one of imdb_id, tmdb_id, tvdb_id, uuid. None or several is a 400 - accepting several and picking one silently would make the answer depend on an ordering nobody published.
Spends nothing. The metered unit is a verification, not a lookup - the naming collision is real and the resolution is deliberate.