Skip to content
aioratings aioratings

Quickstart

You need an API key and an image URL. That’s it.

1. Get a key

Section titled “1. Get a key”
  1. Sign up at the aioratings dashboard and choose Sign up.
  2. Go to Dashboard → API Keys and create a key. Copy it when shown.

Free keys work immediately. Premium/Pro keys also unlock custom profiles, the full set of rating sources, and award badges — see Plans & limits.

2. Build a poster URL

Section titled “2. Build a poster URL”

The drop-in base URL and URL shape:

https://rpdb.aioratings.com/{key}/{idType}/poster-default/{id}.jpg
  • {key} — your aioratings API key.
  • {idType} — imdb, tmdb or tvdb.
  • poster-default — the built-in poster style. Premium/Pro can swap in a custom profile.
  • {id} — the title id, matching {idType} (see URL shape & idTypes).
  • .jpg — the file extension (.png is also accepted).

Working example

Section titled “Working example”

tt0903747 is Breaking Bad:

https://rpdb.aioratings.com/YOUR_KEY/imdb/poster-default/tt0903747.jpg

Open it in a browser (with your real key) and you’ll get a poster image.

3. Try a few parameters

Section titled “3. Try a few parameters”

Filter and reorder the rating badges, and pick the artwork source:

https://rpdb.aioratings.com/YOUR_KEY/imdb/poster-default/tt0903747.jpg?ratings_order=imdb,rt&badge_background=n&badge_size=l&image_source=t

Every parameter is documented in Query parameters.

4. Wire it into a tool

Section titled “4. Wire it into a tool”

Pick your platform and follow the copy-paste config: