Skip to main content
Most endpoints in the Scrapest Service are protected and require authentication.

​
API Key

To authenticate your requests, you must include the x-api-key header with a valid API key.
​
x-api-key
string
required
Your unique API key generated via the /auth endpoint.

​
Admin Key

For administrative operations and unlimited access to /x endpoints, you can use the x-admin-key header.
​
x-admin-key
string
The administrative API key configured in the deployment environment (ADMIN_API_KEY).

​
Generate API Key

To get started, you need to generate an API key via our Telegram Bot. Note: There is a strictly enforced limit of 3 API keys per Telegram user.
  1. Call the /auth endpoint to initiate the process.
curl -X POST https://scrape.st/auth

​
Response

The API will return an authentication link: 
{
  "status": "success",
  "message": "Please authenticate via Telegram",
  "data": {
    "auth_url": "https://t.me/Scrapest_Bot?start=123abc456..."
  }
}
  1. Click the auth_url to open the Telegram Bot.
  2. Click Start or send /start ....
  3. The bot will verify your session and send you a new API Key.
Keep this key safe! You can list your active keys at any time by sending /getkey to the bot.

​
Live Demo

You can interact with our live Scrapest instance at: https://scrape.st/
Authentication is required for all state-changing operations and sensitive data access on the live instance.

​
Example Request

curl -X GET https://scrape.st/health \
  -H "x-api-key: your-api-key"

​
Error Responses

  • 401 Unauthorized: Missing or invalid authentication headers (x-api-key or x-admin-key).
  • 403 Forbidden: API key limit reached (when generating keys).
  • 429 Too Many Requests: Standard API key has exceeded the rate limit.
401 Unauthorized
{
  "status": "error",
  "error": "Missing or invalid authentication header"
}
429 Too Many Requests
{
  "status": "error",
  "error": "Too many requests. Please try again later.",
  "retry_after": 60
}