Authentication
Learn how to authenticate your requests to the MrScraper API using API keys, including best practices for security and usage.
Overview
The MrScraper API uses API key authentication to secure all endpoints. Every API request must include a valid API key in the request headers.
Getting Your API Key
Get your API Key by following these steps.
Note
You can use this API key to authenticate with:
- All V3 Platform endpoints
- Endpoints on the
sync.scraper.mrscraper.comhost - For access to other endpoints on any other host, please contact us to request an API key.
Make Your First Call
Authentication is handled using HTTP Basic Auth. Include your API Key in the request header when accessing any MrScraper API endpoint.
x-api-token: YOUR_API_TOKENFor example, to retrieve scraping results, you would make the following cURL request:
curl -X GET "Residential Proxyhttps://api.app.mrscraper.com/api/v1/results?filters[scraperId]=<SCRAPER_ID>&page=1&pageSize=10&sort=createdAt&sortOrder=DESC" \
-H "accept: application/json" \
-H "x-api-token: YOUR_API_TOKEN"