Search land, units or buildings in a district or small area
sourcing_searchRead-onlyIdempotent
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 cemetery and railway land as its top six, while
13,047 residential parcels in the same borough never appeared. Pass
`include_undevelopable=True` to see them; they come back with no indicative
land value, because a residual on a heath is a meaningless number that
reads as an authoritative one.
BUILDINGS: asset="buildings" searches recorded footprints with footprint
area, storey count, unit count, dominant EPC and tenure. Supply one location,
bbox or drawn polygon. Results include matching footprints and stable
building IDs for linked-unit inspection. Page with offset, limit up to 100.
Unit/owner/strategy criteria are rejected for buildings.
INVENTORY PAGINATION: for land or units, supply offset=0, then next_offset
while has_more is true. These bounded pages apply every criterion before
pagination; derived-score/strategy criteria are not accepted in this mode.
Unit size uses min/max_floor_area_m2; land and buildings use min/max_area_m2.
Repeated warehouse reads are cached for five minutes. Results remain metered
by the gateway. No unknown tenure or EPC is asserted to meet a positive filter.
UK only. Costs 40 credits (40p).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | ||
| asset | No | land | |
| limit | No | ||
| cursor | No | STRATEGY MODE ONLY: `next_cursor` from the previous page. Inventory pages use `offset`. | |
| epc_in | No | ||
| offset | No | ||
| tenure | No | ||
| landuse | No | ||
| min_rlv | No | ||
| lad_code | No | STRATEGY MODE scope (GSS code, e.g. E09000032). Without a strategy, pass the code as `location` instead. | |
| location | No | ||
| max_beds | No | ||
| min_beds | No | ||
| strategy | No | A preset key from `sourcing_strategies`. Turns on strategy mode. | |
| max_units | No | ||
| min_score | No | ||
| min_units | No | ||
| max_floors | No | ||
| min_floors | No | ||
| max_area_m2 | No | ||
| min_area_m2 | No | ||
| owner_types | No | ||
| area_geojson | No | ||
| listing_state | No | STRATEGY MODE ONLY, units only: restrict to on- or off-market units. Rejected without `strategy`. For what is on the market now use `sourcing_live_listings`. | |
| require_owner | No | ||
| company_status | No | ||
| property_types | No | ||
| min_years_owned | No | ||
| max_floor_area_m2 | No | ||
| min_floor_area_m2 | No | ||
| postcode_district | No | STRATEGY MODE scope (e.g. SW11). Without a strategy, pass it as `location`. | |
| max_built_coverage | No | ||
| opportunities_only | No | ||
| strategy_overrides | No | STRATEGY MODE ONLY. Values for the preset's own filter keys. | |
| exclude_owner_types | No | ||
| max_unexpired_years | No | ||
| include_undevelopable | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||