London neighbourhoods and homes: crime, schools, prices, rents, commute, green space, sourced.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Check one listing the user found against local evidence: asking price vs the neighbourhood's recorded £/m² (with floor area or a bedroom-based ballpark), turnover, growth, the borough's official HPI, costs (stamp duty on the asking price, the borough's council tax by band), crime with its offence mix, noise, schools (state and independent counts), planning rules (home: conservation, Article 4, listed buildings), listed buildings recorded at or near the postcode (listedNearby), the IMD decile, and the questions to ask the agent (lease, service charge, EWS1, listing). Not a valuation.
Full postcode of the listing, e.g. W5 2NU.
£ (buy) or the rent in its rent_period (rent).
For sale or to rent.
Tenure if the listing states it; lease questions are hedged ('If leasehold') when unknown and skipped for freehold.
Bedrooms in the listing.
Echoed back for citation only.
The rent's period: month = £ per calendar month, week = £ per week (converted ×52/12 for the comparison).
Property type if the listing states it; used for a same-type comparison.
Shared-ownership share for sale, e.g. 25: the asking price is compared as asking_price ÷ share against whole-home prices. Omit when the listing does not state it (the verdict stays unknown).
Floor area in m² if the listing states it.
Floor area in sq ft if the listing states it; converted server-side (1 sq ft = 0.092903 m²).
Check one listing the user found against local evidence: asking price vs the neighbourhood's recorded £/m² (with floor area or a bedroom-based ballpark), turnover, growth, the borough's official HPI, costs (stamp duty on the asking price, the borough's council tax by band), crime with its offence mix, noise, schools (state and independent counts), planning rules (home: conservation, Article 4, listed buildings), listed buildings recorded at or near the postcode (listedNearby), the IMD decile, and the questions to ask the agent (lease, service charge, EWS1, listing). Not a valuation.
| Argument | Type | Description |
|---|---|---|
| market | string | For sale or to rent. |
| tenure | string | Tenure if the listing states it; lease questions are hedged ('If leasehold') when unknown and skipped for freehold. |
| bedrooms | any | Bedrooms in the listing. |
| postcode* | string | Full postcode of the listing, e.g. W5 2NU. |
| listing_url | any | Echoed back for citation only. |
| rent_period | string | The rent's period: month = £ per calendar month, week = £ per week (converted ×52/12 for the comparison). |
| asking_price* | integer | £ (buy) or the rent in its rent_period (rent). |
| property_type | any | Property type if the listing states it; used for a same-type comparison. |
| share_percent | any | Shared-ownership share for sale, e.g. 25: the asking price is compared as asking_price ÷ share against whole-home prices. Omit when the listing does not state it (the verdict stays unknown). |
| floor_area_sqm | any | Floor area in m² if the listing states it. |
| floor_area_sqft | any | Floor area in sq ft if the listing states it; converted server-side (1 sq ft = 0.092903 m²). |
{
"type": "object",
"title": "assess_listingArguments",
"required": [
"postcode",
"asking_price"
],
"properties": {
"market": {
"enum": [
"buy",
"rent"
],
"type": "string",
"title": "Market",
"default": "buy",
"description": "For sale or to rent."
},
"tenure": {
"enum": [
"freehold",
"leasehold",
"share-of-freehold",
"shared-ownership",
"unknown"
],
"type": "string",
"title": "Tenure",
"default": "unknown",
"description": "Tenure if the listing states it; lease questions are hedged ('If leasehold') when unknown and skipped for freehold."
},
"bedrooms": {
"anyOf": [
{
"type": "integer",
"maximum": 8,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Bedrooms",
"default": null,
"description": "Bedrooms in the listing."
},
"postcode": {
"type": "string",
"title": "Postcode",
"pattern": "^\\s*[A-Za-z]{1,2}\\d[A-Za-z\\d]?\\s*\\d[A-Za-z]{2}\\s*$",
"description": "Full postcode of the listing, e.g. W5 2NU."
},
"listing_url": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Listing Url",
"default": null,
"description": "Echoed back for citation only."
},
"rent_period": {
"enum": [
"month",
"week"
],
"type": "string",
"title": "Rent Period",
"default": "month",
"description": "The rent's period: month = £ per calendar month, week = £ per week (converted ×52/12 for the comparison)."
},
"asking_price": {
"type": "integer",
"title": "Asking Price",
"description": "£ (buy) or the rent in its rent_period (rent).",
"exclusiveMinimum": 0
},
"property_type": {
"anyOf": [
{
"enum": [
"detached",
"semi-detached",
"terraced",
"flat"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Property Type",
"default": null,
"description": "Property type if the listing states it; used for a same-type comparison."
},
"share_percent": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Share Percent",
"default": null,
"description": "Shared-ownership share for sale, e.g. 25: the asking price is compared as asking_price ÷ share against whole-home prices. Omit when the listing does not state it (the verdict stays unknown)."
},
"floor_area_sqm": {
"anyOf": [
{
"type": "number",
"exclusiveMaximum": 2000,
"exclusiveMinimum": 5
},
{
"type": "null"
}
],
"title": "Floor Area Sqm",
"default": null,
"description": "Floor area in m² if the listing states it."
},
"floor_area_sqft": {
"anyOf": [
{
"type": "number",
"exclusiveMaximum": 22000,
"exclusiveMinimum": 50
},
{
"type": "null"
}
],
"title": "Floor Area Sqft",
"default": null,
"description": "Floor area in sq ft if the listing states it; converted server-side (1 sq ft = 0.092903 m²)."
}
}
}Turn a finished search into a watch: portal searches per postcode district, filters, a state file path for de-duplication and a ready prompt for a scheduled task in the user's Claude that reports only new listings. Stateless: nothing is stored on Close Knit.
| Argument | Type | Description |
|---|---|---|
| name* | string | Short name, e.g. 'Ealing 2-bed'. |
| market | string | |
| area_ids* | array | LSOA ids to watch. |
| frequency | string | |
| max_price* | integer | £ (buy) or £ per month (rent). |
| must_haves | string | Free-text requirements the agent checks per listing. |
| min_bedrooms | integer |
{
"type": "object",
"title": "build_watch_specArguments",
"required": [
"name",
"area_ids",
"max_price"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"maxLength": 60,
"minLength": 2,
"description": "Short name, e.g. 'Ealing 2-bed'."
},
"market": {
"enum": [
"buy",
"rent"
],
"type": "string",
"title": "Market",
"default": "buy"
},
"area_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Area Ids",
"maxItems": 10,
"minItems": 1,
"description": "LSOA ids to watch."
},
"frequency": {
"enum": [
"daily",
"weekly"
],
"type": "string",
"title": "Frequency",
"default": "daily"
},
"max_price": {
"type": "integer",
"title": "Max Price",
"description": "£ (buy) or £ per month (rent).",
"exclusiveMinimum": 0
},
"must_haves": {
"type": "string",
"title": "Must Haves",
"default": "",
"maxLength": 500,
"description": "Free-text requirements the agent checks per listing."
},
"min_bedrooms": {
"type": "integer",
"title": "Min Bedrooms",
"default": 0,
"maximum": 8,
"minimum": 0
}
}
}Evaluate a criterion from places on the map for every London neighbourhood ('where are more cafés than kebab shops', 'most gyms in the area'), counting the places inside each neighbourhood's boundary: a preset_id or the user's own criterion (sets of OSM tag matchers and a formula). Returns the best and worst areas with place counts and London percentiles, the legend and a map link that shows it as a layer. Places, never people: religion or who lives there is refused.
| Argument | Type | Description |
|---|---|---|
| top_n | integer | How many top and bottom areas to list. |
| area_ids | array | Also report these areas (LSOA ids from search_places). |
| criterion | any | Or the user's own criterion. |
| direction | any | Which end the user wants (for the top list and the map link). |
| preset_id | any | A ready-made criterion from list_custom_presets. |
{
"type": "object",
"$defs": {
"CustomSetInput": {
"type": "object",
"title": "CustomSetInput",
"required": [
"label",
"any"
],
"properties": {
"any": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"title": "Any",
"maxItems": 6,
"minItems": 1,
"description": "OR of matchers; a matcher ANDs OpenStreetMap tag tests over amenity, shop, leisure, tourism, sport, cuisine, healthcare, craft, office and brand: a value, a list of values, '*' (has the tag) or null (has no such tag). E.g. [{\"cuisine\": \"kebab\"}], [{\"amenity\": \"cafe\", \"brand\": null}] for independent cafés, [{\"cuisine\": \"specialty_coffee\"}] for coffee-led shops (specialty coffee, not a café with coffee on the menu; never a big chain), [{\"brand\": \"Greggs\"}]. religion/denomination are refused: places, not people."
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "What the places are, e.g. 'Kebab shops'."
}
},
"additionalProperties": false
},
"CustomCriterionInput": {
"type": "object",
"title": "CustomCriterionInput",
"required": [
"id",
"label",
"sets",
"formula"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"pattern": "^[a-z0-9-]{1,24}$",
"description": "Short id, e.g. 'kebab-cafe'."
},
"sets": {
"type": "object",
"title": "Sets",
"description": "Sets of places: a (required), b for balance/share, c optional for count/density.",
"propertyNames": {
"enum": [
"a",
"b",
"c"
]
},
"additionalProperties": {
"$ref": "#/$defs/CustomSetInput"
}
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "Name the user will see: descriptive, no brand or value words, e.g. 'Kebab shops vs cafés'."
},
"formula": {
"enum": [
"count",
"density",
"per_resident",
"balance",
"share",
"variety",
"nearest"
],
"type": "string",
"title": "Formula",
"description": "Prefer nearest for 'is one close' (straight-line walk minutes from the area's centre to the nearest A, up to 5 km) and per_resident for 'how much is around' (places in any set per 1,000 residents; the City of London is left out). The rest are counted inside each neighbourhood's boundary (the area shape on the map, not walking distance): count / density (per km² of the area) of places in any set; share A/(A+B); variety = distinct cuisines/sports among A; balance (A-B)/(A+B+5) from -1 (more B) to +1 (more A), advanced: few places keep an area near 0."
},
"radiusMetres": {
"type": "integer",
"title": "Radiusmetres",
"default": 800,
"maximum": 2000,
"minimum": 200,
"description": "Kept for compatibility with saved criteria and share links (200-2000 m); no formula uses it, so leave the default."
}
},
"additionalProperties": false
}
},
"title": "evaluate_custom_criterionArguments",
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 5,
"maximum": 5,
"minimum": 1,
"description": "How many top and bottom areas to list."
},
"area_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^uk:lsoa:E\\d{8}$"
},
"title": "Area Ids",
"maxItems": 10,
"description": "Also report these areas (LSOA ids from search_places)."
},
"criterion": {
"anyOf": [
{
"$ref": "#/$defs/CustomCriterionInput"
},
{
"type": "null"
}
],
"default": null,
"description": "Or the user's own criterion."
},
"direction": {
"anyOf": [
{
"enum": [
"higher",
"lower"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction",
"default": null,
"description": "Which end the user wants (for the top list and the map link)."
},
"preset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preset Id",
"default": null,
"description": "A ready-made criterion from list_custom_presets."
}
}
}Shortlist 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).
| Argument | Type | Description |
|---|---|---|
| top_n | integer | How many areas to return. |
| custom | array | 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 | string | Buying or renting. |
| places | array | 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 | array | 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. |
Neighbourhoods like one the user liked (crime, deprivation, income, price level and station access percentiles), optionally only cheaper ones: 'like this but cheaper / elsewhere'.
| Argument | Type | Description |
|---|---|---|
| top_n | integer | How many areas to return. |
| area_id* | string | A neighbourhood (LSOA) the user liked. |
| cheaper | boolean | Only areas with a lower £/m² price level. |
| bedrooms | any | Adds a ballpark price for this size. |
{
"type": "object",
"title": "find_similar_areasArguments",
"required": [
"area_id"
],
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 6,
"maximum": 10,
"minimum": 1,
"description": "How many areas to return."
},
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:lsoa:E\\d{8}$",
"description": "A neighbourhood (LSOA) the user liked."
},
"cheaper": {
"type": "boolean",
"title": "Cheaper",
"default": false,
"description": "Only areas with a lower £/m² price level."
},
"bedrooms": {
"anyOf": [
{
"type": "integer",
"maximum": 8,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Bedrooms",
"default": null,
"description": "Adds a ballpark price for this size."
}
}
}Recorded achieved sale prices for one address id (HM Land Registry Price Paid, GBP, with the EPC floor area where matched; no per-sale GBP/m2). These are historic transactions, never valuations or asking prices. listingLinks open the postcode on Rightmove (past listings and their photos), Zoopla and OnTheMarket: links only, Close Knit does not fetch or host listings.
| Argument | Type | Description |
|---|---|---|
| address_id* | string | Address id returned by search_areas (uk:addr:…). |
{
"type": "object",
"title": "get_address_historyArguments",
"required": [
"address_id"
],
"properties": {
"address_id": {
"type": "string",
"title": "Address Id",
"pattern": "^uk:addr:[0-9a-f]{12}$",
"description": "Address id returned by search_areas (uk:addr:…)."
}
}
}One cited evidence pack for an area: market depth (as get_market_depth), the latest recorded crime rate, road and rail noise shares, state schools within 1.5 km with their standing Ofsted grade, and, given an address_id inside the area, its building and street sale aggregates. Every block names its source release; not advice and not a valuation.
| Argument | Type | Description |
|---|---|---|
| area_id* | string | Geography id, e.g. uk:lsoa:E01000004. |
| address_id | any | Optional address id (uk:addr:…) inside the area: adds its building and street sale aggregates. |
{
"type": "object",
"title": "get_area_evidence_packArguments",
"required": [
"area_id"
],
"properties": {
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:(lsoa|msoa|borough):[A-Z]\\d{8}$",
"description": "Geography id, e.g. uk:lsoa:E01000004."
},
"address_id": {
"anyOf": [
{
"type": "string",
"pattern": "^uk:addr:[0-9a-f]{12}$"
},
{
"type": "null"
}
],
"title": "Address Id",
"default": null,
"description": "Optional address id (uk:addr:…) inside the area: adds its building and street sale aggregates."
}
}
}Evidence-backed value of one metric for one area in one month: value, regional (londonPercentile: within the area's region, London for a London area; rankScope names it) and England percentiles, quality, sample size, category breakdown where available, plus up to 12 prior months as evidence rows. Units follow the metric (per 1,000 residents, GBP/m2). Confidence is high only for observed (not modelled) values. Some metrics are published for a wider area (income per MSOA; rent change and mobile coverage per borough): on a smaller area they return the enclosing area's value with quality 'fallback' and carrierGeographyId naming where it came from. Period defaults to the metric's latest. The find_areas factors disorder, epc-share, leasehold-share and schools are read the same way for one neighbourhood (latest value, period ignored), to verify or explain a find_areas result.
| Argument | Type | Description |
|---|---|---|
| period | any | Month, YYYY-MM. Defaults to the metric's latest period (defaultPeriod in list_metrics). |
| area_id* | string | Geography id, e.g. uk:lsoa:E01000004. |
| metric_id* | string | Metric id from list_metrics, e.g. crime or price-per-square-metre. |
{
"type": "object",
"title": "get_area_metricArguments",
"required": [
"area_id",
"metric_id"
],
"properties": {
"period": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}$"
},
{
"type": "null"
}
],
"title": "Period",
"default": null,
"description": "Month, YYYY-MM. Defaults to the metric's latest period (defaultPeriod in list_metrics)."
},
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:(lsoa|msoa|borough):[A-Z]\\d{8}$",
"description": "Geography id, e.g. uk:lsoa:E01000004."
},
"metric_id": {
"type": "string",
"title": "Metric Id",
"description": "Metric id from list_metrics, e.g. crime or price-per-square-metre."
}
}
}One neighbourhood in detail for a decision: local market (sales, turnover, leasehold share, £/m² medians, growth), the borough's official UK HPI (hpi: average price by type, 1/5/10-year change vs London: quote this for how prices moved), £/m² price trend, crime with its offence mix (topTypes, a busy-centre note), road/rail noise, nearby state schools with their standing Ofsted grade plus independent schools (schools.independent), planning rules (home: conservation, Article 4, listed buildings, broadband), council tax bands and a typical bill (councilTax), the IMD decile (deprivation), a ballpark price for a bedroom count and website links.
| Argument | Type | Description |
|---|---|---|
| area_id* | string | Geography id, e.g. uk:lsoa:E01000951. |
| bedrooms | any | Adds a ballpark price for this size. |
{
"type": "object",
"title": "get_area_overviewArguments",
"required": [
"area_id"
],
"properties": {
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:(lsoa|msoa|borough):[A-Z]\\d{8}$",
"description": "Geography id, e.g. uk:lsoa:E01000951."
},
"bedrooms": {
"anyOf": [
{
"type": "integer",
"maximum": 8,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Bedrooms",
"default": null,
"description": "Adds a ballpark price for this size."
}
}
}Door-to-door minutes from one neighbourhood to the user's places on a weekday morning, by public transport (R5 on TfL timetables), bike (at the speed Santander Cycles riders reach; checked against TfL), car (typical morning traffic, no parking) and walking, each with a range. Places within 1.5 km of a commute hub (King's Cross, Bank, Canary Wharf, Oxford Circus…) are routed through it; others in Greater London get a straight-line estimate (estimate: true); places outside Greater London, and every place from a neighbourhood outside London (the routing is London only), get no minutes (reason 'outside-london', or 'outside-coverage' where Close Knit covers England). Journeys over 120 minutes are not timed (minutes null, capped: true).
| Argument | Type | Description |
|---|---|---|
| places* | array | Pinned places (latitude/longitude) to reach. |
| area_id* | string | The neighbourhood (LSOA) to travel from. |
{
"type": "object",
"$defs": {
"PlaceInput": {
"type": "object",
"title": "PlaceInput",
"required": [
"label"
],
"properties": {
"mode": {
"anyOf": [
{
"enum": [
"walk",
"cycle",
"transit",
"car"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Mode",
"default": null,
"description": "How they get there (default transit for a pin, walk for a kind). car = typical weekday-morning traffic, no parking or charges: say so."
},
"must": {
"type": "boolean",
"title": "Must",
"default": false,
"description": "True when an area beyond max_minutes is out of the question."
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand",
"default": null,
"description": "With a category: only this brand, e.g. 'M&S', 'Waitrose', 'Lidl' (supermarket) or 'PureGym' (gym)."
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "What the place is, e.g. 'Office', 'PureGym Angel', 'Any park'."
},
"sport": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Sport",
"default": null,
"description": "With sports_club: the sport, e.g. 'tennis', 'football'."
},
"school": {
"anyOf": [
{
"$ref": "#/$defs/SchoolPlaceInput"
},
{
"type": "null"
}
],
"default": null,
"description": "Instead of top_school: the nearest school matching a filter (phase, Ofsted, type, intake, faith, one results measure ≥ a threshold), optionally within N metres; max_minutes still sets the trip."
},
"category": {
"anyOf": [
{
"enum": [
"park",
"cafe",
"supermarket",
"convenience",
"gp",
"pharmacy",
"pub",
"restaurant",
"gym",
"pool",
"sports_club",
"step_free_station"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Category",
"default": null,
"description": "Instead of a point: the nearest place of this kind (pool = public pool; step_free_station = a station TfL lists with lift access, or any DLR station or tram stop)."
},
"latitude": {
"anyOf": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "null"
}
],
"title": "Latitude",
"default": null,
"description": "A pinned place: its latitude (from search_places). For an address, `center` is its area's centre unless `centerPrecision` is `uprn`; never pin an LSOA centroid as the home."
},
"longitude": {
"anyOf": [
{
"type": "number",
"maximum": 180,
"minimum": -180
},
{
"type": "null"
}
],
"title": "Longitude",
"default": null,
"description": "A pinned place: its longitude."
},
"importance": {
"type": "integer",
"title": "Importance",
"default": 3,
"maximum": 5,
"minimum": 1,
"description": "1 nice to have … 5 essential."
},
"top_school": {
"anyOf": [
{
"type": "integer",
"maximum": 200,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Top School",
"default": null,
"description": "Instead of a point or category: near one of London's top N state schools (by published results), e.g. 10. Living nearby never guarantees a place: say so."
},
"max_minutes": {
"type": "integer",
"title": "Max Minutes",
"default": 30,
"maximum": 120,
"minimum": 1,
"description": "The longest trip they accept."
},
"school_phase": {
"enum": [
"primary",
"secondary"
],
"type": "string",
"title": "School Phase",
"default": "secondary",
"description": "With top_school."
},
"school_rank_by": {
"enum": [
"results",
"progress8"
],
"type": "string",
"title": "School Rank By",
"default": "results",
"description": "With top_school: rank by published results (default) or by Progress 8 (secondary only: progress pupils make from their primary results, latest published year 2023/24)."
}
},
"additionalProperties": false
},
"SchoolPlaceInput": {
"type": "object",
"title": "SchoolPlaceInput",
"required": [
"filter"
],
"properties": {
"filter": {
"$ref": "#/$defs/SchoolFilterInput",
"description": "Which schools count (the same filter as the map's Schools filter)."
},
"within": {
"anyOf": [
{
"type": "integer",
"maximum": 10000,
"minimum": 100
},
{
"type": "null"
}
],
"title": "Within",
"default": null,
"description": "Metres: only a matching school this close counts (straight line); beyond it the area has none."
}
},
"additionalProperties": false
},
"SchoolFilterInput": {
"type": "object",
"title": "SchoolFilterInput",
"properties": {
"faith": {
"anyOf": [
{
"enum": [
"faith",
"none"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Faith",
"default": null,
"description": "Faith school or not (absent = any)."
},
"gender": {
"anyOf": [
{
"enum": [
"mixed",
"girls",
"boys"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Gender",
"default": null,
"description": "Intake (absent = any)."
},
"ofsted": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"outstanding",
"good",
"report-card",
"requires-improvement",
"inadequate",
"not-inspected"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Ofsted",
"default": null,
"description": "Ofsted standing kept, state schools only (absent = any)."
},
"phases": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"primary",
"secondary",
"all-through",
"private"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Phases",
"default": null,
"description": "Phases kept (absent = all)."
},
"measure": {
"anyOf": [
{
"$ref": "#/$defs/SchoolMeasureInput"
},
{
"type": "null"
}
],
"default": null,
"description": "One results measure and its threshold."
},
"a_level_only": {
"type": "boolean",
"title": "A Level Only",
"default": false,
"description": "Only sixth forms with a combined A-level rank."
},
"establishments": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"academy",
"free",
"community",
"voluntary",
"foundation"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Establishments",
"default": null,
"description": "Type of establishment (absent = any)."
}
},
"additionalProperties": false
},
"SchoolMeasureInput": {
"type": "object",
"title": "SchoolMeasureInput",
"required": [
"id",
"threshold"
],
"properties": {
"id": {
"enum": [
"englandTopPercent",
"progress8",
"attainment8",
"grade5EngMaths",
"ks2RwmExpected",
"fsm6Share"
],
"type": "string",
"title": "Id",
"description": "englandTopPercent = England top % (lower is better: at most the threshold); progress8, attainment8, grade5EngMaths (%), ks2RwmExpected (%) = at least the threshold; fsm6Share = free school meals % (at most). Latest published year per school; cohorts under 30 and suppressed cells have no value and never pass."
},
"threshold": {
"type": "number",
"title": "Threshold",
"description": "The threshold in the measure's own unit, e.g. 75 for KS2 RWM 75%."
}
},
"additionalProperties": false
}
},
"title": "get_commuteArguments",
"required": [
"area_id",
"places"
],
"properties": {
"places": {
"type": "array",
"items": {
"$ref": "#/$defs/PlaceInput"
},
"title": "Places",
"maxItems": 8,
"minItems": 1,
"description": "Pinned places (latitude/longitude) to reach."
},
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:lsoa:E\\d{8}$",
"description": "The neighbourhood (LSOA) to travel from."
}
}
}Flood bands for an area's land (rivers/sea, surface water) and, with a UPRN, that home's own bands. Bands show the likelihood for an area, not a specific property: send the user to the Environment Agency check for one address.
| Argument | Type | Description |
|---|---|---|
| uprn | any | A home's UPRN for its own bands; without it, only the area's land bands. |
| area_id* | string | Geography id, e.g. uk:lsoa:E01000951. |
{
"type": "object",
"title": "get_flood_riskArguments",
"required": [
"area_id"
],
"properties": {
"uprn": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]+$"
},
{
"type": "null"
}
],
"title": "Uprn",
"default": null,
"description": "A home's UPRN for its own bands; without it, only the area's land bands."
},
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:(lsoa|msoa|borough):[A-Z]\\d{8}$",
"description": "Geography id, e.g. uk:lsoa:E01000951."
}
}
}One London home's recorded sales (date, price, HM Land Registry link) and prices in its area today: the middle half (25th-75th percentile) of same-type standard sales since three years back, each adjusted to the latest month by the local price index, with sample size and the area used (LSOA, else MSOA, else borough), and the coarse band its last sale fell in that year (top 10%, top quarter, upper middle, lower middle, bottom quarter, bottom 10%) with today's prices of that band in the area. Accepts a UPRN, an address id (uk:addr:…) from search_places, or an address fragment. Area statistics only: never say what the home is worth; describe the area. When a fragment matches several homes the tool returns their candidates instead of picking one: ask which home, or pass its addressId. Homes without a linked UPRN are reached by address id or fragment and carry uprn null. `facts` holds the home's type and tenure (Land Registry) and, where shown, energy-certificate facts (rating, potential rating, certificate date, built form, age band, rooms, floor level); null fields are not shown for this home; `withheld` lists features held back. Below 5 sales of the type nothing is shown. Hidden homes are not found.
| Argument | Type | Description |
|---|---|---|
| property_ref* | string | UPRN (digits), an address id (uk:addr:…) as returned by search_places, or an address fragment, e.g. '100a Baker Street EN1'. |
{
"type": "object",
"title": "get_home_pricesArguments",
"required": [
"property_ref"
],
"properties": {
"property_ref": {
"type": "string",
"title": "Property Ref",
"minLength": 3,
"description": "UPRN (digits), an address id (uk:addr:…) as returned by search_places, or an address fragment, e.g. '100a Baker Street EN1'."
}
}
}Pre-filtered searches on Rightmove, Zoopla, OnTheMarket (and OpenRent for rentals) for the postcode districts of shortlisted areas. Links only: open them on the user's behalf to read listings; Close Knit itself never fetches or stores listings.
| Argument | Type | Description |
|---|---|---|
| market | string | Buying or renting. |
| area_ids* | array | LSOA ids from find_areas. |
| max_price* | integer | £ (buy) or £ per month (rent). |
| min_bedrooms | integer | Minimum bedrooms. |
| outcodes_per_area | integer | Postcode districts per area (busiest first). |
{
"type": "object",
"title": "get_listing_search_linksArguments",
"required": [
"area_ids",
"max_price"
],
"properties": {
"market": {
"enum": [
"buy",
"rent"
],
"type": "string",
"title": "Market",
"default": "buy",
"description": "Buying or renting."
},
"area_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Area Ids",
"maxItems": 10,
"minItems": 1,
"description": "LSOA ids from find_areas."
},
"max_price": {
"type": "integer",
"title": "Max Price",
"description": "£ (buy) or £ per month (rent).",
"exclusiveMinimum": 0
},
"min_bedrooms": {
"type": "integer",
"title": "Min Bedrooms",
"default": 0,
"maximum": 8,
"minimum": 0,
"description": "Minimum bedrooms."
},
"outcodes_per_area": {
"type": "integer",
"title": "Outcodes Per Area",
"default": 1,
"maximum": 3,
"minimum": 1,
"description": "Postcode districts per area (busiest first)."
}
}
}Local market depth of one LSOA or MSOA from HM Land Registry Price Paid (standard category A sales only): sales in the last 12 months, turnover (% of EPC-linked homes that sold), the leasehold share OF SALES (not of homes), new-build and resale median GBP/m2 over 36 months with the new-build premium (each median needs 10 sales, the premium both), and the LSOA's GBP/m2 growth. Aggregates only: never a valuation, a listing or addresses.
| Argument | Type | Description |
|---|---|---|
| area_id* | string | LSOA or MSOA geography id, e.g. uk:lsoa:E01000004 (boroughs are unavailable). |
{
"type": "object",
"title": "get_market_depthArguments",
"required": [
"area_id"
],
"properties": {
"area_id": {
"type": "string",
"title": "Area Id",
"pattern": "^uk:(lsoa|msoa|borough):[A-Z]\\d{8}$",
"description": "LSOA or MSOA geography id, e.g. uk:lsoa:E01000004 (boroughs are unavailable)."
}
}
}Counts and median GBP/m2 of other homes' recorded sales in the same building (postcode, house number or name, street) and on the same street (other buildings) as one address id, last 10 years. The median is withheld under 5 standard sales with an EPC floor area. Summary only: no sale rows and no addresses; homes with a privacy objection are left out.
| Argument | Type | Description |
|---|---|---|
| address_id* | string | Address id returned by search_areas (uk:addr:…). |
{
"type": "object",
"title": "get_nearby_sales_summaryArguments",
"required": [
"address_id"
],
"properties": {
"address_id": {
"type": "string",
"title": "Address Id",
"pattern": "^uk:addr:[0-9a-f]{12}$",
"description": "Address id returned by search_areas (uk:addr:…)."
}
}
}Median monthly rent by bedroom count for areas (the figure the site shows). Borough averages per LSOA; empty for a studio or before the rents are loaded.
| Argument | Type | Description |
|---|---|---|
| area_ids* | array | Geography ids, e.g. uk:lsoa:E01000951. |
| bedrooms* | integer | Bedroom count; the site shows rents per bedroom count. |
{
"type": "object",
"title": "get_rent_levelsArguments",
"required": [
"area_ids",
"bedrooms"
],
"properties": {
"area_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Area Ids",
"maxItems": 50,
"minItems": 1,
"description": "Geography ids, e.g. uk:lsoa:E01000951."
},
"bedrooms": {
"type": "integer",
"title": "Bedrooms",
"maximum": 8,
"minimum": 1,
"description": "Bedroom count; the site shows rents per bedroom count."
}
}
}Ready-made custom criteria built from places on OpenStreetMap, with neutral descriptive names: kebab shops vs cafés, specialty coffee vs kebab shops, sandwich chains vs bakery chains, independent vs chain cafés, the nearest gym or sports centre, bars, pubs and clubs (more or fewer, per 1,000 residents), cinemas, theatres, museums and galleries, universities, the nearest playground or nursery, variety of cuisines, bakeries vs betting shops, takeaways, coworking, bike parking, the nearest EV charging point, the nearest market, the nearest dog park, vet or pet shop. Each has an id for evaluate_custom_criterion and find_areas(custom=[…]), a mapUrl (the map coloured by it) and a one-line definition. Use the names as given: no brand names or value words ('good', 'cheap') in what you tell the user.
No arguments.
{
"type": "object",
"title": "list_custom_presetsArguments",
"properties": {}
}List every area metric the active release serves (id, unit, direction, available periods, legend, provenance, caveats), plus the My match factors (kind 'factor': disorder, epc-share, leasehold-share, schools) that get_area_metric and rank_areas_by_metric also read. Call first to learn valid metric_id/period values for the other area tools; compact=true returns only id, unit, direction and defaultPeriod. Sources carry licence and methodology links.
| Argument | Type | Description |
|---|---|---|
| compact | boolean | Only id, unit, direction and defaultPeriod per metric: a small reply when you just need valid metric_id/period values. |
{
"type": "object",
"title": "list_metricsArguments",
"properties": {
"compact": {
"type": "boolean",
"title": "Compact",
"default": false,
"description": "Only id, unit, direction and defaultPeriod per metric: a small reply when you just need valid metric_id/period values."
}
}
}Score 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.
| Argument | Type | Description |
|---|---|---|
| top_n | integer | 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* | object | 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). |
Open a search the user shared from the Close Knit site (a link with #profile=v1., v2. or v3.): their budget, priorities, places (gym, work, schools…), liked and ruled-out areas and private notes, re-ranked now with the same shortlist as find_areas. Use it when the user pastes such a link or says 'discuss my search'.
| Argument | Type | Description |
|---|---|---|
| link* | string | An Close Knit link the user shared (…#profile=v1.…, v2. or v3.), e.g. from 'Discuss with Claude' on the site. |
| top_n | integer | How many areas to return. |
{
"type": "object",
"title": "open_shared_searchArguments",
"required": [
"link"
],
"properties": {
"link": {
"type": "string",
"title": "Link",
"maxLength": 8000,
"minLength": 20,
"description": "An Close Knit link the user shared (…#profile=v1.…, v2. or v3.), e.g. from 'Discuss with Claude' on the site."
},
"top_n": {
"type": "integer",
"title": "Top N",
"default": 8,
"maximum": 20,
"minimum": 1,
"description": "How many areas to return."
}
}
}Rank every served area (or one region's, region='North West') by one metric for one month and return the top N with rank, value, unit and quality. Tied values share a rank (competition ranking); each row carries tiedCount, the number of areas sharing its value. Use it to answer 'which areas have the lowest crime / highest GBP/m2' or 'the least deprived' (deprivation is the official IMD decile, 10 = least deprived: order desc), 'the highest household income' (income, GBP a year) or 'the most social renting' (social-renting, % of households; neutral, never call it better or worse). Areas with suppressed values are excluded. Census layers (census-*, student-share) describe residents and are refused: never rank areas by who lives there. The find_areas factors disorder, epc-share, leasehold-share and schools rank too (latest value, period ignored).
| Argument | Type | Description |
|---|---|---|
| order | string | desc = highest value first. |
| top_n | integer | How many areas to return (1-50). |
| period* | string | Month, YYYY-MM. |
| region | any | Only areas of one English region: its code (E12000001-E12000009) or name, e.g. 'North West', 'London'. Omitted: every area Close Knit covers. |
| metric_id* | string | Metric id from list_metrics. |
Resolve free text (area name, ONS code, postcode, street) to geography ids (uk:lsoa|msoa|borough:…) and, where recorded sales exist, address ids (uk:addr:…). Use the returned ids with get_area_metric, rank_areas_by_metric, get_address_history.
| Argument | Type | Description |
|---|---|---|
| q* | string | Free text: area name, ONS code (E01…), postcode, or street. |
| limit | integer | Maximum results (1-25). |
{
"type": "object",
"title": "search_areasArguments",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"title": "Q",
"minLength": 2,
"description": "Free text: area name, ONS code (E01…), postcode, or street."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum results (1-25)."
}
}
}Resolve a place the user mentions (station, borough, neighbourhood, postcode, street) to ids. Station lookup forgives spelling (Kings Cross, St James Park, Elephant and Castle) and knows London codes and nicknames (KX, TCR, LST, E&C, ally pally). Returns stations (osm:…, with TfL modes, lines and zone; twin stations such as Hammersmith are listed apart) for find_areas.near_stations, boroughs (uk:borough:…) for find_areas.boroughs, areas and addresses for get_area_overview and assess_listing.
| Argument | Type | Description |
|---|---|---|
| q* | string | A station, borough, neighbourhood, postcode or street. |
| limit | integer | Results per kind. |
{
"type": "object",
"title": "search_placesArguments",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"title": "Q",
"minLength": 2,
"description": "A station, borough, neighbourhood, postcode or street."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 5,
"maximum": 10,
"minimum": 1,
"description": "Results per kind."
}
}
}Send feedback about Close Knit to the team: a bug, missing or wrong data, an idea, or what worked. Call it only after the user agrees: show them the message first. Describe the product and what happened, never the person: no names, contact details, addresses, family, budget or other personal circumstances.
| Argument | Type | Description |
|---|---|---|
| kind* | string | bug = a tool failed or misbehaved; missing-data / wrong-data = an answer lacked or got a fact wrong; idea = something to add; praise = what worked well. |
| tools | array | The Close Knit tools it is about, e.g. ['find_areas']. |
| client | any | The AI client, e.g. 'claude.ai'. |
| rating | any | How useful Close Knit was, 1-5, if the user said. |
| message* | string | What happened or what would help, in a few sentences: the product, never the person. No names, contact details, addresses, family or money circumstances. |
{
"type": "object",
"title": "send_feedbackArguments",
"required": [
"kind",
"message"
],
"properties": {
"kind": {
"enum": [
"bug",
"missing-data",
"wrong-data",
"idea",
"praise",
"other"
],
"type": "string",
"title": "Kind",
"description": "bug = a tool failed or misbehaved; missing-data / wrong-data = an answer lacked or got a fact wrong; idea = something to add; praise = what worked well."
},
"tools": {
"type": "array",
"items": {
"type": "string"
},
"title": "Tools",
"maxItems": 10,
"description": "The Close Knit tools it is about, e.g. ['find_areas']."
},
"client": {
"anyOf": [
{
"type": "string",
"maxLength": 60
},
{
"type": "null"
}
],
"title": "Client",
"default": null,
"description": "The AI client, e.g. 'claude.ai'."
},
"rating": {
"anyOf": [
{
"type": "integer",
"maximum": 5,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Rating",
"default": null,
"description": "How useful Close Knit was, 1-5, if the user said."
},
"message": {
"type": "string",
"title": "Message",
"maxLength": 2000,
"minLength": 10,
"description": "What happened or what would help, in a few sentences: the product, never the person. No names, contact details, addresses, family or money circumstances."
}
}
}| bedrooms | integer | Bedrooms needed (0 = studio). |
| boroughs | array | Live in these boroughs (uk:borough:E09…, from search_places). Stations + boroughs ≤ 3. |
| max_budget* | integer | Maximum price in £ (buy) or £ per month (rent). |
| priorities | array | 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 | boolean | True = areas whose ballpark is over max_budget are out. |
| near_stations | array | Live within walking distance of these stations (e.g. on the user's commute line). |
| only_in_zones | boolean | 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 | string | House or flat, for the price comparison on the brief page (sales of similar homes). |
| target_budget | any | Comfortable price; defaults to max less 8% (the site's own rule: £650k max → £600k). |
| liked_area_ids | array | Areas the user liked: carried into the map link and highlighted there. |
| exclude_area_ids | array | 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 | integer | Outside the zones the fit falls to 0 over this distance (when only_in_zones is False). |
| budget_importance | integer | Where the budget sits in the order (5 = first). Fit 1 up to target_budget, falling to 0 at max_budget. |
| include_over_budget | boolean | Keep areas whose typical home looks over budget. |
{
"type": "object",
"$defs": {
"PlaceInput": {
"type": "object",
"title": "PlaceInput",
"required": [
"label"
],
"properties": {
"mode": {
"anyOf": [
{
"enum": [
"walk",
"cycle",
"transit",
"car"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Mode",
"default": null,
"description": "How they get there (default transit for a pin, walk for a kind). car = typical weekday-morning traffic, no parking or charges: say so."
},
"must": {
"type": "boolean",
"title": "Must",
"default": false,
"description": "True when an area beyond max_minutes is out of the question."
},
"brand": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Brand",
"default": null,
"description": "With a category: only this brand, e.g. 'M&S', 'Waitrose', 'Lidl' (supermarket) or 'PureGym' (gym)."
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "What the place is, e.g. 'Office', 'PureGym Angel', 'Any park'."
},
"sport": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"title": "Sport",
"default": null,
"description": "With sports_club: the sport, e.g. 'tennis', 'football'."
},
"school": {
"anyOf": [
{
"$ref": "#/$defs/SchoolPlaceInput"
},
{
"type": "null"
}
],
"default": null,
"description": "Instead of top_school: the nearest school matching a filter (phase, Ofsted, type, intake, faith, one results measure ≥ a threshold), optionally within N metres; max_minutes still sets the trip."
},
"category": {
"anyOf": [
{
"enum": [
"park",
"cafe",
"supermarket",
"convenience",
"gp",
"pharmacy",
"pub",
"restaurant",
"gym",
"pool",
"sports_club",
"step_free_station"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Category",
"default": null,
"description": "Instead of a point: the nearest place of this kind (pool = public pool; step_free_station = a station TfL lists with lift access, or any DLR station or tram stop)."
},
"latitude": {
"anyOf": [
{
"type": "number",
"maximum": 90,
"minimum": -90
},
{
"type": "null"
}
],
"title": "Latitude",
"default": null,
"description": "A pinned place: its latitude (from search_places). For an address, `center` is its area's centre unless `centerPrecision` is `uprn`; never pin an LSOA centroid as the home."
},
"longitude": {
"anyOf": [
{
"type": "number",
"maximum": 180,
"minimum": -180
},
{
"type": "null"
}
],
"title": "Longitude",
"default": null,
"description": "A pinned place: its longitude."
},
"importance": {
"type": "integer",
"title": "Importance",
"default": 3,
"maximum": 5,
"minimum": 1,
"description": "1 nice to have … 5 essential."
},
"top_school": {
"anyOf": [
{
"type": "integer",
"maximum": 200,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Top School",
"default": null,
"description": "Instead of a point or category: near one of London's top N state schools (by published results), e.g. 10. Living nearby never guarantees a place: say so."
},
"max_minutes": {
"type": "integer",
"title": "Max Minutes",
"default": 30,
"maximum": 120,
"minimum": 1,
"description": "The longest trip they accept."
},
"school_phase": {
"enum": [
"primary",
"secondary"
],
"type": "string",
"title": "School Phase",
"default": "secondary",
"description": "With top_school."
},
"school_rank_by": {
"enum": [
"results",
"progress8"
],
"type": "string",
"title": "School Rank By",
"default": "results",
"description": "With top_school: rank by published results (default) or by Progress 8 (secondary only: progress pupils make from their primary results, latest published year 2023/24)."
}
},
"additionalProperties": false
},
"RangeInput": {
"type": "object",
"title": "RangeInput",
"required": [
"layer"
],
"properties": {
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Max",
"default": null,
"description": "Highest accepted value (or percentile)."
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Min",
"default": null,
"description": "Lowest accepted value (or percentile)."
},
"must": {
"type": "boolean",
"title": "Must",
"default": false,
"description": "True = a filter (no soft edge, no weight)."
},
"layer": {
"type": "string",
"title": "Layer",
"pattern": "^(custom:)?[a-z0-9][a-z0-9-]{0,59}$",
"description": "Any map layer from list_metrics (e.g. noise, crime, station-access, nature-score, price-per-square-metre, food-hygiene), or disorder, schools, epc-share, leasehold-share. Never a Census (census-*, student-share) layer."
},
"scale": {
"enum": [
"value",
"percentile"
],
"type": "string",
"title": "Scale",
"default": "percentile",
"description": "percentile = bounds are percentiles of the value within each area's region (London's areas among London's), 0 = lowest, 100 = highest (e.g. max 30 = the lowest 30% for noise); value = the layer's own unit."
},
"soft_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Soft Max",
"default": null,
"description": "Above max the fit falls to 0 at soft_max (≥ max)."
},
"soft_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Soft Min",
"default": null,
"description": "Below min the fit falls to 0 at soft_min (≤ min)."
},
"importance": {
"type": "integer",
"title": "Importance",
"default": 3,
"maximum": 5,
"minimum": 1,
"description": "1 nice to have … 5 essential: sets its place in the order."
}
},
"additionalProperties": false
},
"PriorityInput": {
"type": "object",
"title": "PriorityInput",
"required": [
"factor",
"importance"
],
"properties": {
"must": {
"type": "boolean",
"title": "Must",
"default": false,
"description": "True = a filter: only areas in the better half of London for it (no weight). False = ranked by importance: the better half fits fully, the next quarter of London partly, the rest not at all."
},
"factor": {
"enum": [
"crime",
"station-access",
"market-level",
"deprivation",
"noise",
"disorder",
"epc-share",
"leasehold-share"
],
"type": "string",
"title": "Factor",
"description": "crime = recorded crime rate; station-access = walk minutes to the nearest station; market-level = local £/m² price level; deprivation = official deprivation decile (IMD), 1 = most deprived; noise = share of homes at 55 dB+ from road, rail or aircraft; disorder = anti-social behaviour, criminal damage and public order per 1,000 residents; epc-share = share of homes rated EPC A-C (energy efficiency, running costs); leasehold-share = share of recent sales that were leasehold."
},
"direction": {
"anyOf": [
{
"enum": [
"higher",
"lower"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction",
"default": null,
"description": "Which end the household prefers. Default: lower crime, shorter walks, lower prices, a higher deprivation decile, less noise, less disorder, more homes rated A-C, fewer leasehold sales."
},
"importance": {
"type": "integer",
"title": "Importance",
"maximum": 5,
"minimum": 1,
"description": "1 = nice to have … 5 = essential."
}
},
"additionalProperties": false
},
"CustomSetInput": {
"type": "object",
"title": "CustomSetInput",
"required": [
"label",
"any"
],
"properties": {
"any": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"title": "Any",
"maxItems": 6,
"minItems": 1,
"description": "OR of matchers; a matcher ANDs OpenStreetMap tag tests over amenity, shop, leisure, tourism, sport, cuisine, healthcare, craft, office and brand: a value, a list of values, '*' (has the tag) or null (has no such tag). E.g. [{\"cuisine\": \"kebab\"}], [{\"amenity\": \"cafe\", \"brand\": null}] for independent cafés, [{\"cuisine\": \"specialty_coffee\"}] for coffee-led shops (specialty coffee, not a café with coffee on the menu; never a big chain), [{\"brand\": \"Greggs\"}]. religion/denomination are refused: places, not people."
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "What the places are, e.g. 'Kebab shops'."
}
},
"additionalProperties": false
},
"SchoolPlaceInput": {
"type": "object",
"title": "SchoolPlaceInput",
"required": [
"filter"
],
"properties": {
"filter": {
"$ref": "#/$defs/SchoolFilterInput",
"description": "Which schools count (the same filter as the map's Schools filter)."
},
"within": {
"anyOf": [
{
"type": "integer",
"maximum": 10000,
"minimum": 100
},
{
"type": "null"
}
],
"title": "Within",
"default": null,
"description": "Metres: only a matching school this close counts (straight line); beyond it the area has none."
}
},
"additionalProperties": false
},
"StationZoneInput": {
"type": "object",
"title": "StationZoneInput",
"required": [
"station_id"
],
"properties": {
"station_id": {
"type": "string",
"title": "Station Id",
"pattern": "^osm:[nwr]\\d{1,15}$",
"description": "Station id from search_places (osm:n…)."
},
"max_walk_minutes": {
"type": "integer",
"title": "Max Walk Minutes",
"default": 15,
"maximum": 30,
"minimum": 5,
"description": "Walking time to the station (5-30)."
}
},
"additionalProperties": false
},
"CustomChoiceInput": {
"type": "object",
"title": "CustomChoiceInput",
"properties": {
"criterion": {
"anyOf": [
{
"$ref": "#/$defs/CustomCriterionInput"
},
{
"type": "null"
}
],
"default": null,
"description": "Or the user's own criterion."
},
"direction": {
"anyOf": [
{
"enum": [
"higher",
"lower"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction",
"default": null,
"description": "higher = more of it (more A for balance/share, closer for nearest); lower = less. Default: the preset's."
},
"preset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preset Id",
"default": null,
"description": "A ready-made criterion from list_custom_presets, e.g. 'kebab-cafe'."
},
"importance": {
"type": "integer",
"title": "Importance",
"default": 3,
"maximum": 5,
"minimum": 1,
"description": "1 nice to have … 5 essential."
}
},
"additionalProperties": false
},
"SchoolFilterInput": {
"type": "object",
"title": "SchoolFilterInput",
"properties": {
"faith": {
"anyOf": [
{
"enum": [
"faith",
"none"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Faith",
"default": null,
"description": "Faith school or not (absent = any)."
},
"gender": {
"anyOf": [
{
"enum": [
"mixed",
"girls",
"boys"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Gender",
"default": null,
"description": "Intake (absent = any)."
},
"ofsted": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"outstanding",
"good",
"report-card",
"requires-improvement",
"inadequate",
"not-inspected"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Ofsted",
"default": null,
"description": "Ofsted standing kept, state schools only (absent = any)."
},
"phases": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"primary",
"secondary",
"all-through",
"private"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Phases",
"default": null,
"description": "Phases kept (absent = all)."
},
"measure": {
"anyOf": [
{
"$ref": "#/$defs/SchoolMeasureInput"
},
{
"type": "null"
}
],
"default": null,
"description": "One results measure and its threshold."
},
"a_level_only": {
"type": "boolean",
"title": "A Level Only",
"default": false,
"description": "Only sixth forms with a combined A-level rank."
},
"establishments": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"academy",
"free",
"community",
"voluntary",
"foundation"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Establishments",
"default": null,
"description": "Type of establishment (absent = any)."
}
},
"additionalProperties": false
},
"SchoolMeasureInput": {
"type": "object",
"title": "SchoolMeasureInput",
"required": [
"id",
"threshold"
],
"properties": {
"id": {
"enum": [
"englandTopPercent",
"progress8",
"attainment8",
"grade5EngMaths",
"ks2RwmExpected",
"fsm6Share"
],
"type": "string",
"title": "Id",
"description": "englandTopPercent = England top % (lower is better: at most the threshold); progress8, attainment8, grade5EngMaths (%), ks2RwmExpected (%) = at least the threshold; fsm6Share = free school meals % (at most). Latest published year per school; cohorts under 30 and suppressed cells have no value and never pass."
},
"threshold": {
"type": "number",
"title": "Threshold",
"description": "The threshold in the measure's own unit, e.g. 75 for KS2 RWM 75%."
}
},
"additionalProperties": false
},
"CustomCriterionInput": {
"type": "object",
"title": "CustomCriterionInput",
"required": [
"id",
"label",
"sets",
"formula"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"pattern": "^[a-z0-9-]{1,24}$",
"description": "Short id, e.g. 'kebab-cafe'."
},
"sets": {
"type": "object",
"title": "Sets",
"description": "Sets of places: a (required), b for balance/share, c optional for count/density.",
"propertyNames": {
"enum": [
"a",
"b",
"c"
]
},
"additionalProperties": {
"$ref": "#/$defs/CustomSetInput"
}
},
"label": {
"type": "string",
"title": "Label",
"maxLength": 60,
"minLength": 1,
"description": "Name the user will see: descriptive, no brand or value words, e.g. 'Kebab shops vs cafés'."
},
"formula": {
"enum": [
"count",
"density",
"per_resident",
"balance",
"share",
"variety",
"nearest"
],
"type": "string",
"title": "Formula",
"description": "Prefer nearest for 'is one close' (straight-line walk minutes from the area's centre to the nearest A, up to 5 km) and per_resident for 'how much is around' (places in any set per 1,000 residents; the City of London is left out). The rest are counted inside each neighbourhood's boundary (the area shape on the map, not walking distance): count / density (per km² of the area) of places in any set; share A/(A+B); variety = distinct cuisines/sports among A; balance (A-B)/(A+B+5) from -1 (more B) to +1 (more A), advanced: few places keep an area near 0."
},
"radiusMetres": {
"type": "integer",
"title": "Radiusmetres",
"default": 800,
"maximum": 2000,
"minimum": 200,
"description": "Kept for compatibility with saved criteria and share links (200-2000 m); no formula uses it, so leave the default."
}
},
"additionalProperties": false
}
},
"title": "find_areasArguments",
"required": [
"max_budget"
],
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 8,
"maximum": 20,
"minimum": 1,
"description": "How many areas to return."
},
"custom": {
"type": "array",
"items": {
"$ref": "#/$defs/CustomChoiceInput"
},
"title": "Custom",
"maxItems": 4,
"description": "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": {
"enum": [
"buy",
"rent"
],
"type": "string",
"title": "Market",
"default": "buy",
"description": "Buying or renting."
},
"places": {
"type": "array",
"items": {
"$ref": "#/$defs/PlaceInput"
},
"title": "Places",
"maxItems": 8,
"description": "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": {
"type": "array",
"items": {
"$ref": "#/$defs/RangeInput"
},
"title": "Ranges",
"maxItems": 8,
"description": "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": {
"type": "integer",
"title": "Bedrooms",
"default": 2,
"maximum": 8,
"minimum": 0,
"description": "Bedrooms needed (0 = studio)."
},
"boroughs": {
"type": "array",
"items": {
"type": "string"
},
"title": "Boroughs",
"maxItems": 3,
"description": "Live in these boroughs (uk:borough:E09…, from search_places). Stations + boroughs ≤ 3."
},
"max_budget": {
"type": "integer",
"title": "Max Budget",
"description": "Maximum price in £ (buy) or £ per month (rent).",
"exclusiveMinimum": 0
},
"priorities": {
"type": "array",
"items": {
"$ref": "#/$defs/PriorityInput"
},
"title": "Priorities",
"maxItems": 8,
"description": "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": {
"type": "boolean",
"title": "Budget Must",
"default": false,
"description": "True = areas whose ballpark is over max_budget are out."
},
"near_stations": {
"type": "array",
"items": {
"$ref": "#/$defs/StationZoneInput"
},
"title": "Near Stations",
"maxItems": 3,
"description": "Live within walking distance of these stations (e.g. on the user's commute line)."
},
"only_in_zones": {
"type": "boolean",
"title": "Only In Zones",
"default": true,
"description": "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": {
"enum": [
"house",
"flat",
"any"
],
"type": "string",
"title": "Property Type",
"default": "any",
"description": "House or flat, for the price comparison on the brief page (sales of similar homes)."
},
"target_budget": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Target Budget",
"default": null,
"description": "Comfortable price; defaults to max less 8% (the site's own rule: £650k max → £600k)."
},
"liked_area_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Liked Area Ids",
"maxItems": 50,
"description": "Areas the user liked: carried into the map link and highlighted there."
},
"exclude_area_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Exclude Area Ids",
"maxItems": 100,
"description": "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": {
"type": "integer",
"title": "Zone Soft Metres",
"default": 1000,
"maximum": 5000,
"minimum": 100,
"description": "Outside the zones the fit falls to 0 over this distance (when only_in_zones is False)."
},
"budget_importance": {
"type": "integer",
"title": "Budget Importance",
"default": 5,
"maximum": 5,
"minimum": 1,
"description": "Where the budget sits in the order (5 = first). Fit 1 up to target_budget, falling to 0 at max_budget."
},
"include_over_budget": {
"type": "boolean",
"title": "Include Over Budget",
"default": false,
"description": "Keep areas whose typical home looks over budget."
}
}
}{
"type": "object",
"title": "match_areasArguments",
"required": [
"profile"
],
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "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": {
"type": "object",
"title": "Profile",
"description": "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).",
"additionalProperties": true
}
}
}{
"type": "object",
"title": "rank_areas_by_metricArguments",
"required": [
"metric_id",
"period"
],
"properties": {
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"title": "Order",
"default": "desc",
"description": "desc = highest value first."
},
"top_n": {
"type": "integer",
"title": "Top N",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "How many areas to return (1-50)."
},
"period": {
"type": "string",
"title": "Period",
"pattern": "^\\d{4}-\\d{2}$",
"description": "Month, YYYY-MM."
},
"region": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
],
"title": "Region",
"default": null,
"description": "Only areas of one English region: its code (E12000001-E12000009) or name, e.g. 'North West', 'London'. Omitted: every area Close Knit covers."
},
"metric_id": {
"type": "string",
"title": "Metric Id",
"description": "Metric id from list_metrics."
}
}
}