Overview
The ScrapeNest API powers programmatic scraping and change-monitoring for your sites. It is JSON-over-HTTP, uses bearer JWTs for authentication, and exposes synchronous scrape requests plus long-running content monitors.
Base URLs
- Production:
https://api.scrapenest.com
Content & headers
- Send
Content-Type: application/jsonfor requests with bodies. - Authenticate protected endpoints with
Authorization: Bearer <access_token>. - All timestamps are ISO-8601 (RFC 3339).
High-level flow
POST /registerand verify your email viaGET /verify.POST /tokenwith email and password to obtain a JWT.- Call authenticated endpoints (scrapes, monitors, profile) with your bearer token.
- Handle structured error responses (see
Errors).
Endpoints at a glance
- Public:
GET /health,POST /register,POST /login,POST /token,GET /verify - Authenticated:
GET /me,/scrapes(list/show/create),/content-monitors(CRUD, runs)
The full OpenAPI description lives at api/openapi.yaml and is linked in the OpenAPI section. Up-to-date schemas, parameters, and responses are summarized in the pages that follow.
System endpoint
GET /health returns {"status":"ok"} and requires no authentication. Use it for uptime checks.