Skip to content
Screaming Data
Documentation menu

Public & system API

Health check

Liveness probe for load balancers and uptime monitors.

GET
https://api.screamingdata.dev/health
Authentication
None
Cost
Free
Body
No request body

Overview

Always returns 200 while the API process is alive; status is degraded when the database does not answer. queue counts open collection jobs by state and rate_limits shows the collector pacing per marketplace. The body is not wrapped in the response envelope.

Cost

Free.

Request

GET /health.

This endpoint takes no parameters.

Request example

This endpoint does not need credentials.

curl --request GET \
  --url "https://api.screamingdata.dev/health"

Response

HTTP 200. The body is plain JSON (not wrapped in the response envelope).

Response example
{
  "status": "ok",
  "database": true,
  "queue": {
    "queued": 42,
    "running": 6
  },
  "rate_limits": {
    "com": 3,
    "uk": 3,
    "de": 3,
    "fr": 3,
    "es": 3,
    "it": 3,
    "nl": 3,
    "ca": 3,
    "au": 3,
    "jp": 3,
    "mx": 3,
    "in": 3
  }
}

Result fields

Liveness report. Not wrapped in the response envelope.

status
string

ok, or degraded when the database cannot be reached.

database
boolean

Whether the database answered.

queue
object

Open internal collection jobs per state: queued and, while jobs are being processed, running.

rate_limits
object

Current pause in seconds between two requests to each marketplace, as paced by the collector of this process. Empty when the process does not run the collector.

HTTP status codes

  • 200The process is alive; check status for dependencies.

Related endpoints