Metadata API
The service the Cineloo app uses to recognise movies and shows. JSON format, version 1.
| Endpoint | ||
|---|---|---|
| GET | /api/v1/status | Sources, image sizes, limits |
| GET | /api/v1/search?type=movie&query=Le+Grand+Voyage&year=2024&lang=fr-CH | Search movies (type=movie) or shows (type=tv) |
| GET | /api/v1/movie/{tmdb_id}?lang=fr-FR | Movie details, cast, certification, trailers |
| GET | /api/v1/tv/{tmdb_id}?lang=fr-FR | Show details and season list |
| GET | /api/v1/tv/{tmdb_id}/season/{n}?lang=fr-FR | Episodes of a season |
| GET | /api/v1/find/{imdb_id}?lang=fr-FR | Look up by IMDb id (tt…) |
| GET | /api/v1/image/{size}/{file} | Cached TMDB image (poster, backdrop, profile, still) |
Headers
Required: X-Cineloo-Key: <key> (or Authorization: Bearer <key>) on every endpoint except /api/v1/status. Keys are issued by Cineloo.org; the Cineloo application ships with its own. Without a valid key the relay answers 401 (missing_key, invalid_key or revoked_key).
Optional: X-Cineloo-Version: 0.25.0 · X-Cineloo-Client: <random install id>
Example
curl -H 'X-Cineloo-Key: clk_…' 'https://www.cineloo.org/api/v1/search?type=movie&query=Dune&year=2021&lang=fr-FR'
{
"ok": true, "source": "tmdb", "cache": "hit",
"images": { "base_url": "https://www.cineloo.org/api/v1/image/", "poster_sizes": ["w92", "w154", "w185", "w342", "w500", "w780", "original"], … },
"data": { "type": "movie", "query": "Dune", "year": 2021, "results": [
{ "id": 438631, "title": "Dune", "year": 2021, "poster_path": "/…jpg", … }
] }
}
Errors: {"ok": false, "error": {"code": "not_found"}} with HTTP 400, 401, 404, 429 (Retry-After), 502 or 503.
This product uses the TMDB API but is not endorsed or certified by TMDB.
