Find areas
find_areasShortlist London neighbourhoods for a household: budget, bedrooms, weighted priorities (crime, station access, price level, official deprivation decile, noise, disorder, energy rating, leasehold share) and optional stations/boroughs to live near. Returns ranked areas with score, factor values, a ballpark price for the bedroom count and budget fit, postcode districts and website links. Pass rejected areas in exclude_area_ids when refining after the user's feedback (LSOA, MSOA or borough ids).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top_n | No | How many areas to return. | |
| custom | No | The user's own criteria from places on the map ('more cafés than kebab shops', 'near gyms'): a preset_id or a criterion, each scored by its percentile within the area's region (London for a London area). Describes places, never who lives there. | |
| market | No | Buying or renting. | buy |
| places | No | Where the household goes — work, a gym, a particular school, friends (pinned: latitude/longitude from search_places) or the nearest of a kind (category). Each becomes a criterion; must = hard limit. | |
| ranges | No | Any other map layer as a range with soft edges, e.g. gigabit broadband at 90% of homes or more: {layer: 'broadband-gigabit', scale: 'value', min: 90}. Bounds are percentiles within each area's region by default (London's areas among London's; min 90 = the region's top 10%); scale 'value' uses the layer's own unit. Only layers list_metrics shows. | |
| bedrooms | No | Bedrooms needed (0 = studio). | |
| boroughs | No | Live in these boroughs (uk:borough:E09…, from search_places). Stations + boroughs ≤ 3. | |
| max_budget | Yes | Maximum price in £ (buy) or £ per month (rent). | |
| priorities | No | What matters, with importance 1-5 (criteria are ranked by importance, then in the order given; the order sets the weights). Translate the user's words: 'safe' → crime, 'near the tube' → station-access, 'good value' → market-level, 'quiet' → noise, 'no rough streets / graffiti' → disorder, 'low energy bills' → epc-share, 'freehold' → leasehold-share. must = only areas in London's better half for it. | |
| budget_must | No | True = areas whose ballpark is over max_budget are out. | |
| near_stations | No | Live within walking distance of these stations (e.g. on the user's commute line). | |
| only_in_zones | No | With stations/boroughs given: True = only areas inside them (a must Where criterion); False = ranked first in the order, the fit falling with distance outside (zone_soft_metres). | |
| property_type | No | House or flat, for the price comparison on the brief page (sales of similar homes). | any |
| target_budget | No | Comfortable price; defaults to max less 8% (the site's own rule: £650k max → £600k). | |
| liked_area_ids | No | Areas the user liked: carried into the map link and highlighted there. | |
| exclude_area_ids | No | Areas the user already rejected — LSOA, MSOA or borough geography ids (boroughs and MSOAs expand to their LSOAs) — so they are not suggested again. | |
| zone_soft_metres | No | Outside the zones the fit falls to 0 over this distance (when only_in_zones is False). | |
| budget_importance | No | Where the budget sits in the order (5 = first). Fit 1 up to target_budget, falling to 0 at max_budget. | |
| include_over_budget | No | Keep areas whose typical home looks over budget. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||