Available endpoints
All operations are GET requests, JSON, read-only and versioned. No API credentials are required in this pilot. Basic shared-resource throttling applies.
- Service health and coverage
GET /api/v1/health↗ - Human-approved regulatory facts (0 records)
GET /api/v1/verified-records↗ - Source coverage and publishable counts
GET /api/v1/coverage↗ - Qualifying independent-review scheme pages (0)
GET /api/v1/schemes↗ - Source-checked council summaries
GET /api/v1/councils↗ - One council research record
GET /api/v1/councils/croydon↗ - Dated regulatory changes
GET /api/v1/changes↗ - Article 4 point lookup
GET /api/v1/article-4?latitude=51.37&longitude=-0.1↗ - Postcode to local authority
GET /api/v1/postcode?postcode=CR0%201EA↗ - Combined preliminary property check
GET /api/v1/property-check?postcode=CR0%201EA&occupiers=4&households=3&shared=true↗
Response contract
Success: {"ok":true,"version":"v1","data":{...}}
Error: {"ok":false,"version":"v1","error":{"code":"INVALID_POSTCODE","message":"..."}}
Data status
Two pilot council summaries are source-checked research, not independently human-approved determinations. The separate /verified-records endpoint contains 0 records after signed-off Neon exports; 0 of those currently have enough distinctive evidence for a searchable scheme landing page. Unpublished London council drafts are excluded from all public API results.
Article 4 area records can be incomplete or unrelated to HMO development rights. No result never means no Article 4 restriction. Postcode coordinates represent a central point, not a particular building boundary.
Future scope
Planning boundary geometry, live HMO licence registers, complete nationwide schemes, paid API access and portfolio monitoring are not yet implemented. We will not advertise them as available.
Privacy and client usage
Postcode queries are not written to our application database. External upstreams and hosting services may process technical request logs. Browser use is limited to the same origin; server-to-server clients can consume the public GET API subject to acceptable use and throttling.