Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.scrapeunblocker.com/llms.txt

Use this file to discover all available pages before exploring further.

ScrapeUnblocker uses API keys for authentication. Every request must include your key in the 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
If you don’t have an account yet, sign up on the pricing page - the free trial does not require a credit card.

​
Using your key

Pass the key as a request header: 
curl -X POST "https://api.scrapeunblocker.com/getPageSource?url=https://example.com" \
  -H "x-scrapeunblocker-key: YOUR_API_KEY"
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

Your API key is the only credential needed to make billable requests against your account. Treat it like a password.
  • Never commit keys to source control. Use environment variables (.env files 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: 
SCRAPEUNBLOCKER_KEY=su_live_xxxxxxxxxxxxxxxx

​
Authentication errors

A missing or invalid key returns HTTP 401 Unauthorized. Common causes:
SymptomLikely cause
401 with valid-looking keyTrailing whitespace or newline in the header value
401 for every requestKey was rotated in dashboard but old key still cached
403 (not 401)Key is valid - the target site blocked the request. See handling failures
If you’ve checked the above and still see 401, contact support from the help center.