Authentication

Creating and using a read-scoped API key.

Creating a key

Sign in to Aesops and create a read-scoped API key from your account's API keys settings page. Keys are scoped to datasets: ['read'] and are only needed for GET /datasets/{slug}/data — browsing the catalog never requires one.

Sending the key

Either header form is accepted:

Authorization: Bearer <your-key>
x-api-key: <your-key>

Keyless datasets

If the dataset you're loading is currently keyless (ds.keyless in the catalog response, active within its keyless_until window), /data succeeds with no key at all. Outside that window, a missing key returns 401. An invalid key is always rejected with 401, regardless of whether the dataset is keyless.

On this page