System

Health Check

Check whether the Scraper API service is healthy.

GET /health returns the current service health state. Use it from uptime monitors, deployment checks, or internal tooling that needs to know whether the Scraper API is reachable before sending extraction traffic.

This endpoint does not require X-Api-Key authentication.

Request

Run the request from a terminal with curl. The command only needs the production base URL.

export SCRAPER_API_BASE_URL="https://scraper.geonode.io"

curl "$SCRAPER_API_BASE_URL/health"

Response

A healthy service returns 200. If the service is unavailable, the endpoint can return 503 with the same response shape.

{
  "version": "1.0.0",
  "service": "scraper-api",
  "timestamp": "2026-05-27T08:15:30.000Z",
  "status": "ok"
}
FieldDescription
versionAPI service version returned by the deployment.
serviceService name.
timestampServer timestamp for the health response.
statusCurrent health state. Supported values are ok, degraded, and unavailable.

Treat ok as ready for normal traffic. Treat degraded or unavailable as a signal to pause non-urgent jobs and retry later.

On this page