Monitoring
Point your own monitoring at the Homedata API. Two health endpoints need no API key, and the public status page shows the current state of the service.
Health endpoints
Both endpoints live at the API root (not under /api/) and need no authentication, so they cost nothing to call.
| Endpoint | Use it for | Healthy response |
|---|---|---|
| GET https://api.homedata.co.uk/ping | Liveness — is the API answering at all? | 200 {"status":"ok"} |
| GET https://api.homedata.co.uk/health | Readiness — can the API serve data? | 200 {"status":"ok"}, or 503 with "degraded" |
Example: /health
curl https://api.homedata.co.uk/health
# 200 OK
{
"status": "ok",
"checks": { … },
"ts": 1757851200
}
status is ok or degraded;
checks reports each dependency individually, and
ts is the Unix time of the check. Treat any non-200 response, or a timeout, as a failure.
Setting up your own monitor
Probe /ping for a cheap up/down signal, and /health if your integration depends on data being served.
Set a short timeout (a few seconds) so a slow response is caught rather than hanging your check.
Alert after two or more consecutive failures rather than one, so a single network blip doesn't page anyone.
Check API status
The status page shows the current state of homedata.co.uk and api.homedata.co.uk.
Integrate into your own product
Pay as you goThe Homedata API /health endpoint returns an overall status plus per-dependency checks in structured JSON — suitable for load balancer probes, uptime monitoring services, and automated checks against production.
Structured as JSON · queryable by UPRN or postcode · ready to embed in any application
Exact measurements
Real values — distances, concentrations, counts — not rounded ratings
29 million UK properties covered
Every address queryable by UPRN or postcode
REST API
JSON responses, OpenAPI docs, sandbox — first call in under 5 minutes
Pay as you go: 100 tokens = £1 across every endpoint, no subscription needed. Bonus tokens with an optional monthly subscription, and your first top-up matched 100%. See pricing →
Sources
Further reading