Docs



Authentication via Scraper-Key HTTP Header

To authenticate your API requests, include your unique Scraper-Key in the HTTP header. This key is assigned to you and can be found in the Personal Dashboard section of your account on the platform. The Scraper-Key ensures secure and authorized access to the API.


Steps to Use Scraper-Key Authentication


  1. Retrieve Your Key: Log in to your account, navigate to the Personal Dashboard, and locate your Scraper-Key.
  2. Add to HTTP Header: For each API request, include the Scraper-Key as a header with the format: 
    Scraper-Key: your-key-here
  3. Send Requests: Use any HTTP client (cURL, Postman, or custom scripts) to send requests with your key included in the headers.

Example Command Using cURL


Here is an example of making a request to the API hosted at api.scraper.tech using the Scraper-Key:

curl -X GET "https://api.scraper.tech/some-endpoint" \
     -H "Scraper-Key: YOUR_UNIQUE_KEY" \
     -H "Content-Type: application/json"

Breakdown of the Example


  • -X GET: Specifies the HTTP method (e.g., GET, POST, PUT).
  • "https://api.scraper.tech/some-endpoint": The endpoint you want to access.
  • -H "Scraper-Key: YOUR_UNIQUE_KEY": Adds your authentication key to the request header.
  • -H "Content-Type: application/json": Specifies the format of the request body (if required).

Replace YOUR_UNIQUE_KEY with the actual Scraper-Key found in your dashboard.