Geonode Scraper API Reference
Use the Geonode Scraper API reference to find endpoint details, authentication requirements, and request and response documentation for your integration.
Start with the API quickstart to authenticate requests, use the Python SDK from your code, or connect an AI client with the Geonode MCP server.
Base URL
All API requests use the following base URL:
https://scraper.geonode.ioYou can store it as an environment variable:
export SCRAPER_API_BASE_URL="https://scraper.geonode.io"Authentication
All Scraper API requests require an API key.
Send your API key using the X-Api-Key request header.
X-Api-Key: YOUR_API_KEYYou can store the API key as an environment variable:
export GEONODE_SCRAPER_API_KEY="YOUR_API_KEY"Keep your API key private and never expose it in frontend applications, public repositories, screenshots, or logs.
API Categories
The Scraper API is organized into the following categories.
| Category | Purpose |
|---|---|
| Extraction | Extract content from webpages |
| Batch | Process multiple URLs in a single job |
| Crawl | Discover and extract pages across a website |
| Map | Discover URLs from a website |
| Statistics | Retrieve usage statistics |
| Webhooks | Receive notifications when jobs complete |
| System | Service health and status |
Endpoints
System
| Method | Endpoint | Description |
|---|---|---|
GET | /health | Check API health status |
Extraction
| 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 |
Batch
| 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 |
Map
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/map | Discover URLs from a website |
Crawl
| 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 |
Statistics
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/statistics | Retrieve usage statistics |
Webhooks
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/webhooks | Create a webhook |
GET | /v1/webhooks | List webhooks |
GET | /v1/webhooks/{webhook_id} | Retrieve a webhook |
PATCH | /v1/webhooks/{webhook_id} | Update a webhook |
DELETE | /v1/webhooks/{webhook_id} | Delete a webhook |
POST | /v1/webhooks/{webhook_id}/rotate-secret | Rotate a webhook secret |
GET | /v1/webhooks/{webhook_id}/deliveries | List webhook deliveries |
Next Steps
Choose the endpoint category that matches your use case and open its guides or endpoint reference pages.
Was this page helpful?