Raw schema
{
"type": "object",
"properties": {
"max_median_house_price_gbp": {
"description": "Only districts whose median sold price of existing houses (12 months) is at or under this.",
"type": "integer",
"minimum": 50000,
"maximum": 20000000
},
"hub": {
"description": "Work hub for the commute criterion or sort. canary-wharf (Canary Wharf), city-of-london (Bank / Liverpool Street / Moorgate), kings-cross (King's Cross), westminster (Westminster), oxford-circus (Oxford Circus), london-bridge (London Bridge), paddington (Paddington), stratford (Stratford), hammersmith (Hammersmith), victoria (Victoria), waterloo (Waterloo), farringdon (Farringdon).",
"type": "string",
"enum": [
"canary-wharf",
"city-of-london",
"kings-cross",
"westminster",
"oxford-circus",
"london-bridge",
"paddington",
"stratford",
"hammersmith",
"victoria",
"waterloo",
"farringdon"
]
},
"max_commute_minutes": {
"description": "Only districts whose typical door-to-door minutes to hub are at or under this (needs hub).",
"type": "integer",
"minimum": 5,
"maximum": 120
},
"crime_at_or_below_london_rate": {
"description": "Only districts whose residential crime per 1,000 residents is at or below London as a whole.",
"type": "boolean"
},
"max_crimes_per_1000_residents": {
"description": "Only districts at or under this many residential-relevant crimes per 1,000 residents a year.",
"type": "number",
"minimum": 1,
"maximum": 1000
},
"min_outstanding_schools": {
"description": "Only districts with at least this many state schools currently graded Outstanding by Ofsted.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"max_flood_zone_3_pct": {
"description": "Only districts with at most this % of postcodes in Environment Agency Flood Zone 3.",
"type": "number",
"minimum": 0,
"maximum": 100
},
"max_official_rent_gbp_pcm": {
"description": "Only districts whose borough(s) have an ONS official average monthly rent at or under this (see bedrooms).",
"type": "integer",
"minimum": 100,
"maximum": 20000
},
"bedrooms": {
"description": "Bedrooms for the rent criterion: all (default), 1, 2, 3 or 4+.",
"type": "string",
"enum": [
"1",
"2",
"3",
"all",
"4+"
]
},
"borough": {
"description": "Only districts with postcodes in this London borough, e.g. \"Lewisham\".",
"type": "string",
"maxLength": 40
},
"sort_by": {
"description": "Order of the matches (lowest first, Outstanding schools most first). Default: the first criterion given.",
"type": "string",
"enum": [
"median_house_price",
"crime_rate",
"commute_minutes",
"outstanding_schools",
"flood_zone_3_share",
"official_rent"
]
},
"limit": {
"description": "Districts to return (default 20, max 50).",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}