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 Dashboard.

​
Generate API Key

To get started, you need to generate an API key via the Dashboard.
  1. Log in to the Scrapest Dashboard at admin.scrape.st
  2. Navigate to API Keys in the sidebar
  3. Click “Generate New API Key”
  4. Name your key (e.g., “My First Integration”)
  5. Copy the key and store it securely

​
API Key Features

  • Dashboard Management: Create, rename, and delete API keys through the dashboard
  • Usage Tracking: Monitor API calls and usage statistics
  • Security: Keys are tied to your user account and permissions
  • Rate Limits: Each key has its own rate limits and quotas

​
Telegram Authentication (Alternative Method)

For automated workflows, you can also authenticate via our Telegram Bot:
  1. Call the /auth endpoint to initiate the process:
curl -X POST https://scrape.st/auth
  1. The API returns an authentication link to open with our Telegram Bot
  2. Complete authentication via Telegram to get your API key
Note: Telegram authentication is primarily for automated workflows and API access. For most use cases, we recommend using the Dashboard for key management.

​
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/webhook \
  -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
}