Overview
Web DataUse this page for a map of Scraper API endpoints.
If you need an API key or base URL, see
Authentication & Base URL.
New to the product? Start with the Quick Start Guide.
| Category | Purpose |
|---|
| Extraction | Extract content from webpages |
| Batch | Process multiple URLs in one job |
| Crawl | Discover and extract pages across a website |
| Map | Discover URLs from a website |
| Search | Run search jobs and retrieve results |
| Usage | Retrieve concurrency usage |
| System | Service health and status |
| Method | Endpoint | Description |
|---|
GET | /health | Check API health status |
| Method | Endpoint | Description |
|---|
POST | /v1/extract | Extract content from a webpage |
GET | /v1/extract/{job_id} | Retrieve an extraction job |
GET | /v1/extract/jobs | List extraction jobs |
| Method | Endpoint | Description |
|---|
POST | /v1/batch | Start a batch job |
GET | /v1/batch/{job_id} | Retrieve a batch job |
DELETE | /v1/batch/{job_id} | Cancel a batch job |
GET | /v1/batch/jobs | List batch jobs |
| Method | Endpoint | Description |
|---|
POST | /v1/crawl | Start a crawl job |
GET | /v1/crawl/{job_id} | Retrieve a crawl job |
DELETE | /v1/crawl/{job_id} | Cancel a crawl job |
GET | /v1/crawl/jobs | List crawl jobs |
| Method | Endpoint | Description |
|---|
POST | /v1/map | Discover URLs from a website |
GET | /v1/map/{job_id} | Retrieve a map job |
GET | /v1/map/jobs | List map jobs |
| Method | Endpoint | Description |
|---|
POST | /v1/search | Start a search job |
GET | /v1/search/{job_id} | Retrieve a search job |
GET | /v1/search/jobs | List search jobs |
| Method | Endpoint | Description |
|---|
GET | /v1/usage/concurrency | Retrieve concurrency usage |
Open the category pages below for request and response details:
Was this page helpful?