API Reference¶
This is the customer-facing ScrapeNest REST API. It covers the endpoints developers use to submit scraping jobs, inspect status, download artifacts, manage API keys, configure webhooks, and control organization-level access settings.
The published OpenAPI file is generated from the platform spec, then filtered to the endpoints available to customer developers. Operational platform endpoints remain in the internal documentation.
Open the API explorer¶
Open full-screen API explorer Download OpenAPI spec
Customer API surface¶
| Area | Endpoints |
|---|---|
| Jobs | Submit jobs, list jobs, inspect job status and produced artifacts. |
| Artifacts | Exchange an artifact id for a short-lived download URL. |
| API keys | Create, rotate, revoke, list, and restrict API keys. |
| Webhooks | Configure webhook endpoints, rotate secrets, pause delivery, and inspect delivery attempts. |
| Organization security | Configure organization-level IP allowlists. |
| Retention | Read/update retention policy and manage legal holds. |
Recommended entry points¶
- Start with the Quickstart if you are integrating for the first time.
- Use the Python SDK for production code unless you need raw HTTP.
- Use Job Parameters when tuning worker tier, rendering, extraction, or artifact options.
- Use Webhooks for high-volume jobs instead of polling.