Introduction to REST API

​

API Overview

​

Base URL

https://scrape.st

​

Authentication

x-api-key: YOUR_API_KEY

​

Response Format

{
  "data": { ... },
  "message": "Operation description"
  [key: string]: unknown
}

{
  "status": "fail",
  "error": "Validation failed",
  "issues": [...]
}

{
  "status": "error",
  "error": "Error description"
}

​

Available API Categories

• Webhooks — Configure endpoints for real-time event delivery View docs
• Tracking — Monitor X, Discord, Telegram, Web, and RSS sources View docs
• X Queries — Query X user and tweet data View docs
• Telegram Queries — Search Telegram messages, users, and channels View docs
• Web Queries — Scrape, crawl, map, and search the web View docs
• API Keys — Usage stats and key rotation View docs
• Health & Metrics — System health and latency percentiles View docs
• Backfill — Trigger and retrieve historical data View docs
• Streams — WebSocket and SSE for real-time data View docs

​

Source Guides

• X — Track users, search tweets, token mentions
• Telegram — Monitor groups & channels, token mentions
• Discord — Track servers, token mentions
• Web — Track websites, scrape web pages
• RSS — Monitor RSS feeds for new content

​

Getting Started

​

1. Get Your API Key

1. Sign up at Scrapest Dashboard
2. Navigate to API Keys section
3. Generate a new API key
4. Copy and securely store your API key

​

2. Make Your First Request

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

​

3. Explore Endpoints

• Webhooks: Create your first webhook
• Tracking: Set up data tracking
• X Queries: Query X data

​

Common Patterns

​

Pagination

GET /track/x?page=1&limit=20

{
  "data": [...],
  "total": 150,
  "page": 1,
  "limit": 20,
  "message": "..."
}

​

Filtering

GET /track/x?messageId=abc123

​

Error Handling