x-scrapeunblocker-key HTTP header. Requests without a valid key are rejected.
Where to find your key
Your API key is available in your account dashboard:Open Dashboard
app.scrapeunblocker.com
Using your key
Pass the key as a request header:The header name is case-insensitive, but always spelled with hyphens:
x-scrapeunblocker-key. Do not use X-ScrapeUnblocker-Key in places where exact-case matters (some CDNs strip non-canonical case).Keeping your key safe
- Never commit keys to source control. Use environment variables (
.envfiles added to.gitignore). - Never expose keys in client-side code. Browsers and mobile apps can read them. Always proxy requests through your own backend.
- Rotate immediately if leaked. Generate a new key in the dashboard - the old one will keep working for a short grace period.
Environment variables
The recommended way to store your key:Authentication errors
An unrecognised key returns HTTP401 Unauthorized with the plain-text body Unauthorized. Common causes:
Full breakdown of each case in Errors - 401 unauthorized. If you’ve checked the above and still see
401, contact support from the help center.
