GET /health

On this page

GET /health
Request
Response
Response fields
Health entries

Returns current health for marketplace sources, variant collectors, public endpoint datasets, the item schema, and aggregate database counts. No authentication is required.

Once health data is ready, the endpoint returns HTTP 200 even when the JSON status is degraded or down. HTTP 503 means the health snapshot itself is not ready.

Request#

GETapi.cs2.sh/health

curl https://api.cs2.sh/health \
  -H "Accept-Encoding: gzip" --compressed

Response#

{
  "status": "up",
  "last_refreshed_at": "string",
  "schema_ready": false,
  "sources": null,
  "variants": null,
  "endpoints": null,
  "stats": {
    "total_events": 0,
    "market_hash_names": 0,
    "variant_items": 0
  }
}

Response fields#

HealthResponse fields:

Field	Type	Required	Description
`status`	`string`	Yes	Allowed: `up`, `degraded`, `down`. Overall API data health.
`last_refreshed_at`	`string (date-time)`	Yes	When this health snapshot was generated.
`schema_ready`	`boolean`	Yes	Whether the item schema is available.
`sources`	`Record<string, HealthEntry>`	Yes	Marketplace health keyed by source.
`variants`	`Record<string, HealthEntry>`	Yes	Variant-price health keyed by source collector.
`endpoints`	`Record<string, HealthEntry>`	Yes	Dataset health keyed by endpoint name.
`stats`	HealthStats	Yes	Aggregate database counts at the last health refresh.

Health entries#

Entries under sources, variants, and endpoints contain updated_at, collected_at, and status. Status is up, degraded, or down based on that dataset's expected refresh rate.

schema_ready tells you whether GET /v1/schema is available. stats contains total_events, market_hash_names, and variant_items.

Full schemas: HealthEntry and HealthStats.