Skip to navigation

Authentication

Every request needs a user API key
View as Markdown

All API endpoints require a user-level API key, reads included. The key gates abuse and attributes usage to your account.

Send it as a Bearer token on every request:

curl "https://api.homemediadb.com/v0/release/byId?id=895" \
-H "Authorization: Bearer ak_your_key_here"

Your key acts as you. It can create and edit contributions (reviews, trivia, cover votes) under your account. It cannot change account settings such as your email or password.

Create a key

1

Sign in

Go to homemediadb.com and log in, or create a free account.

2

Open your account settings

Click your profile image in the top-right and choose Manage account.

3

Go to API keys

Select the API keys tab on the left of the window.

4

Add a key

Click Add a new key and give it a name, for example the client, app or domain it will be used with. The expiration date is optional and up to you.

Keys are prefixed ak_. Copy the key when it’s shown; store it somewhere safe.

Be considerate

Make only the requests you need, cache where appropriate, and identify yourself with a descriptive User-Agent. Don’t hammer the API.

You are responsible for your API key. Any misuse, overuse, sharing or exploitative action may lead to a permanent ban from both the website and the API. Keep it safe and secret; never commit it to source control or ship it in client-side code.

A missing or invalid key returns 401 UNAUTHORIZED. See Errors for the full list.