Get started

Planning API quickstart

Understand the current release state, authenticate a request and choose the right endpoint without guessing what the dataset covers.

Base URL

https://api.homeradarpro.co.uk/api/v1

All customer endpoints use HTTPS and return JSON. The public coverage manifest is available without a key at /api/v1/public/coverage-manifest.

Make your first request

When access opens, send your HomeRadar key as a bearer token. Keep the key on your server and never expose it in browser code or a public repository.

Search for applications by postcode

curl "https://api.homeradarpro.co.uk/api/v1/applications?postcode=YO1%207HF&limit=25" \
  -H "Authorization: Bearer hr_live_..." \
  -H "Accept: application/json"

Choose an endpoint

Search applicationsFilter by authority, postcode, outcome, type, text or date.Look around a locationUse coordinates and receive a measured distance for every match.Compare outcome patternsSeparate decisions from withdrawn, invalid and pending records.Check coverage firstInspect authority readiness, source health, freshness and licensing.Screen postcodesBatch-check up to 100 postcodes for evidence-backed planning history.

Response principles

Unavailable source fields remain null or are absent; HomeRadar does not estimate them.
Application responses preserve the council reference, source route, source URL and freshness timestamps.
Coverage is authority-specific. Check coverage before treating an empty result as evidence that no application exists.
Approval rates appear only when at least three determined applications support the percentage.