URL shape & idTypes
The URL shape
Section titled “The URL shape”GET https://api.aioratings.com/{key}/{idType}/{style}/{id}.jpg| Segment | Values | Notes |
|---|---|---|
{key} | your API key, or h.{hash} | The hashed form fetches posters but is not an account credential. |
{idType} | imdb · tmdb · tvdb | See the table below. |
{style} | poster-default, or a profile | poster-default is the built-in style; custom profiles are premium/pro. |
{id} | the title id | Format depends on {idType}. |
.jpg | .jpg | The poster file extension. |
Supported idTypes and media-id formats
Section titled “Supported idTypes and media-id formats”| idType | mediaId format | Example |
|---|---|---|
imdb | IMDb id, with or without the tt prefix | tt0903747 or 0903747 |
tmdb | movie-{id} or tv-{id} | movie-1396, tv-1396 |
tvdb | TVDB numeric id | 81189 |
Notes:
- For
imdb, the leadingttis optional — the API normalizes it. - For
tmdb, you must include the media-type prefix (movie-ortv-), because a TMDB numeric id alone is ambiguous between a movie and a TV show. - The id may also carry
movie-/series-/episode-prefixes (RPDB style); these are tolerated and normalized.
Endpoint families
Section titled “Endpoint families”poster-default is the poster endpoint. The aioratings render engine also
exposes backdrop, logo and episode-still endpoints — see
Endpoints for the full list and their URL shapes.
File extension behavior
Section titled “File extension behavior”.jpg— the poster, backdrop and episode-still file extension; widely compatible with every media tool.