MarketCode
ai.marketcode/marketcodeVersion 1.0.0UK property intelligence with evidence behind the numbers.
Status
Responds393 msAnswered our handshake without sign-in.- Last checked
- Nov 14, 2026, 13:31 UTC
- Latency
- 393 ms
- Remotes responding
- 1 of 1
- Sign-in
- No sign-in
- Hosting
- Hosted outside the EU (detected)
- Registry data as of
- Nov 14, 2026, 21:12 UTC
Data from the official MCP Registry, checked by run.zero. How we check
Connect
Streamable HTTP
https://mcp.marketcode.ai/mcpResponds393 msNo sign-in
Claude Code
claude mcp add --transport http marketcode https://mcp.marketcode.ai/mcpClaude Desktop and claude.ai
Settings > Connectors > Add custom connector
Name: marketcode
Remote MCP server URL: https://mcp.marketcode.ai/mcpCursor
{
"mcpServers": {
"marketcode": {
"url": "https://mcp.marketcode.ai/mcp"
}
}
}VS Code
code --add-mcp '{"name":"marketcode","type":"http","url":"https://mcp.marketcode.ai/mcp"}'Built your own server? run.zero hosts MCP servers on European infrastructure.
Tools
106 tools
Read-only | Idempotent | Open world | ||
|---|---|---|---|---|
actor_networkInvestigate recorded corporate ownership, title and agency relationships. Requires the customer's account; never use an anonymous preview key. Depth 1–3, at most 100 nodes; clipped networks explicitly say truncated. Cite publication IDs and provenance on each hop. Missing links are not negative findings. Individuals are excluded. An unpublished root costs no credits. Costs 15 credits (15p). | No | Yes | Yes | No |
actor_pathFind a recorded path between two corporate-network records within three hops. Requires the customer's account. A clipped search returns incomplete, never a claim that no relationship exists. Return the ordered hops with their source/publication evidence. Costs 15 credits (15p). | No | Yes | Yes | No |
address_autocomplete
Address autocomplete. Returns ranked candidates for a partial address or
postcode. Use `address_resolve` to turn a candidate into a canonical UPRN.
This is the free entry point: resolve, lookup and postcode listing are
priced because they return OS AddressBase content, but narrowing a search
is not. Prefer it for anything interactive, and resolve once at the end.
UK only. Free.
| No | Yes | Yes | No |
address_by_postcodeReturn all addresses at a UK postcode. Costs 2 credits (2p); free on marketcode.ai. | No | Yes | Yes | No |
address_by_uprnLook up an address by UPRN (UK only). Costs 1 credit (1p); free on marketcode.ai. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
address_resolveResolve free-text address to canonical record (UPRN for UK). Costs 2 credits (2p); free on marketcode.ai. | No | Yes | Yes | No |
agent_activity
Which estate agents actually transact in an area, ranked by listing count.
Sale and rental are counted and averaged SEPARATELY — an asking price and a
monthly rent do not combine into one median, so read `median_asking_price`
and `median_monthly_rent` as answering different questions.
`area_id` is the marts area id from `area_resolve`.
UK only. Free.
| No | Yes | Yes | No |
area_report
The market for one area, as one document: sourcing readiness per strategy
from the coverage register, the commercial capital and rent indices with
rated stock, the planning decision record for the authority, and the live
listing stock.
THE TWO SCOPES ARE NOT INTERCHANGEABLE. Readiness, commercial stock and the
planning register are keyed on the LOCAL AUTHORITY (`lad_code`, a GSS code
— use `area_resolve` to get one); the live listing lane is keyed on
POSTCODE DISTRICT. Pass both to fill every section, and expect the
unsupplied half to read `not_available` with that reason rather than empty.
As with `property_report`, check `sections_degraded` before describing the
document as complete.
UK only. Costs 25 credits (25p).
| No | Yes | Yes | No |
area_resolve
Resolve an area name or code ("Hackney", "E5") to its area_id, centroid
and full hierarchy as breadcrumbs. Call this first when a question is
about a named area rather than a specific address.
UK only. Free.
| No | Yes | Yes | No |
area_reverse_geocode
The area of a given type containing a coordinate. `type_id` is an area
type UUID and is required — a point sits inside one area per geography
layer, so without it the answer would be ambiguous.
UK only. Free.
| No | Yes | Yes | No |
area_stock_profile
Composition of the built stock in an area: unit counts, HMO share,
mixed-use share, median building height and footprint, solar penetration.
Medians, not means — one tower would skew an average height enough to make
a low-rise district read as mid-rise. Percentages are whole percentages.
`area_id` is the marts area id from `area_resolve`.
UK only. Free.
| No | Yes | Yes | No |
ask_questionUse the SAME Ask router as the portal. Route a place/kind into the published taxonomy, a dated figure to the governed semantic query, or exact company/property/title references to a bounded corporate network/path. This tool proposes execution; it does not execute paid work. Respect unsupported criteria and require acceptance of a paid proposal. Routing catalogue IDs are NOT evidence publication IDs; cite the eventual tool's data provenance. Free. | No | Yes | Yes | No |
asking_price_index_series
Hedonic ASKING-PRICE index for one postcode district, local authority or
Great Britain, from portal listings (Rightmove ~95%), 2022M01 = 100, with
80% bands and posterior standard errors, smoothed toward the parent
geography.
Use this for "how have asking prices in W14 moved since 2022" or to see
whether sellers are ahead of or behind the sold-price index
(market_index_series). Asking LEADS sold by months and includes what never
sells; `value` is an index level, never a price. For asking-price LEVELS
use listing_market_series.
`area_code` is a postcode district ("W14") with area_type="district", a
local authority NAME ("Camden") with area_type="lad", or "NATIONAL". An
unknown area is an error naming the nearest matches; read them back.
READ provenance.pub_freq: the pipeline judged which grain this area's data
can resolve (posterior SE of the monthly move <= 1 pp). If it says
quarterly, prefer frequency="quarterly" and say the monthly series is
noisy. `inc_se_pp` on each point is the SE of that period's move. Free.
| No | Yes | Yes | No |
asking_rent_index_series
Hedonic ASKING-RENT index for one postcode district, local authority or
Great Britain, from portal lettings, 2022M01 = 100, with bands and SEs.
This is the residential rent index; commercial_rent_index_series is the
VOA one for commercial property.
It is validated every build against the ONS Price Index of Private Rents
by local authority and NOT published in a month where the two disagree by
more than a few points a year — so a missing recent month is a refusal, not
an outage; say so. Asking rents, not achieved; `value` is an index level,
never a rent. For rent LEVELS and yields use listing_market_series.
Same area and frequency rules as asking_price_index_series. Free.
| No | Yes | Yes | No |
auction_comps
Auction comparables on ACHIEVED prices, each against our valuation.
A portal tells you a property went to auction. This says what it MADE, and
what our AVM thought it was worth at the same address — the difference
between a comparable and a listing. Use it to judge whether a guide price
is realistic, or what a lot is likely to fetch.
`achieved_to_avm` is the hammer price as a share of our AVM. Below 1.0 the
lot sold under the estimate; the useful spread is wide, from about 0.45 to
0.95 within a single postcode area. Read it alongside `auction_date`: all
AVMs share one snapshot date, so an older lot carries market movement as
well as discount.
Bedrooms and property type come from the UPRN-matched unit rather than the
auction catalogue, which populates property_type on 12% of sold lots and
tenure on none at all.
Give `postcode_district` or `postcode_area` — auction lots carry a
postcode, not an area_id, so there is no area_id path here.
UK only. Free.
| No | Yes | Yes | No |
auction_discount
How far below our valuation UK auction actually clears — the one auction
number nobody else can produce.
An achieved hammer price against an automated valuation of the SAME
property. EIG covers 530+ auctioneers to our six and sells API data, but
runs no AVM; we have less auction data and the valuation. The join is the
product, not the feed.
Nationally over the last 24 months the median lot cleared at about 0.66 of
our estimate — a ~34% discount — and 87% of lots sold below it. The spread
by district is large and real: PR2 clears near 47% below, N1 under 8%.
READ `by_year` BEFORE QUOTING THE HEADLINE, and read `meta.sufficient`.
Every AVM in the warehouse shares ONE snapshot date, so this ratio is an
auction discount only where the sale and the valuation are close in time.
The series sits near 0.65 from 2021 and falls to ~0.44 in 2016-2019 — that
fall is house-price growth sitting between the hammer and the estimate, not
a deeper discount. Widening `months` past about 60 measures the market, not
the auction.
`min_lots` suppresses the headline where too few lots match; a median over
three sales is not a market rate, and `meta.sufficient` says which you got.
Geography is by POSTCODE, not area_id — auction lots carry a postcode.
UK only. Free.
| No | Yes | Yes | No |
auction_lots
Individual UK auction lots: the guide price a lot was marketed at, whether
it sold, the HAMMER PRICE where the auctioneer published one, and the net
yield where quoted.
Five auction houses, Allsop back to 1999. Nothing else on the market sells
achieved auction outcomes through an API — a listings portal tells you a
property went to auction, not what it made.
Use this for: what did comparable lots actually sell for, is a guide price
realistic, what yields are commercial lots trading at, how does a district's
auction market behave. For asking-price or private-treaty sales use
market_volume_series or property_history instead — auction is a different
market and the prices are not interchangeable.
Coverage is a real constraint, not a caveat: about a quarter of lots carry
an achieved price and a fifth a net yield, because most auctioneers publish
a guide and never the result. Set `with_achieved_price` or `with_yield` to
restrict to lots that can answer an outcomes question, and read
`meta.coverage` on the way out so a thin result reads as thin.
`auctioneer` is one of: allsop, savills, acuitus, barnettross,
agentsproperty. Acuitus is the one that publishes net yield beside the
achieved price, so filter to it when yield is the question.
Dates are ISO (YYYY-MM-DD). UK only. Free.
| No | Yes | Yes | No |
auction_stats
Quarterly UK auction statistics by postcode district: lots offered, lots
sold, the sale rate, and average guide, achieved and net yield.
Use this for the shape of a local auction market over time — is it clearing,
are yields moving, is stock rising. For individual comparables use
auction_lots.
READ `n_guide` AND `n_achieved` BEFORE COMPARING THE AVERAGES. They are
computed over DIFFERENT POPULATIONS: a guide price is published for most
lots, a hammer price by a minority of auctioneers. Subtracting one average
from the other does not give an uplift, a discount, or any meaningful
number — the two sets are not the same lots.
Each row carries a `comparable` flag that is false when the two populations
are too unbalanced for the difference to mean anything. When it is false,
report the two figures separately with their counts, and say why.
`quarter_from`/`quarter_to` are the first day of a quarter (2024-01-01,
2024-04-01, ...). UK only. Free.
| No | Yes | Yes | No |
build_cost
Build cost for a scheme: the sector's cost index with its 1- and 5-year
movement, the regional location factor (`region`: NATIONAL, LONDON,
SOUTH_EAST — an error lists what is loaded), the editorial on-cost
percentages (prelims, contingency, overheads & profit, professional fees)
and, given `gia_m2` and `rate_gbp_m2` (your BCIS or in-house base rate,
with `rate_period` in the series' own format, e.g. 2024Q1), an estimate:
the rate carried through the index to the latest period, localised,
multiplied out, with totals at low / mid / high on-costs. The £/m²
benchmark leg says `not_available` until a tender benchmark is loaded —
no rate is invented, and nothing here is a modelled number.
UK only. Free.
| No | Yes | Yes | No |
building_physical
Physical form of the buildings a set of UPRNs sit in: height, volume,
footprint area, floor count, construction and roof material, basement,
green roof, solar panels, and the residential/commercial unit mix.
`year_built` and `num_floors` are thinly populated and come back null
rather than estimated — treat null as unknown, not as absent.
`footprint_geojson` is the recorded WGS84 building outline, simplified at
0.5 m, for report maps and illustrative 3D massing. Use `building_height_m`
(volume divided by footprint), never altitude `height_m_above_sea_level`,
for extrusion. Preserve `geometry_attribution`. The extrusion does not
show actual facades, roof details, or a flat's internal boundaries.
UK only. Costs 15 credits (15p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
changes_since
What changed since you last looked — the portal change feed. Pass the
`next_cursor` from your previous call to get only what is new; on a first
call give a scope (`postcode_districts` or `uprns`) or a `since` date,
because an unbounded read of a 14.6-million-row feed is refused.
THE CURSOR IS AN EVENT ID, not a timestamp. Rows recorded late always take
higher ids, so nothing slips behind your watermark between polls. Each
event carries both `event_date` (when the portal says it happened) and
`observed_at` (when our sweep saw it) — a backfill has an old date and a
recent observation, which is exactly why the cursor is an id.
READ `coverage.event_types` BEFORE TRUSTING AN EMPTY PAGE. `added` and
`price_reduced` are live and daily. `price_increased` and `status_changed`
are sparse and only start in late August. **`delisted` has ONE row in the
whole table: withdrawal is NOT observed, so an empty result for it means we
cannot see it, not that nothing was withdrawn.** Five change kinds a user
may ask for — planning decisions, ownership changes, a lease crossing 80 or
60 years, a new EPC, an AVM move — have no feed at all and are listed under
`coverage.not_yet_fed`. Say which of these you cannot answer.
On a price change, `price.old_price_source` says whether the old price came
from the event itself or was derived from the listing's previous event; the
portal usually reports only the new price. Where neither is available the
change is null, never zero.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
commercial_index_series
Repeat-sales CAPITAL index for UK commercial property, quarterly,
1995Q1 = 100.
Three families exist and nothing else: national ALL; national x sector
for the sectors that passed the level gate (OFFICE, RETAIL, HOTEL,
HOLIDAY_LET); and local authority x ALL for the 19 authorities with enough
pooled repeat sales. There is deliberately NO local x sector series — a
local sector cell is too thin to carry an index — so for "office values in
Manchester" call twice, sector="OFFICE" (national) and area="Manchester"
(ALL), and present the two side by side; each is real.
`area`: omit for national; a local authority NAME ("Manchester", "South
Hams") for the city scope. `sector`: omit for ALL, or a sector name.
`start` / `end`: "2015", "2015Q1", "2015-Q1" or "2015-06"; `end` is
inclusive.
`provenance.method` is repeat_sales for the raw estimator and
repeat_sales_shrunk where thin quarters were blended toward the national
increment; `n_pairs` per quarter is the straddle count, and a quarter with
few pairs is carried by the blend. An empty `series` with
`available_sectors` means the area exists but that sector is not published
for it; an unknown area is an error naming the nearest matches.
This is a capital-value index. For RENTS use commercial_rent_index_series;
the two are not interchangeable (capital = rent / yield, and yields
moved). UK only. Free.
| No | Yes | Yes | No |
commercial_market
The commercial market for a sector and a place: the repeat-sales CAPITAL
index, the VOA rating-list RENT index, and the rated stock standing in the
authority with its hereditament count, total and median rateable value.
THE TWO INDICES ARE NOT COMPARABLE and must never be plotted on one axis
or differenced. The capital index is quarterly and THIN — several quarters
rest on single-digit sale pairs, `n_pairs` is on every point, and
`thin_periods` names the recent ones you should not quote a move from. The
rent index is keyed on VOA rating lists at their antecedent valuation
dates, so it has four points in sixteen years and each is a revaluation of
a constant sample, not a quarter.
Only 19 local authorities carry a capital series, ALL sector only, because
a local sector cell is too thin to publish. Ask for one that has none and
the NATIONAL series comes back labelled as national — check
`area.index_scope` before describing it as local.
Rated stock is the 2026 list only, so it is a snapshot: RV change on appeal
is not derivable per property.
UK only. Free.
| No | Yes | Yes | No |
commercial_property
The commercial property report, by UPRN or by VOA UARN: the hereditament
as the 2026 rating list describes it (rateable value, sector, description),
the sector's rent index across the 2010/2017/2023/2026 lists and its
capital index (national, plus the local authority where one exists), an
income-basis value that capitalises the RV at the district's commercial
auction net yield — with the yield's receipt, and `not_available` where
the district published none — the auction history at the address, the
district's commercial auction market by quarter, the registered owner and
the lease. Blocks that cannot be derived today say `not_available` with
the reason (the RV history per hereditament; the VOA measured area). RV is
a rating measure at the antecedent valuation date, not passing rent —
say so when you quote the income-basis figure.
UK only. Costs 10 credits (10p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
commercial_rent_index_series
Commercial RENT index from the VOA rating lists — FOUR points, one per
list (2010 / 2017 / 2023 / 2026), each dated at that list's antecedent
valuation date (2008-04-01, 2015-04-01, 2021-04-01, 2024-04-01), with the
2010 list = 100.
READ `basis` AND REPEAT IT when you quote a number: the index is derived
from VOA rateable values — the Valuation Office Agency's assessment of
open-market rent at each valuation date — NOT from advertised rents, and
it is not a capital-value index. It moves in four steps; do not
interpolate between them as if it were monthly, and date each point by
`avd_date`, not `list_year`.
Why it exists: it covers the sectors the repeat-sales capital index
cannot (INDUSTRIAL_WAREHOUSE trades in portfolios, not Price Paid), for
every VOA sector and 320 local authorities.
`sector`: omit for ALL, or a VOA sector (OFFICE, RETAIL,
INDUSTRIAL_WAREHOUSE, INDUSTRIAL_FACTORY, PUB_BAR, HOTEL, LEISURE,
HEALTHCARE, EDUCATION, ...). `area`: omit for national; a local
authority GSS code ("E08000003") or NAME ("Manchester", bridged to its
code). `start` / `end`: rating-list years, e.g. "2017".
`link_ratio` is the median rateable-value ratio between consecutive lists
over the hereditaments present in both (`n_constant` of them). An empty
`series` with `available_sectors` means the area is published but not
that sector; an unknown area is an error. UK only. Free.
| No | Yes | Yes | No |
comps_adjustments
The evidence behind a valuation, itemised: same-building comparable
sales for the property, each with its registered price and date, its
time adjustment on the published repeat-sales index (the district's own
series, else the local authority's, else national) to the index's latest
settled month with the carry receipt (`index_unavailable` and no
adjustment where no series covers the property), any relisting penalty
(pass `relisted_uprns` only to model an explicit -10% sensitivity for
relisted/withdrawn comps; this is an assumption, not a measured discount), and the IQR fence that
decided which comps count. Use it to show WHY a value is what it is;
`valuation_full` gives the value itself. `lookback_months` 12–120.
UK only. Costs 10 credits (10p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
constraints_for_geometry
Every planning and environmental designation on a red line, a piece of
land or a point, from the current published layers: green belt, National
Landscapes, national parks, SSSI, SAC, SPA, Ramsar, ancient woodland,
nature reserves, nutrient neutrality, listed buildings, scheduled
monuments, registered parks and battlefields, world heritage sites and
buffers, heritage at risk, flood zones 2 and 3, historic floods, coal
high-risk areas, access land, agricultural land class, conservation
areas, Article 4, TPOs, the brownfield register, archaeological priority
areas, open space and air quality areas.
THREE-VALUED. Each answers `present` (with the share of the site it
covers and up to five features with grade and reference), `absent` (with
the distance to the nearest within 2 km) or `not_checked` with the
reason: the layer is loaded for England only, it is not loaded yet, or
the site's council has published none. not_checked is never a clean
result. `buffer_m` (0-2000) widens the scope. Give exactly ONE scope: `location` ("lat,lng"), `postcode`,
`area_geojson` (a red line, GeoJSON in WGS84, at most 150 km² and 64
vertices), `land_id` or `lpa_code` (GSS, e.g. E07000240); anything else is
refused before any read and nothing is charged. UK only. Free.
| No | Yes | Yes | No |
cost_index
Construction cost index series for a development appraisal's cost side:
`basis` is tender (tender price indices), output (output price indices),
deflator (the construction deflator) or labour. Optional `sector`
(residential, commercial, industrial, infrastructure, all, …), `freq`
(monthly | quarterly | annual) and an inclusive period window in the
series' own format (2014Q1, 2014M01, 2014). Each series carries its base
period and method. UK-wide; regional factors come with the site appraisal.
UK only. Free.
| No | Yes | Yes | No |
council_tax_band
VOA council tax band for a property, from the official list.
Every band is DECLARED — read from the VOA list, never inferred by a model.
`band_source` states which, and a predicted band would arrive as a distinct
value rather than folded in, because a caller cannot tell the two apart
after the fact.
DO NOT PRESENT A BAND AS A BILL. Three fields come back null on purpose and
must not be filled in by estimating:
* `annual_cost_gbp` — the per-band charge for each billing authority is a
separate source we do not hold.
* `effective_date` — the crawl records when the VOA refreshed the LIST,
which is not when this property's band took effect.
* `composite` — same reason; it lives on the per-property detail page.
`status` is `not_found` when the band exists in the VOA list but address
matching has not linked this UPRN to it. That is a matching gap on OUR
side, not evidence the property has no band — report it that way round.
England and Wales only: Scotland is the Scottish Assessors Association and
Northern Ireland is Land & Property Services, neither of which is in this
list. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
data_coverage
The data-coverage register for a local authority — read it before the
data: per-field non-null and source shares over every unit in the
authority (floor area, bedrooms, year built, EPC, last sale, tenure…),
which designation flags were checked and how fully, how many units carry
a registered lease or a hereditament, whether official planning data
covers the authority and how deep it goes (applications, link shares,
latest decision), and how much of the live listing stock the sweep has
dated. `area` is a GSS code (E09000032), a local authority name
(Wandsworth) or a warehouse area id. State the coverage before quoting a
share from a thin field.
UK only. Free.
| No | Yes | Yes | No |
distressed_assets
Properties that keep going to auction and NEVER SELL — the distress screen.
The clearest distress signal in the warehouse: a vendor who wants out and a
market that has said no more than once, both on the public record. Ranked by
how many separate auctions the lot has failed at, then by how long it has
been on the circuit.
READ `guide_to_avm` BEFORE CALLING ANY ROW AN OPPORTUNITY. It is the latest
guide divided by our AVM, and it is the difference between the two reasons a
lot fails:
* above 1.0 — guided ABOVE our estimate. It keeps failing because it is
priced wrong. That is a repricing conversation, not a discount.
* 0.5-1.0 — guided below estimate and repeatedly unsold. The cohort worth
a call.
* below ~0.5 — check the lease before anything else. A flat guided at a
fraction of a freehold estimate is usually short lease, ground rent or a
garage, not a bargain.
`max_guide_to_avm` filters on that ratio; 0.8 keeps only lots guided at
least 20% below estimate. Lots with no guide or no AVM are EXCLUDED when it
is set, because an unknown ratio is not a low one.
Rows are grouped by ADDRESS, not UPRN. Flat-level UPRN matching in this
table collapses separate flats onto one id — five flats in one Nottingham
block share a single UPRN — so a per-UPRN count over-reports. `uprn` is
returned for onward lookups but is not what rows are counted by, and for a
subdivided building it may name a neighbouring unit.
Geography is postcode district or area, not area_id — the auction table
carries postcodes and the UPRN join is too weak to filter on.
UK only. Free.
| No | Yes | Yes | No |
energy_profile
Energy composition of an area: EPC band mix, mains gas / electric / oil
split, heat-pump penetration.
`area_id` is the marts area id from `area_resolve` — pass
`analytics_area_id`, not `area_id`, if the resolve response gives both.
Percentages are of properties HOLDING an EPC, not of all stock, and are
whole percentages (0-100). EPCs are lodged on sale or let, so long-held and
social housing are under-represented — say so when reporting a figure.
UK only. Free.
| No | Yes | Yes | No |
entity_relationshipsRecorded relationship evidence from the derived graph. Use canonical ids from search. Cite path provenance and publication dates. Bounded and eventually consistent; missing links do not establish absence, ownership or off-market status. No private ownership payloads are returned. Free. | No | Yes | Yes | No |
entity_search_capabilitiesGoverned entity families, criteria, coverage and query limits. Call before building searches. Free. | No | Yes | Yes | No |
epc_certificates
Recent Energy Performance Certificates for a property, newest first:
up to five mart certificates and up to five raw certificates. Raw readings
include exact certificate URL/address, floor level, top-storey indicator,
rooms, area and source dates. Compare source vintages; raw certificates may
be newer than the property summary. Unknown floor codes remain unknown;
habitable rooms are not bedrooms. Changes between certificates do not alone
prove building works or a measured-area change.
Each carries a `retrofit_gap`, or null where it cannot be computed. Null
means unknown, NOT zero — a zero gap means the property is already at its
potential, which is a different claim.
No certificate is a real answer, not a failure: EPCs are lodged on sale or
let, so a long-held property may never have had one.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
equity_estimate
Current estimated value against the last recorded sale: gain in pounds and
percent, and how long it has been held.
NOT a loan-to-value: the warehouse holds no mortgage balance, so never
describe the result as equity net of debt. The gain is NOMINAL — a 1998
purchase showing +747% has not beaten inflation by that much, and saying so
is part of reporting it honestly.
A null gain means no recorded sale, not a zero gain.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
grid_capacity
Primary substations near a site, nearest first, with each network
operator's published demand and generation headroom, voltage and
distance; renewable energy projects (REPD) nearby; and which operators'
figures we hold. Headroom is the operator's heat-map figure on its file
date, NOT a connection offer. A substation with headroom null says why
(the operator's figures are not loaded, or none is published for it);
that is never "no capacity". Give exactly ONE scope: `location` ("lat,lng"), `postcode`,
`area_geojson` (a red line, GeoJSON in WGS84, at most 150 km² and 64
vertices), `land_id` or `lpa_code` (GSS, e.g. E07000240); anything else is
refused before any read and nothing is charged. GB. Free.
| No | Yes | Yes | No |
h3_density
Hex-binned stock and transaction density for map layers, at H3 resolution 8.
DENSITY ONLY. There is no usable price per cell — the hex cube's price
column is populated on about 2% of rows and its rental, EPC and per-m2
columns are empty. The response lists what is and is not available; do not
offer a price heatmap from this.
`tx_n` is the transaction COUNT and `tx_value` is the total in pounds.
UK only. Free.
| No | Yes | Yes | No |
land_assembly
The parcels adjacent to one parcel and who owns each — the first question
of a site assembly. Returns each neighbour with its area, land use,
constraints and registered proprietor, plus a `combined` block: total area
in m² and hectares, the number of distinct owners, how many neighbours
already share the subject's proprietor (the parcels needing no second
negotiation), how many have no linked owner, and every constraint present
across the whole assembly.
Address the subject by `parcel_id`, `inspire_id`, `title_number` or
`uprn`. Adjacency means a boundary intersecting the subject's buffered by
`tolerance_m` (0.5 m default) — registered boundaries rarely share an
exact edge, so a strict touch finds almost nothing. Widen `ring_m` to look
further than immediate neighbours.
A neighbour with no owner is one no registered title has been linked to,
NOT one nobody owns — say which when you report it.
UK only. Costs 10 credits (10p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
lha_rate
Local Housing Allowance for a postcode and bedroom category — the ceiling
on housing benefit, and therefore the effective rent floor for a
benefit-funded tenancy. Nothing else in this API tells you what the state
will pay for a property.
THE RATE IS WEEKLY. `rate_unit` says `gbp_per_week` and the figure is
exactly as the rate-setting bodies publish it. Comparing it against a
monthly rent — from `market_facts` rental_value, or a listing's
monthly_rent — understates it by about 4.33x. Convert with 52/12, NOT by
multiplying by 4: a "monthly" figure built from four weeks is 7.7% low and
the error is invisible once it is in a spreadsheet.
Resolved through the Broad Rental Market Area containing the postcode, not
the local authority — a BRMA is its own geography and they do not align.
`brma` names which one answered, and `shared_accommodation_rate` is the
separate, lower figure for under-35 single claimants.
Needs a FULL postcode (a district is not enough to place a BRMA), and
there is no category above 4 bedrooms. Three bodies set these rates: the
VOA in England, Rent Service Scotland, and Rent Officers Wales. Free.
| No | Yes | Yes | No |
listing_history
Every marketing snapshot for a property: asking price over time, price
reductions, days listed, status changes, agent, image count and whether it
had a floor plan.
`price_trajectory` appears only when at least two snapshots carry a price.
No listing at all is a real answer, not a failure — a property sold
off-market or never advertised has none.
UK only. Costs 15 credits (15p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
listing_market_series
Monthly supply-side statistics from portal listings for one area, channel
and bedroom band: listings added and reduced, reduction share (the
market-temperature signal), asking price or rent median and quartiles,
£/m² where a floor area is stated, new-build share, agent concentration
(HHI, top-3 share), and — on rent rows — gross yield on two bases (cell
rent over cell price; per-listing rent over the unit's AVM value), and on
sale rows the asking-to-sold ratio and days to completion on listings the
registry matched to a sale.
THREE THINGS TO SAY WHEN YOU QUOTE THIS. (1) listings_added_n is the
NEVER-REDUCED cohort — listings later reduced carry no listing date — so it
undercounts new listings by reduction_share. (2) sold_matched_n is a
match-rate-limited subset; never divide it by listings_added_n and call it
a sell-through rate. (3) There is no days-on-market-to-sale here: the
portal records no exit dates. Use listing_stock_series for what is on the
market NOW. Free.
| No | Yes | Yes | No |
listing_stock_series
Live listings on the market by day for one area, channel and bedroom band
— the stock-on-market series, with the median age of the dated live stock,
median asking price or rent, and the new-build count.
The series began 2026-09-05 and grows by one point a day: the portal keeps
no exit dates, so stock cannot be reconstructed for the past, only observed
forwards. A short series is therefore expected, not missing data. `start` /
`end` are dates (YYYY-MM-DD). Free.
| No | Yes | Yes | No |
long_held_high_equity
Long-held properties in an area carrying a large paper gain — the classic
off-market cohort, ordered by gain rather than by value.
Typical output for a London district: mid-1990s purchases at £23,000-37,000
now valued at £566,000-758,000.
`area_id` is the marts area id from `area_resolve`.
UK only. Costs 40 credits (40p).
| No | Yes | Yes | No |
lookup_entitiesFind public records by title/address text, postcode or public UUID. Exact and lexical lookup uses no model or embeddings; supports token prefixes and bounded typo tolerance in accepted search publications. Returns separate families with UUID detail links and explicit searched coverage. Never claim an unlisted family was searched, or that no match proves nonexistence. For full address matching use address_autocomplete; for a UPRN use address_by_uprn. For attribute criteria use search_entities with the governed query. Free. | No | Yes | Yes | No |
lpa_profile
A planning authority at a glance: its local plans with stage, dates,
period and housing requirement; the plan timetable; the Housing Delivery
Test result and consequence and other published facts (five-year supply,
affordable %, CIL) each with its source and date; Planning Inspectorate
appeal outcomes over the last 12 months; and which land layers we hold for
it. Pass `lpa_code` (GSS), or a `location`/`postcode` to use the authority
there. A five-year-supply figure is the council's own claim; appeal
decisions can find otherwise. England and Wales. Free.
| No | Yes | Yes | No |
market_facts
Price, price per sqm and turnover rate for ONE geography × asset class ×
bedroom band × period, from the pre-cubed area_facts table.
Metrics: sales_price, price_psm, turnover_rate are populated today.
rental_value, gross_yield and days_on_market are NOT — the pipeline has
never backfilled them, so they come back null and are named in the
response's `metrics_with_no_data`. Do not compare or rank on them, and do
not report a null from them as "no activity"; it means "not collected".
turnover_rate is sales as a share of the stock that could have sold. It
is the liquidity measure — transaction COUNT is market size, not
liquidity (W2 has the largest dwelling stock of any London district and
near-bottom turnover).
Geography is `postcode` (resolved to its district — the cube has no
sector or unit grain) or `lad_code` (a local-authority NAME, e.g.
"Lambeth", not a GSS code). There are no LSOA or ward areas in the
warehouse; those selectors return 422.
To compare AREAS against each other use `market_ranking`, not repeated
calls here. For "how many sales" use `market_volume_series` — the `tx_n`
here counts only UPRN-matched, non-anomalous sales and runs well short of
the registry. The prices are sound; the count is a sample size.
READ `tx_decision` BEFORE QUOTING A PRICE. Every row carries one, and it
says how much evidence is behind that number. Measured over the whole cube:
direct 2.7% 30+ sales in the cell. Quote it plainly.
modeled 15.4% 5-29 sales. Sound, lightly smoothed.
suppressed 44.0% 1-4 sales. Indicative — say the sample is thin.
imputed 17.3% ZERO sales. The price is the prior BORROWED from a
parent geography, not a measurement of this cohort.
missing 20.7% zero sales and no price at all (null).
An `imputed` row looks exactly like a real one — a confident, specific
figure — and it repeat | No | Yes | Yes | No |
market_forecast
The published house-price index forecast for a postcode district or local
authority: the last SETTLED index point as the anchor, then up to seven
forecast periods with `lo`/`hi` bands, plus the method and publication
grain behind them. Seven is the horizon the index publishes — nothing
beyond it is offered, and a forecast is a projection of the smoothed
repeat-sales index, not a valuation of any property.
UK only. Free.
| No | Yes | Yes | No |
market_index_series
The published house-price INDEX for one postcode district or local
authority: the level per month (base period = 100), the forecast tail
flagged, and provenance saying how the index was built.
Use this for "how has W14 moved since 2015", "what is the trend in
Camden", or to carry a known price to today:
price(t2) = price(t1) x value(t2) / value(t1). It is the same series that
shapes valuation_full's back-series (`provenance.series_basis` matches
its `series_basis`). For PRICES by cohort use market_facts; for sale
COUNTS use market_volume_series. `value` is an index level, never a price.
`area_code` is a postcode district ("W14"; a full postcode is truncated)
with area_type="district", or a local authority NAME ("Camden",
"Manchester" — not a GSS code) with area_type="lad". An unknown area is an
error naming the nearest matches; read them back to the user.
`start` / `end` are periods: "2015", "2015-06" or "2015-Q2"; `end` is
inclusive. `limit` keeps the most recent N periods inside the bounds (the
default returns the whole monthly series, 1995 to present).
READ `provenance` BEFORE QUOTING A MOVE. `index_method` is
repeat_sales_area where the area carries its own repeat-sales index, and
repeat_sales_national where the area was too thin and the pipeline
published the NATIONAL index against it — the turns are then national,
not local, and you must say so. `last_settled_period` is the last month
the registry has filled; points after it carry is_forecast=true with
lo/hi bands. `tx_n` per point is the cube's UPRN-matched sample, not the
registry's count.
The index is published monthly. frequency="quarterly" returns an empty
series with a note wherever no quarterly rows exist. UK only. Free.
| No | Yes | Yes | No |
market_profileOne market profile: an area × residential bedroom cohort with every published measure — asking sale price and rent, completed sale price, gross yield on asking, live stock, new listings, price reductions, turnover and registry sale volume — each with its `basis` sentence, unit, coverage and an observed monthly series sliced to `window` months (default 60); plus the asking price/rent indexes, the whole-area house price index (labelled so; there is no cohort HPI), agent concentration and days to completion, and SearchQuery links to the related completed sales and listings. A measure the source does not publish for the cohort is null with the reason, never zero. Ids come from `search_entities` with entity `market_profiles`. Free. | No | Yes | Yes | No |
market_ranking
Rank areas AGAINST EACH OTHER on a market metric — one row per area,
AGGREGATED over a trailing window of whole months.
This is the comparison tool. `market_facts` answers for one geography;
calling it in a loop to build a league table is slower, costs more and
gives you rows from different periods. Use this for "which districts in
Greater Manchester turn over fastest", "rank these twelve postcodes by
price per sqm", "cheapest LADs in the North West by price_psm".
ALWAYS report the `window` block from the response alongside the ranking.
It names the months aggregated, and it matters: a 12-month turnover and a
3-month one differ by roughly 4x. `lag_months` (default 3) deliberately
drops the most recent months because HM Land Registry registers sales
long after completion — the newest month looks near-dead and would rank
registration lag rather than liquidity.
turnover_rate is exact — it is sales over stock, recomputed at this grain.
Price, rent and yield are weighted means of the underlying medians, so
describe them as indicative, not as medians.
`min_stock` (default 50) skips areas with too few dwellings for a rate to
mean anything: one sale in a 2-dwelling district is a turnover of 0.5,
which otherwise tops the table. Where a returned area still has a small
`stock_count`, say so rather than presenting its rate as comparable.
Scope it EITHER by `parent_area_code` (every child of that area, e.g.
every district in a county) OR by an explicit `area_codes` allowlist.
`area_type` is the grain: "Postcode District" (default) or an
administrative type such as "Local Authority District".
`sort` defaults to turnover_rate, the liquidity measure — sales as a
share of the stock that could have sold. Do NOT sort on gross_yield or
days_on_market: they are 0% populated, so every row ties as NULL and the
"ranking" is arbitrary order. Populated metrics are sales_pric | No | Yes | Yes | No |
market_volume_ranking
Rank postcode districts by transaction volume or median price over a
trailing window — "the busiest districts in Greater London last year",
"the priciest districts in SW".
Restrict the candidate set with county ("GREATER LONDON") or area ("SW");
omit both to rank nationally. UK only. Free.
| No | Yes | Yes | No |
market_volume_series
Monthly transaction VOLUME for a postcode district, postcode area or
county — every registered sale, 1995 to present, oldest month first.
Use this, not `market_facts`, for "how many sales" questions.
`market_facts` reads the area_facts cube, whose count is a UPRN-matched
sample that runs 17-66% short of the registry; this reads HMLR price paid
directly. Conversely use `market_facts` for price/rent/yield by asset
class and bedroom band, which this does not break down.
Provide exactly one of district ("SW11", or a full postcode, which is
truncated), area ("SW") or county ("GREATER LONDON"). `district` is a
POSTCODE district, not a borough — "NW1", not "Camden".
`start` and `end` are months: "2024-06" or "2024-06-01", either accepted.
Metrics default to txn_count + median_price. Prices are category A only —
a median including repossessions is not a market median.
ALWAYS check `provisional_from` in the response before reading a trend:
HM Land Registry registers sales months after completion, so the trailing
months are incomplete and will rise. UK only. Free.
| No | Yes | Yes | No |
market_yields
Gross rental yield for an area and bedroom band on two bases, by month,
with n: `gross_yield_asking` (12 × the month's median asking rent ÷ the
median asking price of sale listings in the same area, band and month —
different properties) and `gross_yield_avm_median` (the median, over rent
listings matched to a property, of 12 × asking rent ÷ our valuation of
that property; `gross_yield_avm_n` behind it). Both rest on ASKING rents,
not achieved ones. Null where a month is too thin to publish — say so
rather than averaging around it. `latest` is the most recent month with a
figure. The basis sentence comes with it.
UK only. Free.
| No | Yes | Yes | No |
mixed_use_buildings
Buildings holding BOTH residential and commercial units — the conversion
and permitted-development cohort.
Hard to source elsewhere: it is a property of the building's unit mix, not
an attribute of any single property.
UK only. Costs 30 credits (30p).
| No | Yes | Yes | No |
mortgage_rates
Average UK mortgage rates from the Bank of England: 2-year fixed, 3-year
fixed at 75% LTV, and the standard variable rate.
This is the BoE's published market average — an input to an appraisal, not
a quote. It carries no applicant, product or lender, so do not present it
as a rate someone can get. Pair it with a yield figure or an appraisal
(`site_appraisal`) rather than quoting it alone.
No parameters: it is one national series. Free.
| No | Yes | Yes | No |
owner_profile
What the Land Registry shows for one proprietor: titles held, company
status, country of incorporation, directors and PSCs where known.
Give a company number for an EXACT match. A name is a fuzzy substring
search — company names repeat across unrelated entities, so a name-matched
result is a candidate set, NOT a portfolio, and the response says which
kind you got. Report it that way.
`n_distinct_titles` is the holding count; `n_rows` is higher because one
title appears on several ownership rows over time.
UK only. Costs 25 credits (25p).
| No | Yes | Yes | No |
ownership_by_company
Titles held by a company, by Companies House number. Useful for mapping a
landlord's or developer's portfolio.
England & Wales only. Costs 15 credits (15p).
| No | Yes | Yes | No |
ownership_by_title
Registered proprietor(s) for an HMLR title number.
England & Wales only. Costs 15 credits (15p).
| No | Yes | Yes | No |
parcel_lookup
One land parcel in full: its INSPIRE id, title number and OS id, area and
land use, the registered proprietor where a title links, the units
standing on it, plot utilisation, and every constraint flag.
Address it by `parcel_id`, `inspire_id`, `title_number` or `uprn` —
whichever handle you have. Use `land_assembly` instead when you want the
neighbours.
CONSTRAINTS ARE THREE-VALUED. `in_zone`, `checked_false` and `not_checked`
are three different answers, and a parcel with unchecked flags is
UNASSESSED, not unconstrained. Never report an unchecked flag as clear.
Plot coverage is built footprint over parcel area: a ground-plane measure
that says nothing about storeys, so it is not a density. The unbuilt ground
it implies is an upper bound before any constraint, access or amenity test
— not a developable area, and not a capacity.
Restrictive covenants read `not_available`: the register holds them per
title and the title-to-parcel link is partial.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
planning_appeals
Planning Inspectorate appeal decisions in an authority: case reference,
the council's application reference, appeal type and procedure, site
address, development type, decision and date. England, decided from
October 2021 (the Inspectorate's open casework). Filter by decision and
ISO dates. Matched to the authority; matching to a site boundary comes
with the national planning register. Free.
| No | Yes | Yes | No |
planning_applications
Planning applications near a location, from the register we hold: the
reference, proposal, type, decision and dates of each, nearest first.
COVERAGE IS LONDON (the London authorities, GLA Planning London Datahub);
outside London an empty list is NOT a clean planning history. For appeals
use `planning_appeals`; for allocations use `strategic_sites`.
Give either `postcode` or `location` as "lat,lng".
UK only. Free.
| No | Yes | Yes | No |
planning_check
The planning designation checks you choose, for one location, in one
call. `checks` is any of: article_4, brownfield, ancient_woodland,
heritage_at_risk, tpo, aqma, scheduled_monument, sssi, agricultural_land,
flood_risk, green_belt, listed_buildings, aonb, national_park,
conservation_area — omit it for all fifteen. Each check reports its own
result, and one that could not be read says `status: unknown` rather
than disappearing. Use `planning_designations` for the fixed bundle of
thirteen; use this when you need SSSI or agricultural land grade, or only
two or three checks. Give either `postcode` or `location` as "lat,lng".
UK only. Free.
| No | Yes | Yes | No |
planning_designations
Every planning designation affecting a location, in one call: conservation
area, listed building, green belt, AONB, national park, flood zone,
Article 4, brownfield, ancient woodland, heritage at risk, TPO, AQMA and
scheduled monument.
Give either `postcode` (full UK postcode) or `location` as "lat,lng".
UK only. Free.
| No | Yes | Yes | No |
planning_precedents
What happened to applications like this one nearby — the planning
precedent record. Give a point (`lat`/`lon`) or an `lpa_code`, optionally
narrowed by `application_types` (substrings of the authority's own type
labels, e.g. ["Householder"]).
Returns the approval RATE with its denominator, the median days to a
decision, a breakdown by application type, and recent examples with their
outcomes and links.
TWO DENOMINATORS, AND THEY ARE NOT THE SAME. The rate is over approvals
plus refusals only. The decision time is over the much smaller set of
applications carrying BOTH a received and a decision date — about 13% of
the register. Quote each with its own n; never present the timing sample
as though it were the rate's.
IT IS A RATE, NOT A PROBABILITY. It says what a committee did nearby, not
what it will do with this proposal. Do not convert it into a chance of
approval.
Withdrawals, advisory outcomes (observations on another authority's
application, and confirmations that consent was not required) and
undecided applications are counted separately and excluded from the
denominator — they appear under `excluded_from_rate`.
COVERAGE IS LONDON. The official register is the 35 Greater London
authorities; elsewhere this returns nothing, which is a coverage gap and
NOT a quiet planning history. Say so rather than implying the site is
unprecedented.
UK only. Costs 10 credits (10p).
| No | Yes | Yes | No |
plot_utilisation
Land parcels by size and how much of them is built on. Set
`max_built_coverage` to 0.2 to find largely undeveloped plots.
Parcels with NO measured coverage are excluded when you set a ceiling,
rather than counted as empty — unknown coverage is not evidence of a vacant
plot. Coverage is measured on about 41% of parcels.
UK only. Costs 30 credits (30p).
| No | Yes | Yes | No |
policy_context
The planning policy picture for a site: the adopted and emerging local
plan with stage and dates, the local plan policies whose areas cover the
site (reference, name, theme, a text extract, the share of the site),
the settlement position (inside, outside or straddling a settlement
boundary, with the distance to its edge), neighbourhood plans and the
green belt review rating of the parcel.
Policies are DIGITISED from the council's own layers and documents:
quote the policy reference and source, not our wording. Each layer says
its coverage; `not_held` means we hold no boundary for that authority,
NOT that the site is outside a settlement. Give exactly ONE scope: `location` ("lat,lng"), `postcode`,
`area_geojson` (a red line, GeoJSON in WGS84, at most 150 km² and 64
vertices), `land_id` or `lpa_code` (GSS, e.g. E07000240); anything else is
refused before any read and nothing is charged. UK only. Free.
| No | Yes | Yes | No |
property_comps
Comparable sales in the same building or block. Preserve original price,
sale date, UPRN and `attrs_source`. Backfilled/modelled floor areas are
estimates: their derived price per square metre is not directly observed.
An EPC room count is not automatically a bedroom count. Review anomaly and
category flags; they do not prove distress or justify silently removing
lower contrary sales. Aggregate flags on duplicate identity/date/price
tuples. Verify combined-unit/building-parent demises before treating them
as flat comparables. Repeated sales of one unit are correlated evidence.
Report selection and rejection reasons before applying adjustments.
UK only. Costs 30 credits (30p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_energy_retrofit
The energy picture for one property: current rating against the
certificate's own potential, the points and letter bands available, the
fabric and heating the assessor recorded, and MEES.
MEES IS A LEGAL BAR, NOT A VALUATION NOTE. An F or G cannot lawfully be let
on a new or continuing tenancy in England and Wales without a registered
exemption. Report it as a constraint on what the owner may do, not as a
discount to apply.
A band letter is a RANGE — G spans 19 SAP points, D spans 13 — and the
range is on the response. A null gap means unknown, never "already at
potential".
`recommended_measures` reads `not_available` (gap G3): the assessor's own
improvement list with indicative costs is published by MHCLG in a file we
do not load. Do NOT substitute a generic list of retrofit measures — it
would read as this property's assessment. No pound figure is put on the
uplift either; the elasticity is local and contested and we have not
estimated one.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_flood_risk
Environment Agency surface-water flood risk for a property.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_history
Sold-price history for a property, with per-sale detail.
Use `transactions_by_uprn` instead if you only need the raw HMLR rows.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_lease
Registered leases linked to this UPRN, with the selected longest-expiry
record and up to ten alternatives, exact register property descriptions,
title/record identifiers, source/link limitations and computed remaining
term. UPRN linkage does not verify the legal demise: a garage, parking or
sibling title must not establish the flat lease. Compare descriptions and
disclose truncated/unavailable alternatives. Short-term flags are research
prompts, not legal advice or proof of mortgage eligibility. The AVM does
not adjust for a short term. `status: no_lease` means none was found; it
does not independently prove freehold tenure.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_lease_batch
`property_lease` for up to 100 properties in one call, per-item outcomes
(ok | no_lease | not_found | error) in input order. Charged per property
answered — the sum of the single calls, never more.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_lookup
Full property record for a UPRN, grouped into tiers: identity, property,
energy, building, land, risk, designations, infrastructure, ownership,
provenance. Up to ~300 fields — null fields are omitted, so a typical
urban flat returns fewer than a rural site with designations on it.
`provenance` carries the `<field>_source` and `<field>_confidence`
siblings, so you can trust individual cells and not just rows.
UK only. Costs 25 credits (25p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_media
Photographs, floorplans, EPC graphs and brochures for a property, from the
listings we have crawled. Narrow with `types` — a comma-separated list of
`image`, `floorplan`, `epc`, `brochure`, `virtual_tour`.
EVERY LINK IS OURS AND EVERY LINK EXPIRES. Do not store them; call this
again when you need fresh ones, and set `ttl_seconds` to match how long the
surface you are building keeps them on screen. The portal's own URL is
never returned, so a saved response cannot turn into a hotlink later.
COVERAGE IS UNEVEN AND THE COUNTS TELL YOU. We hold the actual files for
floorplans and brochures only, and for a minority of those; everything else
— including all photographs — is a link that redirects to the source.
`n_held_by_us` against `n_redirected` says which is which for this property,
and `delivery` says it per item. Do not describe a property as having no
photographs when the answer is `no_media`: about a third of listings never
resolve to a UPRN, so that is as often a matching gap as an absence.
Each item carries the portal and host it came from — useful when a user
asks where a picture is from, and when one source turns out to be bad.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_planning_history
Planning history AT this property: applications linked to the unit or its
building — each with decision, dates, appeal, CIL liability, development
type and `match_level` (`unit`, `building`, or `nearby` within 25 m when
nothing is linked) — a summary (approved / refused / withdrawn / pending),
what needs consent here from the designation flags read three-valued
(`applies` against `unchecked`), the LPA, and `coverage`: official
planning data covers the 33 London boroughs today, so
`status: not_covered` outside London is a different answer from
`no_applications`, and is not charged.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_planning_history_batch
`property_planning_history` for up to 100 properties in one call, per-item
outcomes (ok | no_applications | not_covered | not_found | error) in input
order. Charged per property answered — the sum of the single calls, never
more; not_covered rows are free.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_reconcile
Cross-source property facts with provenance and unresolved attributes.
Review floor area, bedrooms and tenure with the user before a valuation.
`ml_primary` and `imputed` are predictions, not measurements; a warehouse
value is not automatically declared. `eligible_as_primary: false` marks
context only: EPC habitable rooms are not bedrooms, occupier tenure is not
legal tenure, and price-derived areas are not measurements. The AVM back-
series is scaled from its headline, not independent corroboration. Keep
user confirmations labelled as user-supplied and unknown facts unknown.
UK only. Costs 15 credits (15p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_rental_estimate
What this property would let for, and on what basis. Always quote the
basis: `unit_asking` is the property's OWN live rental listing (an asking
rent, not an achieved one); `area_asking` is the median asking rent for its
bedroom band in its postcode district — a locality statistic applied to one
property, so quote the p25–p75 range with it rather than the median alone.
`unit_hedonic`, a per-unit model, does not exist (gap G1).
THE YIELD IS GROSS: annual rent over our valuation, before voids,
management, maintenance, insurance, ground rent or service charge. A net
yield is materially lower and we do not publish one — do not present the
gross figure as what an investor keeps.
The LHA block is the local housing allowance for the property's broad
rental market area. That is a HOUSING BENEFIT CAP, not a market rent: it is
the floor for a supported tenancy and usually below the market median. The
shared-room rate is included for an HMO room-by-room comparison.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_report
Everything we hold about one property, as one document — summary, the
registered lease, the risk report with every flag three-valued, a rental
estimate with its basis, the energy picture, and the planning decisions
nearby. One price for the composition, cheaper than the sections bought
separately.
CHECK `sections_degraded` BEFORE SUMMARISING. A section that could not
answer degrades in place and names the KIND of absence — `not_found`,
`no_certificate`, `not_available` with its gap, or `error` — and those call
for different things being said. Report what did not answer rather than
describing the document as complete.
Each section is the standalone tool of the same name with the same
receipts; nothing is computed differently because it is inside a report.
UK only. Costs 25 credits (25p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_risk_report
What this property is in, and whether we actually checked: every
designation and hazard flag THREE-VALUED with its source — flood (zone,
historic flooding, defences, rivers-and-sea band, surface water), coal
(high-risk area, past mining, surface hazard distance), heritage (listed,
conservation area, scheduled monument, registered park, battlefield,
World Heritage), environmental (AONB, national park, green belt, SSSI, NNR,
ancient woodland, nutrient neutrality, SAC, Ramsar, LNR), planning
(Article 4, TPO, brownfield register) and infrastructure (nearest
substation distance, voltage and demand headroom, nearest renewable
project). `true` and `checked_false` are verdicts; `defaulted_false` and
`not_checked` are not — say which when you report it.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_risk_report_batch
`property_risk_report` for up to 100 properties in one call, per-item
outcomes (ok | not_found | error) in input order. Charged per property
answered — the sum, never more.
UK only. Costs 5 credits (5p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
property_summary
One-call summary of a property: what it is, what building it belongs to,
and the headline attributes. Once you have the UPRN this is the first call
to make for a specific property — it usually answers the question on its
own, and `property_report` composes the rest.
UK only. Costs 20 credits (20p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
query_semantic
Run a governed query against the semantic layer: choose an entity, then
the metrics, dimensions and filters you want. Aliases are resolved to
physical columns by the registry, so this cannot reach anything the
semantic model does not expose. The result includes the generated SQL.
Bounded and self-describing.
UK only. Costs 50 credits (50p). You are charged if the query reaches the
warehouse and then times out or errors there; a rejected query is free,
and so is one that matches no rows. Filter area facts on the
`analytics_area_id` from area_resolve; they are monthly, so a year
("2025") or quarter is widened to its months.
| No | Yes | Yes | No |
retrofit_candidates
Properties in an area with the most improvement headroom, ranked by
potential efficiency. Defaults to the sub-standard bands E, F and G.
A targeting tool: it returns a list to act on, not a fact about one
property. Combine with `fuel='gas'` for the fossil-heated cohort that
carries the largest retrofit case.
`area_id` is the marts area id from `area_resolve`.
UK only. Costs 30 credits (30p).
| No | Yes | Yes | No |
search_entitiesBounded public search using the versioned SearchQuery. Criteria are validated by the server; sorting and pagination use the same eligibility as the map. All Entities returns separate groups. No graph inference or unknown evidence changes eligibility.
QUERY SHAPE — `query` is one object:
{"entity": "land",
"geography": {"kind": "area", "id": "Kettering"},
"criteria": {"parcel_area": {"min": 5000, "max": 9000}},
"sort": "<a sort key>"}
`geography` is {"kind": "area", "id": <area UUID, code or exact name>} or {"kind": "polygon", "geometry": <GeoJSON Polygon>}. Refinements go in `criteria`, an object keyed by refinement (not a list, not `filters`/`refinements`). `limit` and `cursor` are arguments of this tool, not of the query.
Families (`query.entity`): Assets — `properties`, `buildings`, `land`, `listings`; Activity — `transactions` (HM Land Registry completed sales matched to a property) and `planning_applications` (official publishers only); Markets — `market_profiles` (one record per area × residential bedroom cohort with the selected `measure`'s latest value and observed trend; open one with `market_profile`). `market_facts` remains for existing observation ids but is superseded by `market_profiles`. Call `entity_search_capabilities` for each family's refinements and sorts. Free.. Actors — `owners` (companies that own homes in the place, ranked by holdings; companies only, signed-in account required, not the shared preview) and `agents` (estate and letting agents by listing activity in a trailing window). Owners and agents are searched on their own, not inside All Entities. | No | Yes | Yes | No |
search_summaryCounts and statistics over EXACTLY what `search_entities` would match: how many records, grouped by a field, with min, median, mean and max of up to three numeric fields. Use it for "how many", "what share", "median floor area" and "price by type" questions instead of paging through records.
`query` is the same object `search_entities` takes (entity, geography, criteria). Summaries cover `properties`, `buildings`, `land` and `listings`. `group_by` is one choice field of that family and `measures` are its range fields; `entity_search_capabilities` lists them under `summary.families`. For example properties: group_by asset_subtype / asset_class / tenure / epc, measures bedrooms / floor_area; listings: group_by property_type / channel / auction / new_home, measures price / bedrooms / floor_area; buildings (a postcode district or a drawn area): group_by tenure / epc, measures footprint / storeys / units; land: group_by tenure, measures parcel_area / built_coverage.
Example: {"query": {"entity": "listings", "geography": {"kind": "area", "id": "SW11"}, "criteria": {"transaction": ["sale"]}}, "group_by": "property_type", "measures": ["price"]}.
A measure's `count` is the records that have a value for it; missing values are never zero. Groups come largest first, `top` of them (max 50), each with its `share` of the total. No record identities are returned: open records with `search_entities`. Too wide a place (a region) or too slow a summary is refused with what to narrow. Transaction counts by area: `market_volume_series`. Free. | No | Yes | Yes | No |
site_access
The nearest bus stops, rail stations, metro or tram stops, ferry
terminals and open schools to a site, straight-line in metres, with names
and NaPTAN or school references. A school catchment is not a distance,
and the school's phase is not held. England (stops GB where published).
Free.
| No | Yes | Yes | No |
site_appraisal
Everything known about ONE site, assembled and judged — the site dossier.
Give a `uprn` (from address_resolve or address_autocomplete) or a `land_id`
(from sourcing_search). Returns in one call what would otherwise be six:
* `site` — the land parcel: area, land use, built coverage, and the
boundary as GeoJSON you can put straight on a map
* `valuation` — our AVM against the last recorded sale, with gain and
years held
* `ownership` — the registered proprietor, type, company number
* `energy` — the latest EPC
* `auction_history` — every appearance, matched on address as well as
UPRN, and whether it ever sold
* `designations` — LIVE checks: conservation area, green belt, AONB,
national park, flood risk, listed buildings
* `signals` — the judgement
READ `signals` FIRST. It is why this exists rather than being six calls.
Each entry names what fired it and carries its evidence: repeat auction
failure with the guide-to-estimate ratio, long_held with the nominal gain,
mees_unlettable with the EPC band (F and G cannot legally be let),
under_built with the plot coverage, corporate_owner with the company
number. A site with nothing to say returns `signal: "none"` explicitly.
ABSENCE IS A REAL ANSWER, NOT AN ERROR. No registered proprietor means the
polygon-to-title backfill has not reached this parcel — it covers about 44%
— not that the land is unregistered. No EPC, no auction history and no
valuation are all normal, and each says so in its own block.
A designation check that FAILS is reported as UNKNOWN, never as absent. Do
not tell a user a site is unconstrained on the strength of a failed check.
A SCHEME PRICES THE BUILD. Pass `scheme_gia_m2` (and `scheme_units` for a
cost per unit) and you get a `scheme` block: build cost from the published
construction index times the regional factor, with on-costs. You must
supply | No | Yes | Yes | No |
solar_potential
Roof characteristics for solar screening: footprint area, roof shape and
material, building height, and whether panels are already present.
Returns NO generation estimate, deliberately. Pitch, orientation and
shading are not in the warehouse, and a kWp figure derived from footprint
alone would read as a yield forecast without being one. Report the usable
roof area as a screening figure and say what it excludes.
UK only. Costs 20 credits (20p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
sourcing_commercial
Rated commercial stock in a local authority, filtered by sector and
rateable value — the commercial sourcing lane. Each row carries its
rateable value, an income-basis value, the freeholder where a title links,
and any auction history.
NO £/m² IS PUBLISHED and you should not compute one. The VOA's measured
area is not loaded, and dividing a hereditament-level rateable value by
the twin's unit-level floor area gives nonsense — it produced £235,301/m²
on a Westminster office before it was removed.
`lad_code` is REQUIRED and is the only scope: this is the one indexed way
into the twin for a bounded set of hereditaments. Use `area_resolve` to
turn a place name into a GSS code.
RATEABLE VALUE IS NOT RENT. It is the VOA's estimate of annual rental
value at the rating list's antecedent valuation date (1 April 2024 for the
2026 list). Do not quote it as passing rent or as income.
`income_basis_value` divides that RV by the district's own commercial
auction yield, so it is an arithmetic conversion anchored to local
evidence, not a valuation — and it reads `not_available` where the
district has no auction yield evidence, because a default yield would
produce a number that looks like a valuation. Report the yield and the
number of lots behind it.
One rating list is loaded (2026), so there is no RV trajectory per
property, no measured floor area from the VOA, and no vacancy signal.
UK only. Costs 10 credits (10p).
| No | Yes | Yes | No |
sourcing_live_listings
What is on the market RIGHT NOW in these postcode districts, each listing
enriched against our own record of the property: asking price against our
valuation (`asking_vs_avm_pct`, `discount_to_avm_gbp`), £/m², gross yield
on both the asking and valuation bases, unexpired lease years, EPC with
its retrofit gap, the designation flags, days listed, the agent, and a
plain-language `signals` list.
A drawn UK polygon can scope the search; pass postcode_districts=[] to
resolve its districts. At most 64 corners, 150 km² and 20 districts.
Only listings with located properties inside the boundary match.
Tenure accepts freehold or leasehold. Tenure, EPC ratings and minimum
gross yield filter before pagination.
Yield uses recorded asking monthly rent annualised against the asking or
auction guide price. Unknown rent/price cannot satisfy a yield filter.
There is NO total — a district holds far more archived listings than live
ones, so counting them costs seconds while the page costs milliseconds.
Read `has_more` and page with `offset`; never tell a user how many
listings exist, only how many you fetched.
A listing enriches only where the portal's own UPRN match landed on a unit
we hold; `enrichment.n_with_valuation` says how many of the rows that was,
and the rest carry the listing's fields with null comparisons.
UK only. Costs 10 credits (10p).
| No | Yes | Yes | No |
sourcing_offmarket_owners
Who owns the stock in an area, ranked as an approach list: units held here,
total value and equity, average and longest years held, how many of their
units are on a short lease or already on the market, company status, and
the signals behind the rank. Pass a `strategy` to rank the owners of only
the units that preset points at — the owners of short-lease flats in a
borough, say.
COMPANIES ONLY, by construction: owners are grouped by company number, so
units held by private individuals have no group to appear in. They are
counted under `not_itemised` and never listed, and you must not attempt to
identify them by other means. Report the `scope.share_itemised` figure so
the user knows what fraction of the area the list covers.
`national_portfolio` reads `not_available`: only the in-area holding is
known, and it is not the owner's whole book — do not present it as one.
UK only. Costs 10 credits (10p).
| No | Yes | Yes | No |
sourcing_owners
Resolve registered owners for parcels returned by `sourcing_search`.
Uses the bulk HM Land Registry corporate and overseas ownership registers,
so it names companies, public bodies and overseas entities. Individually
owned titles are not in the bulk data and come back unresolved — that is a
gap in the free register, not a failed lookup, and naming an individual
requires a paid per-title purchase which this tool does not make.
UK only. Costs 25 credits (25p).
| No | Yes | Yes | No |
sourcing_search
Find land parcels, property units or buildings matching search criteria — the
sourcing tool. Give a `location` (place name, area code or postcode
district) or a `bbox`.
AREA LIMIT: one scan covers at most 150 km². A whole town or local
authority (Harrogate, Cheltenham, Farnham, most boroughs) is usually larger
and is refused with `area_too_large`, which lists the postcode districts
covering it. Search a large place district by district: pass one postcode
district per call as `location` ("HG1", then "HG2"), or a `bbox` no more
than 0.5° on a side. Nothing is charged for a refused area.
STRATEGY MODE (preferred). Pass a `strategy` key from
`sourcing_strategies` with `lad_code` or `postcode_district`, and the
search runs the published preset: its filters, its ranking, and a
`score_components` breakdown on every row saying which term earned what.
Override any published filter with `strategy_overrides` — `{"min_yield_pct":
8}` — or pass null for a key to switch that filter off. An unknown key is
rejected rather than ignored. `listing_state` restricts to on- or
off-market units; page with `cursor` from `next_cursor`. Strategy mode
ignores the legacy filters below.
Filter land by use class and `max_built_coverage` (built footprint as a
share of plot, so 0.2 finds substantially empty plots), units by type,
bedrooms, EPC band and tenure, and either by owner — `min_years_owned` is
the usual off-market signal, and `owner_types` separates companies from
public bodies.
Returns parcels with ownership attached where the bulk register knows it.
For land or units, use sourcing_owners to resolve a specific set afterwards.
PARKS, HEATHS, RAILWAYS, CEMETERIES AND UTILITY LAND ARE EXCLUDED BY
DEFAULT. The scan is ordered by parcel size, and the largest parcels in any
area are its open spaces — unfiltered, a Camden search returned Regent's
Park, Hampstead Heath, a cem | No | Yes | Yes | No |
sourcing_strategies
The nine sourcing strategies as data — read this BEFORE running
`sourcing_search` in strategy mode. Each preset publishes its thesis, its
filters (every key overridable, with the default and the unit), its
ranking components with weights and scales, the feature columns it reads,
the data gaps that limit it, and its version.
Pass `area` as a local-authority GSS code (E09000032) to get `data_ready`
per strategy for that authority: `ready`, `partial`, `not_ready` or
`unknown`, with the coverage share behind the verdict. A `partial` verdict
is usable — say the share when you report the results. Do not run a
preset over an authority marked `not_ready` without telling the user what
is missing.
UK only. Free.
| No | Yes | Yes | No |
strategic_sites
Local plan site allocations, broad locations, land availability
assessment (SHLAA/HELAA/LAA) sites and call-for-sites submissions, in an
authority or near a site (`radius_m`, up to 10 km). Each site carries the
council's own reference, units and area AS PUBLISHED beside our
calculated area, its status and the council's wording for it, the plan and
stage, the delivery timescale, notes, and provenance with the source page.
`laa_positive` is the council's "suitable, available, achievable" view.
COVERAGE: built from council and GLA GIS layers and plan documents,
authority by authority. Where we hold nothing for an authority the answer
says coverage `none`, which is NOT "no sites". The council's figures beat
ours. Give exactly ONE scope: `location` ("lat,lng"), `postcode`,
`area_geojson` (a red line, GeoJSON in WGS84, at most 150 km² and 64
vertices), `land_id` or `lpa_code` (GSS, e.g. E07000240); anything else is
refused before any read and nothing is charged. UK only. Free.
| No | Yes | Yes | No |
subject_transaction_anchor
The property's own last registered sale carried by the published
repeat-sales index to its latest settled month: the price paid, the date,
the index factor applied and the anchored value. Where a property has
sold, this is the strongest single piece of evidence a valuation has.
When no published series can carry the sale the factor and the anchored
value are null and the anchor is diagnostic, never carried at 1.0.
Returns an empty anchor when no registered sale is linked to the UPRN.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
supply_demand
Supply and demand for an area in one call: live stock today (count,
median days on market, new-home count) and the monthly flow — listings
added and reduced, reduction share, new-home share, agent concentration,
asking-to-sold on the registry-matched subset and days to completion.
Read the basis sentences: the flow count is the never-reduced cohort; the
live-stock series began 2026-09-05 and is forward-only.
UK only. Free.
| No | Yes | Yes | No |
time_adjustment
The factor that carries a price paid in a past month to the latest
SETTLED month of the published repeat-sales house-price index: the
postcode district's own series, else its local authority's, else the
national series; forecast months are never used. Returns `factor`, the
two index levels (`index_level_from`, `index_level_to`), `basis`
(repeat_sales_district | repeat_sales_lad | repeat_sales_national),
`current_period` (the month carried to, which trails the calendar by the
registry's lag) and provenance. `status` is ok or index_unavailable: a
price no published series covers has a null factor, never a stand-in 1.0.
A factor of exactly 1.0 is real (a price from that month or later; see
`reason`). The same carry the valuation applies to each comparable and to
the property's own last sale. `postcode` is a full UK postcode or a
district; `from_date` is YYYY-MM-DD; `lookback_years` (1–20) only sets
how much of `monthly_series` comes back.
UK only. Free.
| No | Yes | Yes | No |
transactions_by_uprn
All HMLR Price Paid records joined to this UPRN, newest first.
England & Wales only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
valuation_accuracy
How accurate our valuations have been, measured the only way that cannot
leak: each month, every registered sale the model had ALREADY valued is
compared with the price actually paid — MdAPE (median absolute
percentage error), PPE20 (share within 20%) and n, per asset class and
model version. Until the first vintage lands in October 2026 the answer is
`status: no_rows_yet` with the metric definitions: an empty table, not a
zero error. Filters: `asset_class` (Residential | Commercial | Mixed-Use),
`model_version` (e.g. gbm-h3-v4), `since` (YYYY-MM).
UK only. Free.
| No | Yes | Yes | No |
valuation_comparables
Comparable completed sales for a valuation, beyond the property's own
building: Land Registry sales of the nearest units (within 1 km, the 60
months before `as_of`), widening from 250 m and 12 months until at least
6 qualify. A sale qualifies when it is the same broad type (flats with
flats, houses with houses, from the type recorded at the sale), within
0.67-1.5x the subject's floor area when both are known, category A and
not an anomaly. Category B, anomalous, new-build and out-of-band sales
are returned with `flags`, never dropped: review contrary sales rather
than ignoring them. Each sale: price, date, UPRN, address, distance,
floor area, bedrooms, tenure, `qualifies`, `similarity` (score with
distance, recency, size, type and bedrooms components). Floor area and
bedrooms are the unit's CURRENT record, not as at the sale
(`attributes_after_sale` flags a record dated after it). `selection`
names the step used; `provenance` lists every step tried and the data
watermark. Time-adjust prices with the published index before use.
`as_of` YYYY-MM or YYYY-MM-DD (default today); `limit` 1-60.
UK only. Costs 10 credits (10p). Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
valuation_estimate
Automated value estimate for a property: a point value plus a range.
Returns 404 when we hold no valuation for the UPRN — most often because
the unit has no floor area on record, which the model requires.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
valuation_full
Full valuation block for a property: the value and its range, a monthly
back-series (the value scaled by the local £/m² index, so it terminates
at the headline figure by construction), a rental estimate where the
district benchmark supports one, and a `trust_score` scoring the evidence
behind the number — index sample size, floor-area provenance, model
confidence. Use `valuation_estimate` if you only need the number; this is
materially more expensive.
UK only. Free. Keyed on a UPRN, not an address: call `address_autocomplete` (free) to narrow, then `address_resolve` to get one. | No | Yes | Yes | No |
valuation_rent_comparables
Comparable lets for a market rent, and the rent they indicate. ASKING
rents from portal adverts: no achieved rents exist, so say "asking" when
you quote them. Reads the rent adverts of the nearest units (within 1 km,
last seen in the 24 months before `as_of`), widening from 250 m and 6
months until 4 effective comparables qualify. A let qualifies when it is
the same type family (flats with flats, houses with houses; house shares
and rooms never), the same bedrooms (+/- 1 only when exact cannot reach
the minimum), and within 0.67-1.5x the subject's floor area when both are
known; others come back with `flags`. Each let:
address, distance, beds, floor area, first/last seen, `outcome`
(let_agreed | withdrawn | live | unknown), first and last asking rent,
reductions, days on market, the rent carried to the last complete month
on the asking-rent index (`carried_rent_pcm`), `adjusted_rent_pcm` (equal
to it while size adjustment is off) and its `weight` (distance, recency, size, beds,
type; let agreed counts more, an unlet reduced asking rent less).
`estimate`: central_pcm (weighted median, an achievable ASKING rent),
low_pcm/high_pcm (80% range; back-tested on let-agreed adverts: median
miss 10%, 80% coverage), n_effective, and asking_to_achieved_ratio
(ONS paid rents over the local asking median for the bedroom band, capped
0.85-1.05, 1.0 with ratio_source `none` when no cell) published BESIDE
the estimate, not applied. `time_on_market_days`: median days to let
agreed for the comparable lets. The property's own adverts are never
comparables; its latest is `subject_advert`. `status` ok | thin |
no_comparables | location_unavailable. PASS `beds`, `property_type`
(flat | terraced | semi-detached | detached | bungalow) and
`floor_area_m2` whenever you have established them: the unit record's
bedrooms are imputed for most properties, and a wrong bedroom count
doubl | No | Yes | Yes | No |
Details
- Registry status
- Active
- Published
- Oct 29, 2026
- Updated
- Oct 29, 2026
- Website
- Not given
- Repository
- Not given
- Categories (suggested)
- Finance and paymentsSuggested categories are assigned automatically from the registry text and may be wrong. Verified operators can correct them.
- GDPR
- Not declared