Match areas
match_areasScore every area against a household's ordered criteria (preference-profile.v2: budget, ranges on any map layer, places, where zones, own criteria; must = filter). Returns a match-pack.v2 with the best top_n (default 20, max 100) areas as a list with score, rank and percentile per area, its top 2 reasons and 2 weakest criteria, the bottom 10, and per-criterion components (value, fit, in/edge/out) as evidence for the listed areas only. Whole-coverage counts (scored, unscored, excluded, and excludedBy per unmet must) cover every area; mapUrl opens the full map for the search. Set analyticsConsent true only if the user agreed to store an anonymised profile summary; the tool works identically with false.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top_n | No | How many of the best-scored areas to list (1-100). values is that top-N list, not the whole map; scored, unscored, excluded and excludedBy count every area Close Knit covers. For the whole map use mapUrl. | |
| profile | Yes | preference-profile.v2 (preferred): {schemaVersion: 'preference-profile.v2', market buy|rent, targetBudget, maximumBudget, bedrooms, criteria: [...]} where criteria is ORDERED, most important first, each one of {kind: budget, must} (fit 1 at or under targetBudget, 0 at maximumBudget; must = within maximumBudget) | {kind: range, layer (a map layer id from list_metrics, e.g. crime, noise, air-no2, station-access, price-per-square-metre, or disorder, schools, epc-share, leasehold-share), scale value|percentile (percentile = percentile 0-100 of the value within the area's region, London's areas among London's, lowest first), min, max, softMin, softMax, must} | {kind: place, id, label, target, mode, targetMinutes, softMinutes, must} | {kind: where, zones (1-3: {kind: station, stationId, maxWalkMinutes 5-30} | {kind: borough, id} | {kind: lsoas, ids <= 50} | {kind: polygon, points}), softMetres (default 1000), must} | {kind: custom, criterion, direction, must}. A must criterion is a filter with no weight; the others weigh by their place in the list. preference-profile.v1 (factors with weights 0-5) is still accepted and migrated (weight order, Must kept). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||