# Homedata API: Full Reference for AI Ingestion

## Updated 2026-10-01

> Complete content for AI assistants. Base URL: https://api.homedata.co.uk/api/
> Auth: `Authorization: Api-Key YOUR_KEY` header on every request.
> All responses are JSON. See https://homedata.co.uk/docs for the human-readable version.

---

## About Homedata

Homedata is a UK property data API built by the HM Haus Group, a property technology company based in England. The API provides structured, UPRN-level access to 29 million properties across England and Wales, aggregating data from HM Land Registry, the Environment Agency, Ordnance Survey, DLUHC, Ofsted/DfE GIAS, and the Office for National Statistics into a single REST interface. Homedata exposes the full property listing-event chain (Added, Reduced, Withdrawn, Sold STC, Re-listed), matched to a UPRN and queryable over time, delivered via a licensed data feed.

---

## Quick Facts

- **Properties indexed**: 29 million (England and Wales)
- **Listing data**: licensed market data feed
- **Price history depth**: 30 years (HM Land Registry)
- **Schools**: 27,000+ from DfE GIAS (Get Information About Schools)
- **Risk layers per property**: 7 (flood, radon, coal mining, landfill, noise, air quality, invasive plants)
- **Event chain**: Added → Reduced → Withdrawn → Sold STC → Re-listed → Completed
- **Unique identifier**: UPRN (Unique Property Reference Number): Ordnance Survey AddressBase
- **API style**: REST/JSON, key-auth, HTTPS
- **Base URL**: https://api.homedata.co.uk/api/
- **Playground**: https://homedata.co.uk/try (no sign-up required)
- **Billing**: pay as you go: 100 tokens = £1, no plans, no monthly allowance, tokens never expire
- **Data sources**: HM Land Registry, Environment Agency, Ordnance Survey, DLUHC, Ofsted/DfE GIAS, ONS, Police UK
- **Not covered**: Scotland, Northern Ireland (separate land registries, not yet integrated)
- **Not scraping**: Data is licensed, not scraped from portals

---

<!-- BEGIN GENERATED: api-surface (source_hash: 85bb067e15ee972a420a0fff2bcf0b2b13f55c701fcde6c0a849ef945cc6978e), written by scripts/sync-try-catalogue.mjs from the playground catalogue; do not edit by hand -->
## API Surface: All Endpoints

Every account reaches every self-serve endpoint below. Requests spend tokens from a prepaid balance; endpoints differ only in how many. The exception is the Premium section at the end: on-request products scoped per customer, not callable with a standard key. Except **All Property Listings**, which stays callable and token-metered for some accounts; its entry gives the path, parameters and weight those accounts use. Paths are relative to `https://api.homedata.co.uk/api/`; trailing slashes matter. Send `Authorization: Api-Key YOUR_KEY`.

### Property tiers: one UPRN in, fixed depth out, fixed cost

**GET /property/{uprn}/address/**
- Weight: 5 tokens
- Purpose: Address fields only, full address, postcode, coordinates, USRN/TOID/UDPRN. Replaces /api/address/retrieve/. 5 tokens.
- Params: `uprn` (required)

**GET /property/{uprn}/base/**
- Weight: 10 tokens
- Purpose: House-shopper decision card, address + rooms + EPC + lr_title + last sold + construction + dimensions + garden/parking. Flat 10 tokens.
- Params: `uprn` (required)

**GET /property/{uprn}/core/**
- Weight: 25 tokens
- Purpose: Complete listing card, everything in Base + council tax band + flood + schools + broadband + crime + demographics + valuations + solar + lr_sales + title boundary + planning constraints (listed building / conservation area / designations). Flat 25 tokens.
- Params: `uprn` (required)

**GET /property/{uprn}/complete/**
- Weight: 50 tokens
- Purpose: Full property report, everything in Core + council tax FULL (GBP charges) + full title (ownership + boundary) + comparables + live listings + full environmental risks + deprivation + planning application history + price trends/distributions/growth. Flat 50 tokens.
- Params: `uprn` (required)

**GET /property/{uprn}/**
- Weight: 1 token
- Purpose: Discovery menu, what data is available for this UPRN, per-slug cost, and tier shortcut paths. 1 token. Doubles as a "is this UPRN known to us" check.
- Params: `uprn` (required)

**GET /property/{uprn}/**
- Weight: 1 token for the base record plus the sum of the selected `?with=` add-ons (the Discovery menu lists each add-on's price)
- Purpose: Pick-and-choose, 1 token for the property plus the weight of each slug you add. Same URL as Discovery, but supplying ?with=slug1,slug2 turns it into a custom chain. Pay only for what you ask for.
- Params: `uprn` (required)

### Property attributes

Pick one fact about one UPRN, cheaper than a tier when you only need one field. Need several? Build your own ?with= chain.

**GET /properties/{uprn}/rooms/**
- Weight: 1 token
- Purpose: Bedrooms, bathrooms, habitable rooms, heated rooms. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/roof/**
- Weight: 1 token
- Purpose: Roof material, shape, and whether solar panels are present. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/garden/**
- Weight: 1 token
- Purpose: Presence and type(s) of garden, rear, front, patio, etc. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/parking/**
- Weight: 1 token
- Purpose: Presence and type(s) of parking, driveway, off-street, garage, etc. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/dimensions/**
- Weight: 1 token
- Purpose: Geometry area (m²), building height, estimated volume, predicted floor area. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/land/**
- Weight: 1 token
- Purpose: Land area (m²) for the property plot. Not available for flats/apartments/maisonettes: returns 400 with no call charged.
- Params: `uprn` (required)

**GET /properties/{uprn}/construction/**
- Weight: 1 token
- Purpose: Construction age band, primary construction material, basement presence. 1 token.
- Params: `uprn` (required)

**GET /properties/{uprn}/epc/**
- Weight: 1 token
- Purpose: Energy Performance Certificate, current and potential energy efficiency rating, EPC floor area, and last inspection date. 1 token. Distinct from EPC Renovations (which returns the recommended works + costs).
- Params: `uprn` (required)

**GET /properties/{uprn}/epc_renovations/**
- Weight: 1 token
- Purpose: Recommended renovations from the EPC assessment with min / max cost estimates. 1 token.
- Params: `uprn` (required)

**GET /council_tax_band/{uprn}/**
- Weight: 3 tokens
- Purpose: Council tax band, billing authority name and GSS code. Light response: for yearly + monthly charge in GBP and the full bundle, use Council Tax. 3 tokens. England, Scotland and Wales.
- Params: `uprn` (required)

**GET /council_tax/{uprn}/**
- Weight: 5 tokens
- Purpose: Full council tax bundle for a UPRN: band, billing authority + GSS code, current-year yearly and monthly charge in GBP, 1991 valuation band bounds, fiscal year and source URL. 5 tokens. England, Scotland and Wales.
- Params: `uprn` (required)

**GET /property_lr_titles/{uprn}/**
- Weight: 10 tokens
- Purpose: Land Registry title records for a property, tenure (freehold/leasehold), registered owner, and title number.
- Params: `uprn` (required)

**GET /risks/{risk_type}/**
- Weight: 1 token for a single hazard or flood layer; 5 tokens for risk_type=all (every environmental hazard in one sweep).
- Purpose: Environmental risk scores, flood, radon, noise, landfill, coal mining, invasive plants, air quality.
- Params: `uprn` (required)
- `risk_type` values: `all`, `flood`, `radon`, `landfill`, `coal_mining`, `non_coal_mining`, `noise`, `air_quality_today`, `invasive_plants`. `all` returns every hazard row in one response.

**GET /risks/flood/{layer}/**: the flood evidence family (canonical)
- Layers: `zones`, `history`, `defences`, `storage-areas`, `warning-areas`, `reservoir`, `climate`
- Weight: 1 token per layer
- Params: `uprn` (one of), or `lat` + `lng` (one of, WGS84). UPRN wins if both are sent
- Purpose: `/risks/flood/` is the headline risk band; the layers are the evidence behind it: planning flood zones 2 and 3 (undefended), recorded floods since 1703, defences with standard of protection, flood storage areas, EA warning and alert areas, reservoir failure extents, and 2080s climate projections (UKCP18 RCP8.5)
- Every layer echoes a `query` block with `basis` (`title` = assessed against the whole Land Registry title polygon, `point` = the coordinate) and `in_coverage`
- Coverage: England only (Environment Agency data). Outside England the response is still 200 with `in_coverage: false` and empty results. Treat that as "not assessed", never "not at risk"
- Aliases: the older `/flood-risk/…` and `/flood/…` spellings answer forever with a `Link: rel="canonical"` header pointing here, but are not documented

**GET /properties/{uprn}/ground_stability/**
- Weight: 1 token
- Purpose: Trees within root reach (canopy height measured, reach inferred), measured ground movement in mm a year from satellite readings near the home, and clay shrink-swell. Every response carries its sources and caveats. 1 token.
- Params: `uprn` (required)

**GET /solar-assessment/{uprn}/**
- Weight: 5 tokens
- Purpose: Solar PV potential for a property, roof area, estimated generation (kWh/yr), financial savings, payback period, and CO₂ offset.
- Params: `uprn` (required)

**GET /broadband/**
- Weight: 1 token
- Purpose: Ofcom Connected Nations broadband speed data for a UK postcode, avg/max download+upload speeds, superfast/ultrafast/gigabit/full-fibre coverage %, and premises count. 1 token.
- Params: `postcode` (required)

### Sale flow

The dated events behind each asking price.

**GET /property_sale_events/**
- Weight: 20 tokens
- Purpose: The negotiation behind the headline price, every price move, offer and withdrawal, dated.
- Params: `sale` (optional); `listing` (optional, alternative to the previous param); `event_type` (optional); `ordering` (optional, advanced)

### Lead source

Turn a live listing into its exact address, UPRN and event timeline.

**POST /listing-address/**
- Weight: 20 tokens
- Purpose: Turn a listing into a real address, the full postal address and the whole sale history, ready to act on.
- Params: `listing_id` (required)

### Single property amenities

What's near a property, three families, one UPRN, a radius you choose. Open a card for the whole bundle, or a category for one type.

**GET /amenities/**
- Weight: 5 tokens
- Purpose: All 11 OSM amenity groups in one response, food, education, healthcare, financial, civic, worship, culture, convenience, green_spaces, transport, shops. 5 tokens.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/food/**
- Weight: 1 token
- Purpose: Cafes, restaurants, pubs, bars, fast food, ice cream, food courts, nightclubs, marketplaces. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/education/**
- Weight: 1 token
- Purpose: Schools, kindergartens, colleges, universities, childcare, libraries, music/language/driving/dance schools. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/healthcare/**
- Weight: 1 token
- Purpose: OSM-tagged healthcare, doctors, dentists, clinics, hospitals, pharmacies, veterinary, nursing homes. For CQC-authoritative records (registration ID, region, last-checked date, CQC URL), use the dedicated /healthcare/* endpoints. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/financial/**
- Weight: 1 token
- Purpose: Banks, ATMs, bureaux de change, money-transfer agents, payment centres. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/civic/**
- Weight: 1 token
- Purpose: Post offices, town halls, courthouses, fire stations, police, community centres, social facilities. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/worship/**
- Weight: 1 token
- Purpose: Places of worship, churches, mosques, synagogues, temples, gurdwaras. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/culture/**
- Weight: 1 token
- Purpose: Theatres, cinemas, arts centres, music venues, museums, galleries, attractions, viewpoints, theme parks, zoos. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/convenience/**
- Weight: 1 token
- Purpose: Public toilets, charging stations, parcel lockers, internet cafes, animal boarding, give-boxes. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/green_spaces/**
- Weight: 1 token
- Purpose: Parks, playgrounds, gardens, nature reserves, commons, sports pitches. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/transport/**
- Weight: 1 token
- Purpose: OSM-side transit, bus stops, ferry terminals, railway stations + halts, tram stops, public-transport platforms. Companion to the NaPTAN-authoritative /transport/ endpoint. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /amenities/shops/**
- Weight: 1 token
- Purpose: Every OSM-tagged shop, supermarket, clothing, bakery, hardware, convenience, books, the lot. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /fuel-stations/**
- Weight: 1 token
- Purpose: Petrol stations and EV charging points in one response, each result tagged with its `type`. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /fuel-stations/petrol/**
- Weight: 1 token
- Purpose: Petrol stations only, OSM amenity=fuel. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /fuel-stations/ev/**
- Weight: 1 token
- Purpose: EV charging points only, OSM amenity=charging_station. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /healthcare/**
- Weight: 3 tokens
- Purpose: CQC-registered GPs, dentists and hospitals plus OSM-tagged pharmacies in one response. CQC entries carry name, address, postcode, region, distance and CQC location URL, with phone, website and last-checked date wherever the register holds them. CQC covers England only; the pharmacy layer is OpenStreetMap and UK-wide. Refreshed monthly. 3 tokens.
- Params: `uprn` (required); `radius_km` (optional)

**GET /healthcare/gps/**
- Weight: 1 token
- Purpose: CQC-registered GP practices, straight from the Care Quality Commission register and refreshed monthly. Every entry carries name, address, postcode, region, straight-line distance and its CQC location URL; phone, website and the register's last-checked date arrive wherever CQC holds them, phone numbers without the leading 0. England only: CQC's remit, so Scotland, Wales and Northern Ireland have their own regulators and are not in this feed. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /healthcare/dentists/**
- Weight: 1 token
- Purpose: CQC-registered dental practices, straight from the Care Quality Commission register and refreshed monthly. Every entry carries name, address, postcode, region, straight-line distance and its CQC location URL; phone, website and the register's last-checked date arrive wherever CQC holds them, phone numbers without the leading 0. England only: CQC's remit, so Scotland, Wales and Northern Ireland have their own regulators and are not in this feed. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /healthcare/pharmacies/**
- Weight: 1 token
- Purpose: Pharmacies near a property, OpenStreetMap shop=pharmacy (CQC doesn't regulate pharmacies, General Pharmaceutical Council remit). Includes name, address, phone, website from OSM tags where present. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

**GET /healthcare/hospitals/**
- Weight: 1 token
- Purpose: CQC-registered hospitals, straight from the Care Quality Commission register and refreshed monthly. Every entry carries name, address, postcode, region, straight-line distance and its CQC location URL; phone, website and the register's last-checked date arrive wherever CQC holds them, phone numbers without the leading 0. England only: CQC's remit, so Scotland, Wales and Northern Ireland have their own regulators and are not in this feed. 1 token.
- Params: `uprn` (required); `radius_km` (optional)

### Area

Postcode, outcode or boundary-level stats, prices, demographics, amenities, heritage.

**GET /boundaries/autocomplete/**
- Weight: 1 token
- Purpose: Search UK administrative boundaries by name, returns boundary IDs for use with the Live Listings endpoint. 1 token per request.
- Params: `q` (required)

**GET /price_trends/{outcode}/**
- Weight: 1 token
- Purpose: Average property prices over time for an outcode area (e.g. SW1A, E1, M1).
- Params: `outcode` (required)

**GET /price_distributions/{outcode}/**
- Weight: 1 token
- Purpose: Property price distribution for an outcode, percentiles, median, and count by property type.
- Params: `outcode` (required)

**GET /price-growth/{outcode}/**
- Weight: 1 token
- Purpose: Capital appreciation data for an outcode area, annual growth rate, 1Y/3Y/5Y/10Y returns, and historical price index. Computed from Land Registry sold price transactions.
- Params: `outcode` (required)

**GET /postcode-profile/**
- Weight: 1 token
- Purpose: All-in-one postcode summary in a single call, deprivation index, crime rate, average property price, school count, transport links, and broadband speed. Replaces 5+ separate endpoint calls.
- Params: `postcode` (required)

**GET /deprivation/**
- Weight: 1 token
- Purpose: Index of Multiple Deprivation scores, income, employment, education, health, crime, housing, environment.
- Params: `postcode` (required)

**GET /demographics/**
- Weight: 1 token
- Purpose: ONS Census 2021 demographics resolved to the postcode's MSOA (middle-layer super output area, ~7,500 residents). Returns population, tenure breakdown (owned / mortgage / social / private rented / rent-free), age bands, ethnicity, occupation, household size, car ownership, plus MHCLG IMD 2019 deprivation if available. Area codes (LSOA + MSOA + local authority) are in the response so you can link to other ONS datasets.
- Params: `postcode` (required)

**GET /schools/nearby**
- Weight: 1 token
- Purpose: Find schools near a postcode, Ofsted ratings, phase, pupil numbers, and distance. ~27,000 open schools in England from the DfE GIAS register.
- Params: `postcode` (required); `radius_km` (optional); `phase` (optional, advanced); `ofsted` (optional, advanced); `limit` (optional, advanced)

**GET /planning/search/**
- Weight: 5 tokens
- Purpose: National planning applications near a location, type, status, description, and decision date. 300+ LPAs via PlanIt. Use postcode or lat/lng.
- Params: `postcode` (optional); `lat` (optional, alternative to the previous param); `lng` (optional, alternative to the previous param); `radius_km` (optional, advanced); `days` (optional, advanced); `type` (optional, advanced); `status` (optional, advanced)

**GET /crime/**
- Weight: 1 token
- Purpose: Crime statistics near a location, 14 categories sourced from Police UK. Monthly counts and category breakdown. Use postcode or lat/lng.
- Params: `postcode` (optional); `lat` (optional, alternative to the previous param); `lng` (optional, alternative to the previous param); `date` (optional, advanced); `category` (optional, advanced)

**GET /listed-buildings/**
- Weight: 3 tokens
- Purpose: Historic England listed buildings within a radius of a UK postcode. Returns Grade I / II* / II entries with name, location, list date, and a hyperlink back to the official Historic England record.
- Params: `postcode` (required); `radius_km` (optional, advanced); `grade` (optional, advanced)

### Tools

Free calculators, no tokens spent. Use them anywhere.

**GET /calculators/stamp-duty/**
- Weight: free, no tokens spent
- Purpose: Calculate UK Stamp Duty Land Tax (SDLT) for England and Northern Ireland. Returns total tax, effective rate, and a band-by-band breakdown for standard, first-time, or additional-dwelling buyers. Free endpoint: counts zero against your quota.
- Params: `price` (required); `buyer_type` (required); `country` (optional, advanced)

**GET /calculators/mortgage/**
- Weight: free, no tokens spent
- Purpose: Mortgage repayment calculator, given price + deposit + rate + term, returns monthly payment, total repayment, total interest, LTV and LTI ratios. Free endpoint: counts zero against your quota.
- Params: `price` (required); `deposit` (required); `rate` (required); `term` (required)

### Address lookup

Match an address to a UPRN, or list a postcode.

**GET /address/match/**
- Weight: 5 tokens
- Purpose: Match a submitted address and postcode to one property. Both are required. 200 returns the address-level retrieve body plus address_resolution. 5 tokens on success; 422 with reason no_match or multiple_matches returns no candidates and is never charged. Weak fuzzy matches are flagged in address_resolution.
- Params: `address` (required); `postcode` (required)

**GET /address/postcode/{postcode}/**
- Weight: 2 tokens
- Purpose: All registered addresses at a postcode. Returns address list with UPRNs. Costs 2 tokens (weighted billing).
- Params: `postcode` (required)

### Enterprise: arranged directly (not self-serve)

Enterprise products, scoped and priced per customer. They are not part of the self-serve surface and do not spend tokens from your balance. Do not infer paths or parameters for them; the team agrees coverage, cadence, SLA and price directly. Register interest at https://homedata.co.uk/try. Except **All Property Listings**, which stays callable and token-metered for some accounts; its entry gives the path, parameters and weight those accounts use.

**All Property Listings**: on request
- Purpose: Full listing history for one property, what it asked, how often that was cut, and whether it sold or quietly came off.
- Example (illustrative values): Last asking price £325,000; First listed: 30 September 2019; Left the market: Withdrawn; Days on market: 2,537; Price reductions: None; Property: 3 bed detached
- Example response shape: `{"count":1,"results":[{"id":"7f9200c5-93be-487a-befa-26aa8667b3e4","street":"Mayfield Park North Fishponds BS16","postcode":"BS16 3NJ","transaction_type":"Sale","latest_price":325000,"bedrooms":3,"bathrooms":1,"reception_rooms":1,"property_type":"Detached","is_reduced":false,"times_reduced":0,"is_withdrawn":true,"days_on_market":2537,"added_date":"2019-09-30"}]}`
- Call, for accounts with access: `GET /property_listings/`, 20 tokens a request
- Params: `uprn` (required)
- Access: Accounts opened before the switch to tokens on 16 September 2026 keep self-serve access at 20 tokens a request. Accounts opened since are refused with the code premium_endpoint (HTTP 403) until it is switched on for them. Register interest at https://homedata.co.uk/try?endpoint=property-listings

**Land Registry Sales**: on request
- Purpose: What actually changed hands, not what was asked, every HM Land Registry confirmed completion, with the date and the real price.
- Example (illustrative values): Price paid £310,000; Completion date: 9 April 2020; Against the asking price: £15,000 below; Land Registry txid: A96E4ACB-DBFE-9205-E053-6C04A8C0DA09
- Example response shape: `{"uprn":61263,"count":1,"sales":[{"txid":"A96E4ACB-DBFE-9205-E053-6C04A8C0DA09","sold_let_date":"2020-04-09","sold_let_price":310000,"transaction_type":"Sale"}]}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=lr-sales

**Comparables**: on request
- Purpose: The evidence a valuation stands on, like-for-like sold comparables, time-adjusted to today and ranked by how closely they match.
- Example (illustrative values): Adjusted median £408,000; 8 Orchard Lane · 0.05 mi: Detached · 3 bed · 121 m²; 24 Windsor Road · 0.18 mi: Detached · 3 bed · 114 m²; 3 Kendrick Close · 0.27 mi: Detached · 3 bed · 119 m²; 17 Alexandra Road · 0.31 mi: Detached · 4 bed · 132 m²; Market adjustment: Reading RG1 index, +1.8% since February
- Example response shape: `{"uprn":100023336956,"matched":12,"adjusted_median":408000,"range":{"low":392000,"high":427500},"radius_miles":0.4,"window_months":9,"comparables":[{"address":"8 Orchard Lane","distance_miles":0.05,"property_type":"Detached","bedrooms":3,"floor_area_m2":121,"sold_price":415000,"sold_date":"2026-06-14","adjusted_price":415000}],"index":{"area":"RG1","change_pct":1.8,"since":"2026-02"}}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=comparables

**Search live listings**: on request
- Purpose: Live UK listings on sale or to let, filtered down to the properties worth calling.
- Example (illustrative values): Listings matched 10,000+; Terraced · 3 bed · added today: Mayfield Park North, BS16 3NJ; Detached · 2 bed · added today: Cavendish Road, BA1 2UD; Detached · 3 bed · added today: Elmdon Lane, B37 7EQ; Filter on: Reductions, days on market, EPC band, floor area, garden, parking
- Example response shape: `{"count":10000,"page":1,"page_size":3,"total_pages":3334,"results":[{"id":"c61d5383-1214-4e6f-b63c-1153863bc50f","street":"Mayfield Park North","postcode":"BS16 3NJ","transaction_type":"Sale","latest_status":"For sale","latest_price":385000,"bedrooms":3,"bathrooms":1,"property_type":"Terraced","ownership":"Freehold","is_new_build":false,"is_reduced":false,"times_reduced":0,"days_on_market":0,"added_date":"2026-09-10"}]}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=live-listings

**Flood risk expert**: on request
- Purpose: Everything the Environment Agency knows about flooding at one address, seven layers behind the headline band, 1703 to the 2080s. England only.
- Example (illustrative values): Flood outlines within 250 m 10+; Screening band: Surface water, Low; Planning zone 3: Outside; Planning zone 2: Outside; Recorded floods: Five episodes in the ten nearest outlines; Defences: None within 250 m; Storage areas: Not inside one; Warning and alert areas: Inside neither; Reservoir failure: Inside the extent; Climate 2080s: In the extreme river extent
- Example response shape: `{"query":{"uprn":100120547768,"country":"England","coverage":["England"],"in_coverage":true,"basis":"title"},"band":{"risk_type":"flood_surface_water","label":"Low","score":2,"score_unit":"band","description":"Between 1 in 1,000 and 1 in 100 chance of flooding each year","confidence":3},"zones":{"source":"EA Flood Map for Planning (undefended fluvial/tidal)","flood_zone_3":{"inside":false,"nearest_m":104.7},"flood_zone_2":{"inside":false,"nearest_m":42.3}},"history":{"source":"EA Recorded Flood Outlines (1703-present)","has_flooded":true,"events_within_250m":[{"name":"March-1947  River Severn","flood_source":"main river","flood_cause":"channel capacity exceeded (no raised defences)","start_date":"1947-03-07","end_date":"1947-04-04","distance_m":0},{"name":"River Swilgate 006 (July 07)","flood_source":"main river","flood_cause":"channel capacity exceeded (no raised defences)","start_date":"2007-07-20","end_date":"2007-07-24","distance_m":43.4}]},"defences":{"source":"EA Spatial Flood Defences","count_within_250m":0,"defences":[]},"storage-areas":{"source":"EA Flood Storage Areas","inside":false,"nearest_m":null},"warning-areas":{"source":"EA Flood Warning and Alert Areas","warning_area":{"inside":false},"alert_area":{"inside":false}},"reservoir":{"source":"EA Reservoir Flood Extents (wet-day worst case)","inside":true,"reservoir":"Cheltenham Racecourse","operator":"The Steeplechase Company (Cheltenham) Ltd","risk_designation":"High-risk"},"climate":{"source":"EA climate-change flood projections (CCP1)","epoch":"2080s (2070-2125)","scenario":"UKCP18 RCP8.5 (high emissions)","river":{"high":{"defended":false,"undefended":false},"extreme":{"defended":true,"undefended":true}},"sea":{"high":{"defended":false,"undefended":false},"extreme":{"defended":false,"undefended":false}}}}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-flood-expert

**Plot intelligence**: on request
- Purpose: What the plot actually contains, garden size and aspect, whether a car fits on the drive, and whether it has already been extended. Measured, not guessed.
- Example (illustrative values): Private garden 138 m²; Extension: Rear, 14 m²; Evidence: Extra building part, lower eaves, off-archetype, approved application; Garden: 138 m² · widest circle 7.4 m; Sun on the garden: 6.2 hrs midsummer; Driveway: 41 m² a car can reach; Way in: 3.1 m gap in the frontage
- Example response shape: `{"uprn":100023336956,"extension":{"detected":true,"area_m2":14,"position":"rear","signals":["extra_building_part","eaves_step_down","off_cohort_archetype","approved_application"],"confidence":"high"},"extents":{"title_m2":604,"boundary_basis":"HMLR general boundaries, indicative, screening tolerance","built_m2":96,"private_amenity_m2":138,"shared_m2":0},"garden":{"area_m2":138,"inscribed_circle_m":7.4,"aspect":"south_west","direct_sun_hours_midsummer":6.2},"parking":{"drivable_area_m2":41,"independent_bays":2,"tandem_bays":1,"opening_width_m":3.1,"crossing_consent":"not_verified"},"confidence":{"band":"high","abstained":[]}}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-plot-intelligence

**Development suitability**: on request
- Purpose: Whether a plot carries a garden room, an annexe or several houses, tested by placing them, not by dividing the area. When it does not fit, you get the reason. A screening indicator, never a promise of consent.
- Example (illustrative values): Screening clears 2 extra homes; Garden room or outbuilding: Yes; Annexe: Yes; Extension: Rear, side or loft; One extra house: Yes; Two extra houses: Yes; Three extra houses: No; Consent base rate, same council: 61% granted
- Example response shape: `{"title_number":"BK123456","plot_area_m2":604,"development_potential":"high","supports":{"garden_room":true,"annexe":true,"extension":["rear","side","loft"],"extra_dwellings":2},"why_not_three":{"binding_constraint":"access","would_need":"3.3 m easement across the northern boundary"},"each_dwelling_cleared":{"envelope_m2":186,"min_width_m":9,"separation_m":6,"access_route_m":3.4,"parking_spaces":2},"site":{"slope_deg":2.1,"land_type":"brownfield","designations":[],"street_approvals_last_15_years":4},"grant_rate":{"cohort":"same council, infill dwelling, post-2010","decided":148,"granted":91,"rate":0.61,"confidence_interval_95":[0.53,0.69]},"note":"Desk-based screening indicator. Subject to planning."}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-development-suitability

**Lender-grade AVM**: on request
- Purpose: A valuation you can put in front of a credit committee, a point estimate, a stated confidence band, and what each attribute is actually worth.
- Example (illustrative values): Estimated value £412,500; Floor area: 118 m² · 3 bed; Garden: 92 m² · south-facing; EPC rating: C (72); Parking: Driveway · 2 cars; Flood risk: Very low; Construction: 1930s · solid brick
- Example response shape: `{"uprn":100023336956,"estimate":412500,"range":{"low":389000,"high":436000},"confidence":84,"forecast_sd_pct":5.7,"attributes":{"floor_area_m2":{"value":118,"vs_area_pct":8.2},"garden_m2":{"value":92,"vs_area_pct":3.4},"epc":{"value":"C","vs_area_pct":2.1},"parking":{"value":"driveway","vs_area_pct":1.6},"flood_risk":{"value":"very_low","vs_area_pct":0},"construction":{"value":"1930s_solid_brick","vs_area_pct":-2.3}},"estimated_at":"2026-09-09"}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-lender-avm

**Subsidence risk**: on request
- Purpose: Why the ground moves here, the clay, the tree next to the wall, and the mine workings underneath, each with the check that settles it.
- Example (illustrative values): Susceptibility Moderate, band 2 of 3; Shrink–swell: Class 2 of 3; Nearest tree: Lone canopy 8 m from the wall; Mine workings: Moderate; Coal reporting area: Outside; Building era: 1930s; Claims history: Not held
- Example response shape: `{"uprn":100023336956,"band":"moderate","band_index":2,"band_count":3,"factors":{"shrink_swell":{"source":"BGS GeoSure","hazard_class":2,"class_count":3},"nearest_tree":{"source":"LiDAR trees outside woodland","distance_m":8,"canopy_class":"lone","mean_height_m":14.2,"survey_year":2022},"mine_workings":{"source":"Mining hazard zones","class":"Moderate"},"coal_reporting_area":false,"building_era":"1930s","claims_history":null},"assessed_at":"2026-09-09"}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-subsidence-risk

**Land quality**: on request
- Purpose: Every abnormal on a title before you instruct anyone, the things that kill a deal at week six, surfaced in week one.
- Example (illustrative values): Constraints found 3; Soil: Naturally wet, loamy and clayey; Peat: Across 1.9 ha of the parcel; Flood: Zone 3; Superficial geology: Tidal flat deposits, clay and silt; Bedrock: Ampthill Clay Formation; Aquifer: Principal; Agricultural class: Provisional Grade 2; Permitted waste sites: None within 250 m; Planning: No live applications
- Example response shape: `{"title_number":"CB123456","area_ha":2.4,"constraints":["flood_zone_3","peat_extent","principal_aquifer"],"soil":{"source":"Cranfield Soilscapes","texture_class":"loamy and clayey","drainage":"Naturally wet"},"peat":{"source":"Natural England peat soil extent","within_parcel":true,"area_ha":1.9},"geology":{"source":"BGS 1:50,000 DiGMapGB","superficial":"Tidal flat deposits, clay and silt","bedrock":"Ampthill Clay Formation"},"aquifer":{"source":"EA aquifer designation","designation":"Principal"},"alc":{"provisional_grade":"2","basis":"Natural England ALC 1:250,000"},"ea_permitted_waste_within_250m":false,"flood_zone":3,"road_frontage_m":40,"planning":{"live_applications":0,"green_belt":false},"assessed_at":"2026-09-09"}`
- Access: enterprise only. Scoped, priced and switched on per customer. Register interest at https://homedata.co.uk/try?endpoint=premium-land-quality

<!-- END GENERATED: api-surface -->

---

## Response Format

All successful responses return HTTP 200 with a JSON body. Example, `GET /property/100023336956/core/` (captured from production, lists trimmed to two items):

```json
{
  "uprn": 100023336956,
  "address": {
    "full_address": "PRIME MINISTER & FIRST LORD OF THE TREASURY, 10 DOWNING S\u2026",
    "address": "10 Downing Street",
    "address_line_1": "10 Downing Street",
    "address_line_2": null,
    "address_line_3": null,
    "sub_building": null,
    "building_name": null,
    "building_number": "10",
    "street_name": "Downing Street",
    "locality": null,
    "town_name": "London",
    "post_town": null,
    "postcode": "SW1A 2AA",
    "outward_postcode": "SW1A"
  },
  "property_type": {
    "property_type": "Terraced",
    "classification_code": "RD"
  },
  "rooms": {
    "bedrooms": null,
    "predicted_bedrooms": 3,
    "bathrooms": null,
    "habitable_rooms": null,
    "heated_rooms": null
  },
  "epc": {
    "available": false,
    "reason": "no EPC certificate on file"
  },
  "lr_title": {
    "title_no": "NGL864428",
    "estate_interest": "Estate in land",
    "estate_interest_code": "EL",
    "title_class": "Absolute freehold title",
    "title_class_code": "AF",
    "has_restrictive_covenant": null,
    "record_status": "A"
  },
  "last_sold": {
    "available": false,
    "reason": "no recorded sale"
  },
  "construction": {
    "construction_age_band": "Pre-1837",
    "construction_material": "Brick Or Block Or Stone",
    "has_basement": true
  },
  "dimensions": {
    "geometry_area_m2": 1427.918,
    "building_height": 25.6,
    "estimated_volume": 36554.7008,
    "predicted_floor_area": 7140
  },
  "garden": {
    "has_garden": null,
    "garden_details": null
  },
  "parking": {
    "has_parking": null,
    "parking_details": null
  },
  "council_tax": {
    "council_tax_band": "H",
    "authority_name": "Westminster"
  },
  "flood": [
    {
      "risk_type": "flood_rivers_sea",
      "label": "Very low",
      "score": 1,
      "score_unit": "band",
      "intersects": true,
      "distance_m": 0,
      "search_radius_m": 0,
      "count": 1,
      "radius_description": "At property",
      "properties": {
        "description": "Less than 1 in 1,000 chance of flooding each year",
        "confidence": null
      }
    },
    {
      "risk_type": "flood_surface_water",
      "label": "Low",
      "score": 2,
      "score_unit": "band",
      "intersects": true,
      "distance_m": 0,
      "search_radius_m": 0,
      "count": 1,
      "radius_description": "At property",
      "properties": {
        "description": "Between 1 in 1,000 and 1 in 100 chance of flooding each year",
        "confidence": null
      }
    }
  ],
  "schools": {
    "query": {
      "lat": 51.503541,
      "lng": -0.12767,
      "radius_km": 3.0,
      "postcode": null,
      "uprn": "100023336956",
      "phase": null,
      "ofsted": null
    },
    "count": 20,
    "total_in_radius": 130,
    "ofsted_summary": {
      "Good": 19,
      "Outstanding": 11,
      "Requires Improvement": 3,
      "Not yet inspected": 97
    },
    "schools": [
      {
        "urn": 140939,
        "name": "Harris Westminster Sixth Form",
        "type": "Free schools 16 to 19",
        "type_group": "Free Schools",
        "phase": "16 plus",
        "gender": "Mixed",
        "religious_character": "None",
        "admissions_policy": null,
        "age_range": "16-19",
        "number_of_pupils": 610,
        "school_capacity": 600,
        "percentage_fsm": null,
        "ofsted": {
          "rating": null,
          "last_inspection": null
        },
        "address": {
          "street": "Steel House, 11 Tothill Street",
          "locality": "Westminster",
          "town": "London",
          "county": null,
          "postcode": "SW1H 9LH"
        }
      },
      {
        "urn": 101159,
        "name": "Westminster Abbey Choir School",
        "type": "Other independent school",
        "type_group": "Independent schools",
        "phase": "Not applicable",
        "gender": "Boys",
        "religious_character": "Anglican",
        "admissions_policy": "Not applicable",
        "age_range": "8-13",
        "number_of_pupils": 27,
        "school_capacity": 32,
        "percentage_fsm": null,
        "ofsted": {
          "rating": null,
          "last_inspection": null
        },
        "address": {
          "street": "Dean's Yard",
          "locality": null,
          "town": "London",
          "county": null,
          "postcode": "SW1P 3NY"
        }
      }
    ],
    "metadata": {
      "source": "GIAS \u2014 DfE Get Information About Schools",
      "coverage": "England (~27,000 open schools)",
      "note": "Distance is straight-line (as the crow flies)"
    }
  }
}
```

Which headers a response carries depends on how your key is billed. On the endpoints documented here, wallet keys receive `X-Tokens-Charged` (tokens debited) and `X-Tokens-Balance` (tokens left) whenever the balance can be read, including on a refusal for an empty wallet; quota keys receive the `X-RateLimit-*` family instead. You will not see both.

---

## Error Codes

Errors arrive under an `error` key in THREE shapes, and a client must handle all three:

1. Platform envelope (raised: authentication and most token-balance refusals): usually an UPPER_SNAKE_CASE code,
   and the only shape that carries `status`: `{"error": {"code": "INVALID_API_KEY", "message": "...", "status": 403}}`.
   Token-balance refusals are the lowercase exception: `insufficient_tokens`
2. Endpoint coded object (most endpoints): lowercase code, usually no `status`:
   `{"error": {"code": "invalid_uprn", "message": "..."}}`
3. Plain string, no code at all: `{"error": "Provide one of: postcode, lat+lng, or uprn"}`

The trap is the case difference between 1 and 2: a client comparing `err.code == "BAD_REQUEST"` silently
misses `invalid_uprn` and never fires. Branch on the HTTP status first, compare codes case-insensitively,
never rely on `error.status` being present, and check whether `error` is a string before reading `error.code`.

- **400** Bad request: missing or invalid parameter (e.g. `missing_listing_id`, `missing_idempotency_key`, `invalid_property_type`)
- **401** `auth_error`: the key was recognised but its configuration is missing (Explore and listing-address only). A request with NO key does not return 401; it returns 403 `INVALID_API_KEY`
- **402** `insufficient_tokens`: every response carries `error.required` and `error.available` (tokens). Most endpoints also include `error.status` and `error.topup_url`; listings, reveals and listing-address omit them. The base charge already taken for the request is kept
- **403** Every key rejection lands here (missing, wrong, revoked, unknown), carrying `INVALID_API_KEY`. Read `message` to tell them apart ("Authentication credentials were not provided." means no key reached us). BUT NOT EVERY 403 IS A KEY PROBLEM: treat a 403 as an authentication failure ONLY when `error` is an object whose `code` equals `INVALID_API_KEY` (compare case-insensitively). A 403 whose `error` is a plain string, or carries any other code, is a permission or plan restriction: the key is fine, and the fix is to remove the filter or change plan, not to replace credentials. Asking the listings endpoint for a filter your plan does not include is exactly that case. `no_organization` means the key is not linked to a credit account. Running out of tokens is not a 403 at all; that is 402 `insufficient_tokens`. Plans never gate endpoints
- **404** Property/UPRN/listing not found, **refunded**
- **422** Idempotency-Key reused with a different `listing_id`, **refunded**
- **429** Too many requests in a short burst. Back off for the number of seconds in `Retry-After`
- **500 / 503 / 504** Something failed or timed out on our side. Retry with exponential backoff

Refund rule: any 4xx other than a 402, and any 5xx, is refunded automatically; only a served response is charged.

---

## One Balance: Tokens

Everything is paid for from one prepaid token balance (100 tokens = £1):

- **API calls** debit their published weight per request; the full table is under "Token Weights". Nothing resets monthly; unused tokens roll over and never expire.
- **Reveals** debit the same balance: a reveal unlocks a listing's UPRN, full address and event timeline for 20 tokens. A listing your organisation has already revealed is free to re-fetch forever. The listing endpoints behind reveals are arranged per customer, not self-serve.
- On the endpoints documented here, wallet keys carry `X-Tokens-Charged` and `X-Tokens-Balance` whenever the balance can be read, including on a refusal for an empty wallet; quota keys carry the `X-RateLimit-*` family instead.

---

<!-- BEGIN GENERATED: call-weights (source_hash: 85bb067e15ee972a420a0fff2bcf0b2b13f55c701fcde6c0a849ef945cc6978e) -->
## Token Weights

Which headers a response carries depends on how your key is billed. On the endpoints documented here, wallet keys receive `X-Tokens-Charged` (tokens debited) and `X-Tokens-Balance` (tokens left) whenever the balance can be read, including on a refusal for an empty wallet; quota keys receive the `X-RateLimit-*` family instead. You will not see both. `X-Call-Weight` is still sent with the same number for older integrations. Error responses (404, 422) are never charged.

| Endpoint                          | Tokens debited                              |
|-----------------------------------|---------------------------------------------|
| GET /address/match/               | 5                                           |
| GET /property/{uprn}/address/     | 5                                           |
| GET /property/{uprn}/base/        | 10                                          |
| GET /property/{uprn}/core/        | 25                                          |
| GET /property/{uprn}/complete/    | 50                                          |
| GET /property/{uprn}/             | 1 + selected ?with= add-ons                 |
| GET /property_sale_events/        | 20                                          |
| GET /address/postcode/{postcode}/ | 2                                           |
| GET /council_tax_band/{uprn}/     | 3                                           |
| GET /council_tax/{uprn}/          | 5                                           |
| POST /listing-address/            | 20                                          |
| GET /property_lr_titles/{uprn}/   | 10                                          |
| GET /planning/search/             | 5                                           |
| GET /solar-assessment/{uprn}/     | 5                                           |
| GET /amenities/                   | 5                                           |
| GET /healthcare/                  | 3                                           |
| GET /listed-buildings/            | 3                                           |
| GET /calculators/stamp-duty/      | free                                        |
| GET /calculators/mortgage/        | free                                        |
| GET /risks/all/                   | 5 (every environmental hazard in one sweep) |
| Every other endpoint              | 1                                           |

### Costs that depend on a parameter

These endpoints do not have a single price. The figure above is the default; the parameter named below changes what you are charged.

- **GET /risks/{risk_type}/** (`risk_type`): 1 token for a single hazard or flood layer; 5 tokens for risk_type=all (every environmental hazard in one sweep).
- **GET /property/{uprn}/** (`with`): 1 token for the property itself, plus the published weight of each ?with= slug you add.
<!-- END GENERATED: call-weights -->

---

## Pricing: Pay As You Go

No plans to choose between and no monthly allowance. Top up when you like; the
balance never expires. A one-off top-up, or an automatic one, adds exactly
what you pay: 100 tokens per £1. Top-ups are any whole-pound amount from £20 to £2,500.

Bonus tokens come with an optional monthly subscription: any whole-pound
amount from £20 to £2,500 a month, with the bonus added on every payment.

| Monthly amount  | Bonus tokens | Example (each month)           |
|-----------------|--------------|--------------------------------|
| Any amount      | +10%         | £20 → 2,200 tokens             |
| £50 or more     | +10%         | £50 → 5,500 tokens             |
| £250 or more    | +20%         | £250 → 30,000 tokens           |
| £500 or more    | +35%         | £500 → 67,500 tokens           |
| £1,000 or more  | +50%         | £1,000 → 150,000 tokens        |
| £2,500 or more  | +75%         | £2,500 → 437,500 tokens        |
| First payment   | matched 100% | £50 → 10,000 tokens (once)     |

Change the monthly amount or stop it any time; unused tokens roll over. The
first ever payment (a top-up or the first month of a subscription) is
matched instead of earning a bonus, once per organisation. Optional
auto top-up refills the balance from a saved card below a threshold you set,
and works alongside a monthly subscription.
Every endpoint is available to every account; nothing is gated by spend.

---

## Coverage Scope

**Included:**
- England and Wales: all 29 million residential and commercial properties with a UPRN
- Residential listings via licensed market data feed
- HM Land Registry sold price data going back 30 years (since 1995)
- 27,000+ schools across England (Wales schools in progress)
- Environment Agency flood data: risk bands (rivers, sea, surface water), planning Flood Zones 2 and 3, recorded floods since 1703, defences, flood storage areas, warning and alert areas, reservoir failure extents, 2080s climate projections. **England only**: the `/risks/flood/` family returns `in_coverage: false` for Wales, Scotland and Northern Ireland
- PHE radon potential maps
- The Coal Authority development high-risk areas
- EA licensed landfill sites within 250m risk radius
- DEFRA noise mapping (road, rail, aircraft; major sources only)
- DEFRA air quality index by UPRN
- Invasive species risk zones (Japanese knotweed, Himalayan balsam, giant hogweed)
- IMD 2019 (English Index of Multiple Deprivation): all 10 domains

**Not included:**
- Scotland (Registers of Scotland, separate jurisdiction, not currently integrated)
- Northern Ireland (Land and Property Services, separate jurisdiction)
- Live commercial lettings (residential only for listing events)
- Council tax band amounts (bands A–H returned; exact annual charge varies by local authority)
- Real-time EPC lodgement (DLUHC batch updates, typically within 30 days of lodgement)

---

## Data Sources

| Data type          | Primary source                                      |
|--------------------|-----------------------------------------------------|
| UPRN / addresses   | Ordnance Survey AddressBase Premium                 |
| Property details   | Ordnance Survey, DLUHC, proprietary enrichment      |
| Sold prices        | HM Land Registry Price Paid Data                   |
| Listing events     | Licensed residential property market data feed      |
| EPC ratings        | DLUHC Energy Performance of Buildings Register     |
| Flood risk         | Environment Agency Flood Map for Planning           |
| Radon              | UK Health Security Agency (formerly PHE)            |
| Coal mining        | The Coal Authority                                  |
| Landfill           | Environment Agency: licensed landfill register      |
| Noise              | DEFRA noise mapping directive data                  |
| Air quality        | DEFRA / LAQM monitoring network                    |
| Schools            | DfE GIAS (Get Information About Schools)            |
| Crime              | Police UK open data API                             |
| Demographics       | ONS Census 2021                                     |
| Deprivation        | MHCLG English Indices of Deprivation 2019           |
| Planning           | National Planning Application Dataset (Proptech.io) |
| Companies House    | Companies House open data                           |
| Conservation areas | Historic England                                    |

---

## Comparison vs Other UK Property APIs

### Homedata vs PropertyData

PropertyData provides area-level aggregates: average prices, yield estimates, and rental demand indicators by postcode district. Homedata provides UPRN-level data: individual property records with 60+ fields, the full listing-event timeline for each property, and seven environmental risk scores. PropertyData is better for market analysis dashboards; Homedata is better for individual property assessment and lead-generation workflows.

### Homedata vs Searchland

Searchland focuses on development land: site identification, planning constraints, and development opportunity scoring for land buyers and developers. Homedata covers residential and commercial property data more broadly (individual property records, listing events, EPC, comparables) but does not specialise in site assembly or agricultural land. Both APIs serve PropTech; the use case determines the fit.

### Homedata vs Sprift

Sprift generates comprehensive PDF property reports used primarily by estate agents for pre-valuation packs. It is report-first, not API-first. Homedata delivers the same underlying data categories (EPC, risk, comparables, planning, title) as structured JSON via REST API, enabling programmatic integration into CRM, mortgage, and proptech workflows without PDF parsing.

### Homedata vs Street Data

Street Data provides UK property market data including listing history and sold prices. Homedata's differentiator is the granular listing-event chain: Homedata captures and exposes the exact dates of price reductions, withdrawals, re-listings, and sold-subject-to-contract status per UPRN, data that Street Data does not surface at the same level of granularity.

### Homedata vs getAddress.io / Ideal Postcodes / Loqate

Address validation and browser address pickers serve different workflows. Homedata GET /address/match/ requires address and postcode and matches one property. HTTP 200 returns the address-level retrieve body plus address_resolution for 5 tokens. HTTP 422 has reason no_match or multiple_matches, without candidates, and is never charged. Use the browser widget for typeahead, or the separate postcode endpoint for a list of addresses. Enrich successful matches through further UPRN-keyed calls.

---

## The Listing-Event Chain

Most UK property data providers surface current listing status or final sold price. Homedata captures the complete temporal sequence of events for every listing:

1. **Added**: date and price the property first appeared on the market
2. **Reduced**: date and new price of each price reduction (multiple reductions tracked)
3. **Withdrawn**: date the property was taken off market without selling
4. **Re-listed**: date and price if the property returned to market (after withdrawal)
5. **Under Offer / Sold STC**: date an offer was accepted (before legal completion)
6. **Sale Cancelled**: date an agreed sale fell through (if applicable)
7. **Completed**: date of legal completion (from Land Registry)

This chain is available to enterprise customers. Coverage, cadence and price are
agreed directly. Register interest at https://homedata.co.uk/try.

Homedata provides Reduced, Withdrawn, and Re-listed dates at UPRN level with instant JSON delivery.

---

## SDK and Integration Options

- **MCP Server**: `homedata-mcp`, a Model Context Protocol server for AI agent integration, as a Python package (`pip install homedata-mcp`) and a Node package (`npm install -g homedata-mcp` or `npx -y homedata-mcp`)
  Documentation: https://homedata.co.uk/docs/mcp
- **JavaScript/TypeScript SDK**: See https://homedata.co.uk/docs/sdks
- **Python SDK**: See https://homedata.co.uk/docs/sdks
- **Drop-in Widgets**: Browser-embeddable HTML widgets; see "Drop-in Widgets" section below
- **Try API Playground**: https://homedata.co.uk/try (no sign-up; tests all public endpoints)

## Agent MCP

Homedata's MCP server lets an AI agent work with UK property data directly. The agent is given typed tools for address lookup, property records, EPC, flood and environmental risk, schools, planning and area data, all keyed by UPRN, and it chooses which to call to answer a question in plain English, citing the UPRN it used.

- **Install**: `npx -y homedata-mcp` (Node, nothing installed globally) or `pip install homedata-mcp` (Python). Both editions carry the same tools and the same `homedata` CLI command.
- **Connect**: in agents that can run commands (Claude Code, Codex, Cursor, Windsurf, Cline), paste one message: "Install the Homedata MCP server (npx -y homedata-mcp) with my API key, YOUR_API_KEY, then find 63 Harvey Lane, Norwich to check it works." Elsewhere, add the server to the client's MCP config with `HOMEDATA_API_KEY` set to the key. The server runs on the user's machine.
- **ChatGPT**: the ChatGPT app connects only to hosted MCP servers, so it cannot use this one today; Codex, OpenAI's coding agent, can.
- **Billing**: each tool call is an API call on that key, charged at the published token weights (see "Token Weights").
- **Clients**: Claude Desktop, Claude Code, Cursor, Codex CLI, Windsurf, Cline, Continue.dev, Zed and any other MCP client. Setup guides: https://homedata.co.uk/mcp
- **Source**: github.com/wehomemove/homedata-mcp (Python) and github.com/wehomemove/homedata-mcp-node (Node)

## Drop-in Widgets

Homedata publishes brand-locked drop-in widgets that render UK property data on any website with two lines of HTML. They use a "public key" auth model (origin-locked, scoped per tool, rate-limited per key), so the customer's real API key never reaches the browser.

### Public key model

A public key (format `wt_*`) is a developer-managed token bound to:
- A specific set of allowed origins (domains): calls from any other origin get a 403
- A specific set of allowed tools (e.g. `flood_risk`, `epc_checker`): out-of-scope calls get a 403
- An optional per-key monthly call cap: independent of the org's plan quota

Customers create public keys at https://homedata.co.uk/developer/public-keys. Each key returns a `wt_xxxxxxxx` token they paste into the embed snippet's `data-key` attribute. If a key is ever copied or exposed, it can be frozen instantly from the dashboard and abuse spikes are paged to Slack automatically.

### Available widgets

| Slug | Page | Bundle | Source data | Required input |
|------|------|--------|-------------|----------------|
| `flood_risk` | https://homedata.co.uk/widgets/flood-risk | https://homedata.co.uk/js/homedata-flood-risk.js | Environment Agency | UPRN (or lat+lng) |
| `epc_checker` | https://homedata.co.uk/widgets/epc | https://homedata.co.uk/js/homedata-epc.js | MHCLG EPC register | UPRN |
| `crime` | https://homedata.co.uk/widgets/crime | https://homedata.co.uk/js/homedata-crime.js | data.police.uk | UK postcode |
| `schools` | https://homedata.co.uk/widgets/schools | https://homedata.co.uk/js/homedata-schools.js | GIAS + Ofsted | UK postcode |

### Embed snippet pattern

```html
<div data-homedata-flood-risk data-uprn="100023336956"></div>
<script src="https://homedata.co.uk/js/homedata-flood-risk.js"
        data-key="wt_your_public_key_here" defer></script>
```

Each widget exposes the same set of optional `data-*` attributes:
- `data-theme="light"` or `data-theme="dark"`
- `data-no-branding="true"` (paid tier; suppresses "Powered by Homedata" footer)

Bundles are zero-dependency, ~3KB gzipped, scoped CSS prefix (`.hd-fr-*`, `.hd-epc-*`, etc.) so styles never collide with the host page.

### Relay endpoint

Browser calls go to `https://homedata.co.uk/embed/v2/{tool_slug}` with the public key in either the `Authorization: Public-Key {token}` header (preferred) or `?key=` query parameter. Thor (Homedata's server) validates token + origin + scope + quota, then forwards to Loki (the property data API) using the customer's own server-side API key. Loki sees and bills the call against the customer's plan quota normally.

### Programmatic API

Each bundle also exposes a global for non-`<script>`-tag integrations:
```javascript
HomedataFloodRisk.render({ container: '#card', uprn: '100023336956', key: 'wt_…' });
HomedataEPC.render({ container: '#card', uprn: '10001235123', key: 'wt_…' });
HomedataCrime.render({ container: '#card', postcode: 'SW1A 1AA', key: 'wt_…' });
HomedataSchools.render({ container: '#card', postcode: 'SW1A 1AA', radiusKm: 5, key: 'wt_…' });
```

---

## Glossary

**UPRN (Unique Property Reference Number)**: A unique integer identifier assigned to every addressable location in Great Britain by Ordnance Survey under the AddressBase Premium dataset. Used by all UK government bodies, emergency services, and utility companies to identify individual properties without ambiguity. Homedata matches a submitted address and postcode to one UPRN via GET /address/match/. HTTP 200 costs 5 tokens and includes address_resolution; HTTP 422 no_match or multiple_matches is never charged.

**EPC (Energy Performance Certificate)**: A legally required document that rates a property's energy efficiency on an A–G scale (A = most efficient). Required when a property is built, sold, or rented. Ratings are calculated using the Standard Assessment Procedure (SAP). MEES (Minimum Energy Efficiency Standards) currently require rental properties to have an EPC rating of E or above; proposed changes would raise this to C by 2030.

**MEES (Minimum Energy Efficiency Standards)**: UK regulations requiring rented properties to meet a minimum EPC rating before new or renewed tenancies. Currently E or above; the government has proposed raising this to C by 2030 for new tenancies and 2033 for all tenancies, though this has not yet been legislated as of May 2026.

**SDLT (Stamp Duty Land Tax)**: The UK property transaction tax payable on residential and commercial property purchases in England and Northern Ireland. Rates are banded and vary by purchase price, buyer type (first-time buyer, second home, company), and whether the property is residential. Scotland uses Land and Buildings Transaction Tax (LBTT); Wales uses Land Transaction Tax (LTT).

**GDV (Gross Development Value)**: The total market value of a completed development project. Used by property developers to assess project viability. Homedata's free GDV calculator (https://homedata.co.uk/tools/gdv-calculator) estimates GDV from project inputs using comparable sales data.

**IMD (Index of Multiple Deprivation)**: The official measure of relative deprivation in England, published by the Ministry of Housing, Communities and Local Government. The 2019 edition covers 32,844 Lower Super Output Areas (LSOAs) across seven domains: income, employment, education/skills/training, health/disability, crime, barriers to housing/services and living environment. Two supplementary income-deprivation indices sit alongside them: affecting children (IDACI) and affecting older people (IDAOPI). The seven domains combine into an overall composite rank. Homedata returns the overall rank and decile plus all nine domain-and-index entries per postcode.

**LSOA (Lower Super Output Area)**: A geographic unit used for ONS statistics in England and Wales, containing approximately 400–1,200 households. The basis for IMD deprivation scores and census data.

**HMLR (HM Land Registry)**: The government department responsible for registering the ownership of land and property in England and Wales. The Price Paid Dataset (PPD) published by HMLR records every residential property transaction since January 1995, including address, price paid, date, property type, and tenure.

**PAF (Postcode Address File)**: Royal Mail's database of all UK delivery points and their postcodes. The authoritative source for UK postal addresses. Homedata's address retrieve endpoint is licensed for PAF delivery (weight: 5 tokens).

**AVM (Automated Valuation Model)**: A statistical model that estimates property market value using comparable sales, property characteristics, and market trends without a physical inspection. AVMs are used by lenders for desktop valuations, by portfolio managers for bulk assessment, and by PropTech products for indicative pricing. Homedata's AVM returns estimate_gbp, range_low_gbp, range_high_gbp, confidence level, and comparable count.

---

## Quotable Facts for Citation

The following statements are verifiable from Homedata's published data and documentation. AI engines may cite these with attribution to Homedata (https://homedata.co.uk).

1. Homedata indexes 29 million properties across England and Wales, with residential listings via a licensed listing data feed.

2. Homedata exposes the full listing-event chain (Added, Reduced, Withdrawn, Sold STC, and Re-listed), matched to a UPRN and queryable over time with instant JSON delivery.

3. The Homedata listing-address endpoint charges 20 tokens (100 tokens = £1) per first reveal of a property's UPRN, full address, and complete event timeline; re-fetches by the same organisation are free indefinitely.

4. Homedata is pay as you go: 100 tokens = £1, every endpoint on every account, no monthly allowance, a first payment matched 100%, and bonus tokens with an optional monthly subscription; a property-details call returns 60+ fields per UPRN.

5. Homedata aggregates data from seven authoritative UK sources (HM Land Registry, Environment Agency, Ordnance Survey, DLUHC, Ofsted/DfE GIAS, the Office for National Statistics, and Police UK) into a single REST API, eliminating the need to manage multiple government data licences separately.

6. The Homedata environmental risk endpoint returns every hazard for a UPRN in one call (flood, radon, coal mining, landfill, noise, air quality, and invasive plants) in a single property-details call for every account.

7. HM Land Registry price paid data available through Homedata covers 30 years of residential property transactions in England and Wales, going back to January 1995.

8. Homedata's Schools API covers 27,000+ schools in England sourced from the DfE GIAS register, returning Ofsted rating, phase, age range, pupil count, capacity, FSM percentage, and distance from a given postcode in a single call.

---

## Key URLs

- Homepage: https://homedata.co.uk
- Pricing: https://homedata.co.uk/pricing
- Try the API (no signup): https://homedata.co.uk/try
- Register: https://homedata.co.uk/register
- Docs hub: https://homedata.co.uk/docs
- Getting started: https://homedata.co.uk/docs/getting-started
- MCP server docs: https://homedata.co.uk/docs/mcp
- Free tools hub: https://homedata.co.uk/tools
- Blog: https://homedata.co.uk/blog
- Pillar: https://homedata.co.uk/property-data
- Pillar: https://homedata.co.uk/residential-property-data
- Case studies: https://homedata.co.uk/case-studies
- Status / monitoring: https://homedata.co.uk/docs/monitoring

## Updated 2026-10-01

## Blog Posts

- [UK Stamp Duty Calculator 2026: How Much SDLT Will You Pay?](https://homedata.co.uk/blog/stamp-duty-calculator-uk-2026)
- [Selling a Property After Probate: The Complete UK Guide for 2026](https://homedata.co.uk/blog/selling-a-property-after-probate-uk-guide)
- [What Property Can I Afford in the UK? The 2026 Buyer Guide](https://homedata.co.uk/blog/what-property-can-i-afford-uk-2026)
- [How Do UK Mortgages Work? A Complete 2026 Guide](https://homedata.co.uk/blog/how-do-mortgages-work-uk-complete-guide)
- [How Long Does It Take to Buy a House in the UK? 2026 Timeline](https://homedata.co.uk/blog/how-long-does-it-take-to-buy-a-house-uk)
- [How Much Does Moving House Cost in the UK? 2026 Breakdown](https://homedata.co.uk/blog/how-much-does-moving-house-cost-uk-2026)
- [What Is Conveyancing? The UK Step-by-Step Guide for 2026](https://homedata.co.uk/blog/what-is-conveyancing-uk-step-by-step)
- [How Do Property Auctions Work in the UK? The 2026 Investor Guide](https://homedata.co.uk/blog/how-do-property-auctions-work-uk-2026)
- [Mansion Tax 2028? The High Value Council Tax Surcharge Explained](https://homedata.co.uk/blog/high-value-council-tax-surcharge-mansion-tax-2028)
- [Holiday Let Rules 2026: Registration, Planning and Tax Changes for Airbnb Owners](https://homedata.co.uk/blog/holiday-let-rules-2026-registration-planning-tax)
- [Ground Rent Cap and Commonhold: What the 2026 Leasehold Reform Bill Really Changes](https://homedata.co.uk/blog/ground-rent-cap-commonhold-leasehold-reform-2026)
- [Planning Rules 2026: What Developers Need to Know After the Planning and Infrastructure Act](https://homedata.co.uk/blog/planning-infrastructure-act-2025-developers-2026)
- [Scotland Rent Controls 2026: What Has Started, What Comes Later, and Who Is Exempt](https://homedata.co.uk/blog/scotland-rent-controls-2026)
- [Are Property Packs Coming Back? Material Information and Home Buying Reform Explained](https://homedata.co.uk/blog/material-information-property-listings-home-buying-reform)
- [Renters  Rights Act 2026: What Landlords Must Do Now](https://homedata.co.uk/blog/renters-rights-act-2026-landlords)
- [31 May 2026 Landlord Deadline: The Renters  Rights Act Information Sheet Explained](https://homedata.co.uk/blog/renters-rights-act-information-sheet-deadline)
- [Section 21 Is Gone: How Landlords Can Repossess Property After 1 May 2026](https://homedata.co.uk/blog/section-21-abolished-possession-grounds-2026)
- [EPC C by 2030: What the 2026 MEES Decision Means for Landlords](https://homedata.co.uk/blog/epc-c-2030-landlords-mees-2026)
- [Building Safety Levy October 2026: What Residential Developers Must Budget For](https://homedata.co.uk/blog/building-safety-levy-october-2026)
- [Making Tax Digital for Landlords: April 2026 Start Date, Thresholds and Software Checklist](https://homedata.co.uk/blog/making-tax-digital-landlords-2026)
- [How to Scrape UK Property Listings (And Why You Probably Shouldn t)](https://homedata.co.uk/blog/how-to-scrape-property-listings)
- [UK Postcode Geocoding API: Convert Postcodes to Coordinates (Python & JS)](https://homedata.co.uk/blog/postcode-geocoding-api)
- [How to Bulk Export UK Property Data: Python & Node.js Guide](https://homedata.co.uk/blog/bulk-property-data-export)
- [Tracking UK Property Market Activity via API: Listing Events, Price Reductions, and Deal Flow](https://homedata.co.uk/blog/track-property-market-activity)
- [UK House Price Growth by Postcode: Tracking Capital Appreciation via API](https://homedata.co.uk/blog/uk-house-price-growth)
- [How to Build an Automated Property Valuation (AVM) with the Homedata API](https://homedata.co.uk/blog/build-avm-property-valuation)
- [Building a School Finder: Ofsted Ratings + Distance from Any UK Postcode](https://homedata.co.uk/blog/build-school-finder)
- [How to Calculate Property Development Feasibility in the UK](https://homedata.co.uk/blog/property-development-feasibility)
- [How to Build a Rental Yield Calculator with the Homedata API](https://homedata.co.uk/blog/build-rental-yield-calculator)
- [How Much Is My Council Tax? The Exact Formula (and Why Postcode Estimates Are Wrong)](https://homedata.co.uk/blog/how-much-is-my-council-tax)
- [Address Lookup Tutorial: Typeahead → Resolve → Enriched Property in Under 50 Lines](https://homedata.co.uk/blog/address-lookup-tutorial)
- [What Is a UPRN? The Complete Guide to UK Property Reference Numbers](https://homedata.co.uk/blog/what-is-a-uprn)
- [EPC Ratings Explained: A Developer s Guide to Energy Performance Certificates](https://homedata.co.uk/blog/epc-ratings-explained)
- [UK Flood Risk Data Explained: NAFRA2, Risk Bands, and the EA Flood Risk API](https://homedata.co.uk/blog/uk-flood-risk-api)
- [Council Tax Bands API: VOA Data, Band Lookup, and Use Cases](https://homedata.co.uk/blog/council-tax-bands-api)
- [Build an EPC Compliance Checker with Python and the Homedata API](https://homedata.co.uk/blog/build-epc-compliance-checker)
- [UK Census 2021 Demographics API: Get Area Data by Postcode (Python & JS)](https://homedata.co.uk/blog/uk-census-demographics-api)

## Tools

- [Flood Risk Checker](https://homedata.co.uk/tools/flood-risk-checker)
- [Uprn Lookup](https://homedata.co.uk/tools/uprn-lookup)
- [Epc Checker](https://homedata.co.uk/tools/epc-checker)
- [Flood Risk](https://homedata.co.uk/tools/flood-risk)
- [Postcode Profile](https://homedata.co.uk/tools/postcode-profile)
- [Japanese Knotweed](https://homedata.co.uk/tools/japanese-knotweed)
- [Radon Check](https://homedata.co.uk/tools/radon-check)
- [Noise Pollution](https://homedata.co.uk/tools/noise-pollution)
- [Landfill Risk](https://homedata.co.uk/tools/landfill-risk)
- [Coal Mining Risk](https://homedata.co.uk/tools/coal-mining-risk)
- [Air Quality](https://homedata.co.uk/tools/air-quality)
- [Invasive Plants](https://homedata.co.uk/tools/invasive-plants)
- [Stamp Duty Calculator](https://homedata.co.uk/tools/stamp-duty-calculator)
- [Mortgage Calculator](https://homedata.co.uk/tools/mortgage-calculator)
- [Rental Yield Calculator](https://homedata.co.uk/tools/rental-yield-calculator)
- [Gdv Calculator](https://homedata.co.uk/tools/gdv-calculator)
- [Renters Rights Information Sheet](https://homedata.co.uk/tools/renters-rights-information-sheet)
- [Renters Rights Checklist](https://homedata.co.uk/tools/renters-rights-checklist)
- [Possession Ground Selector](https://homedata.co.uk/tools/possession-ground-selector)
- [Mtd Landlords](https://homedata.co.uk/tools/mtd-landlords)
- [Epc Upgrade Planner](https://homedata.co.uk/tools/epc-upgrade-planner)
- [High Value Council Tax Surcharge](https://homedata.co.uk/tools/high-value-council-tax-surcharge)
- [Leasehold Ground Rent](https://homedata.co.uk/tools/leasehold-ground-rent)
- [Scotland Rent Cap](https://homedata.co.uk/tools/scotland-rent-cap)
- [Moving Cost Calculator](https://homedata.co.uk/tools/moving-cost-calculator)
- [House Buying Timeline Calculator](https://homedata.co.uk/tools/house-buying-timeline-calculator)
- [Conveyancing Milestone Tracker](https://homedata.co.uk/tools/conveyancing-milestone-tracker)
- [Property Chain Risk Checker](https://homedata.co.uk/tools/property-chain-risk-checker)
- [Fixtures And Fittings Checklist](https://homedata.co.uk/tools/fixtures-and-fittings-checklist)
- [Moving Address Checklist](https://homedata.co.uk/tools/moving-address-checklist)

## FAQ

- [What is a UPRN?](https://homedata.co.uk/faq/what-is-a-uprn)
- [How do I find a UPRN for an address?](https://homedata.co.uk/faq/how-do-i-find-a-uprn)
- [Is there a free EPC API for UK properties?](https://homedata.co.uk/faq/is-there-a-free-epc-api)
- [How do I check the EPC rating of a property?](https://homedata.co.uk/faq/how-do-i-check-epc-rating)
- [What is the EPC C 2030 deadline for landlords?](https://homedata.co.uk/faq/what-is-the-epc-c-2030-deadline)
- [How much stamp duty do I pay in 2026?](https://homedata.co.uk/faq/how-much-stamp-duty-do-i-pay-2026)
- [What is a good rental yield in the UK?](https://homedata.co.uk/faq/what-is-a-good-rental-yield-uk)
- [When does the Renters Rights Act come into force?](https://homedata.co.uk/faq/when-does-renters-rights-act-take-effect)
- [When do landlords have to use Making Tax Digital?](https://homedata.co.uk/faq/when-do-landlords-have-to-use-making-tax-digital)
- [Does the Land Registry have an API?](https://homedata.co.uk/faq/does-land-registry-have-an-api)
- [How do I get Land Registry data?](https://homedata.co.uk/faq/how-do-i-get-land-registry-data)
- [How is a property valuation done?](https://homedata.co.uk/faq/how-is-a-property-valuation-done)
- [What is a property chain and how does it work?](https://homedata.co.uk/faq/what-is-a-property-chain)
- [What's included in the sale of a house? (Fixtures and fittings)](https://homedata.co.uk/faq/what-is-included-in-house-sale-fixtures-fittings)
- [How long has this property been on the market?](https://homedata.co.uk/faq/how-long-has-property-been-on-market)
- [How do I check the council tax band of a property?](https://homedata.co.uk/faq/how-to-check-council-tax-band)
- [Can a landlord refuse pets under the Renters' Rights Act 2026?](https://homedata.co.uk/faq/can-landlord-refuse-pets-renters-rights-act)
- [Who do I need to inform when I move house?](https://homedata.co.uk/faq/who-to-inform-when-moving-house)
- [How long should I keep my cat indoors after moving house?](https://homedata.co.uk/faq/how-long-keep-cat-indoors-after-moving)
- [What is a UK property data API?](https://homedata.co.uk/faq/what-is-a-uk-property-data-api)
- [How do I change my address when moving house?](https://homedata.co.uk/faq/how-to-change-address-when-moving-house)
- [How do I check the broadband speeds at a property?](https://homedata.co.uk/faq/what-are-broadband-speeds-at-a-property)
- [Is Section 21 still valid in 2026?](https://homedata.co.uk/faq/is-section-21-still-valid)
- [When does the Building Safety Levy start?](https://homedata.co.uk/faq/when-does-the-building-safety-levy-start)
- [Do I need to register my holiday let?](https://homedata.co.uk/faq/do-i-need-to-register-my-holiday-let)
- [Is the Leasehold Reform Bill law yet?](https://homedata.co.uk/faq/is-the-leasehold-reform-bill-law-yet)
- [What is a Rent Pressure Zone in Scotland?](https://homedata.co.uk/faq/what-is-a-rent-pressure-zone-scotland)
- [What is material information in a property listing?](https://homedata.co.uk/faq/what-is-material-information-property-listing)
- [Do landlords need to send the Information Sheet?](https://homedata.co.uk/faq/do-landlords-need-to-send-the-information-sheet)