{"openapi":"3.1.0","info":{"title":"HomePortfolio Property Intelligence API","description":"379 fields per property. 28M+ UK properties. Investment scores, EPC, demographics, risk, planning, ownership and more — from one UPRN.","version":"1.0.0"},"paths":{"/v1/property/{uprn}/planning-signals":{"get":{"summary":"Property Planning Signals","description":"Stored planning signals for this property's cell. Evidence-backed counts.\nWhere no signal exists the answer says why and shows the applications that\ndo exist nearby (200, available=false).","operationId":"property_planning_signals_v1_property__uprn__planning_signals_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/sale-history":{"get":{"summary":"Property Sale History","description":"HMLR transactions attributed to THIS UPRN via the gazetteer (tiered,\nzero fuzzy), with as-at-sale floor area and £/sqft. Superset of the legacy\nsale-history section shape.","operationId":"property_sale_history_v1_property__uprn__sale_history_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/index/hpi":{"get":{"summary":"Repeat Sales Index","description":"First-party BMN repeat-sales index from HMLR pairs (never a listing portal's AVM).\nFalls back district → area → national; the served level is disclosed.","operationId":"repeat_sales_index_v1_index_hpi_get","parameters":[{"name":"geography","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Postcode district (SW1A), area (SW), or UK (default)","title":"Geography"},"description":"Postcode district (SW1A), area (SW), or UK (default)"},{"name":"outcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Alias of geography for a postcode district (NE15)","title":"Outcode"},"description":"Alias of geography for a postcode district (NE15)"},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A full postcode; its district is served","title":"Postcode"},"description":"A full postcode; its district is served"},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"YYYY-MM lower bound","title":"From"},"description":"YYYY-MM lower bound"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"YYYY-MM upper bound","title":"To"},"description":"YYYY-MM upper bound"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/area/{postcode}/sales":{"get":{"summary":"Postcode Attributed Sales","description":"Realised, UPRN-attributed sales for a unit postcode: the street-level\n£/sqft evidence base (per-postcode, the honest granularity we hold).","operationId":"postcode_attributed_sales_v1_area__postcode__sales_get","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string","title":"Postcode"}},{"name":"years","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"description":"Lookback window","default":10,"title":"Years"},"description":"Lookback window"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/school-cutoffs":{"get":{"summary":"Property School Cutoffs","description":"Last-admitted-distance history for nearby schools: 'would this address\nhave received an offer' per school per entry year.\n\nDiscipline (from the pipeline): a cutoff exists only when the school was\noversubscribed AND distance was the tiebreak (and, where the council's\noffer_state is held, it is cut_off); measures are never comparable across\ncouncils; an offer verdict is computed ONLY for a Reception or Year 7 row\nwhose council measure is straight-line (comparable to our geographic\ndistance). Year 9 (middle to high), junior and middle-school rows are\nlabelled and shown without a verdict. Coverage grows authority by\nauthority - absence means no covered school nearby.","operationId":"property_school_cutoffs_v1_property__uprn__school_cutoffs_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/comparables":{"get":{"summary":"Property Comparables","description":"Ranked comparable sales and the implied value RANGE for this property,\ntime-adjusted by the first-party repeat-sales index. Every comp carries\nits transaction id, gazetteer tier, and the index level used.","operationId":"property_comparables_v1_property__uprn__comparables_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/signals":{"get":{"summary":"Property Signal Stack","description":"The unified, factual signal stack for one property. Signals that cannot\nbe computed are absent — never zeroed, never modelled. Composite deal\nscoring deliberately waits on the comps backtest gate.","operationId":"property_signal_stack_v1_property__uprn__signals_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/opportunity":{"get":{"summary":"Property Opportunity","description":"Opportunity Score v2 - decomposed, freshness-gated, pricing claims at their measured edge.\n\nReturns the score with every component's points, value, evidence and\nexclusion reason. An ineligible property returns 200 with eligible=false\nand the reasons - a refusal is an answer, not an error.\n\nOnly live for-sale listings are scored; a property with no live listing\n404s (there is nothing to price against).","operationId":"property_opportunity_v1_property__uprn__opportunity_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/opportunity/book":{"get":{"summary":"Opportunity Book","description":"Top-scoring deals from the latest nightly book, score-descending.\n\nA WORK-LIST, not an analysis: identifiers and the score that ranked them.\nCallers fetch /v1/property/{uprn}/opportunity for the full decomposition,\nwhich keeps a single scoring path rather than a second, drifting one.\n\n`limit` is hard-capped at 5,000 - this feeds a batch, and an uncapped\nORDER BY over the whole book is a way to hurt the database by accident.\n`withheld_limit` / `withheld_offset` page the adverts the phantom gates\nwithheld (K12), with their reasons; unasked, the page is 50 on a\nwhole-book call and 500 on an outcode slice (up to 5,000 on request).","operationId":"opportunity_book_v1_opportunity_book_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":500,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"outcodes","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcodes"}},{"name":"withheld_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Withheld Limit"}},{"name":"withheld_offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Withheld Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/mission":{"post":{"summary":"Post Mission","operationId":"post_mission_v1_mission_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissionMandate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/education":{"get":{"summary":"Property Education","description":"Phase-grouped candidate schools for one property with straight-line,\nwalking and driving access facts and the latest inspection by era.\nAdmissions evidence is fact by category for the entry year (8.3); results\narrive with P2 and are marked so. Nothing here is a prediction or a\nguarantee of a place: `likelihood` is always null.","operationId":"property_education_v1_property__uprn__education_get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}},{"name":"phases","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"comma-separated subset of primary, secondary, independent, special, sixteen_plus","title":"Phases"},"description":"comma-separated subset of primary, secondary, independent, special, sixteen_plus"},{"name":"max_walk_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":240,"minimum":1},{"type":"null"}],"description":"keep candidates whose walking route is at most this many minutes","title":"Max Walk Min"},"description":"keep candidates whose walking route is at most this many minutes"},{"name":"entry_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":2015},{"type":"null"}],"description":"September intake the admissions evidence is for (default: the next intake whose offers are not yet published)","title":"Entry Year"},"description":"September intake the admissions evidence is for (default: the next intake whose offers are not yet published)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/search":{"get":{"summary":"Search Schools","description":"Schools near a place with filters, nearest first. Facts with their year and source; never a ranking.","operationId":"search_schools_v1_schools_search_get","parameters":[{"name":"near","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origin point: lat,lon (WGS84)","title":"Near"},"description":"Origin point: lat,lon (WGS84)"},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origin postcode (its ONS NSPL centroid)","title":"Postcode"},"description":"Origin postcode (its ONS NSPL centroid)"},{"name":"radius_m","in":"query","required":false,"schema":{"type":"integer","maximum":15000,"minimum":100,"description":"Straight-line radius","default":3000,"title":"Radius M"},"description":"Straight-line radius"},{"name":"phase","in":"query","required":false,"schema":{"anyOf":[{"enum":["primary","secondary","all_through","sixteen_plus","special"],"type":"string"},{"type":"null"}],"title":"Phase"}},{"name":"type","in":"query","required":false,"schema":{"enum":["state","independent","special","any"],"type":"string","default":"any","title":"Type"}},{"name":"religious_character","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"description":"Substring of GIAS's value, or none for no faith","title":"Religious Character"},"description":"Substring of GIAS's value, or none for no faith"},{"name":"gender","in":"query","required":false,"schema":{"anyOf":[{"enum":["mixed","boys","girls"],"type":"string"},{"type":"null"}],"title":"Gender"}},{"name":"selective","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selective"}},{"name":"inspection_era","in":"query","required":false,"schema":{"anyOf":[{"enum":["oeif","ungraded","report_card","sub_judgements","not_ofsted_inspected","none"],"type":"string"},{"type":"null"}],"title":"Inspection Era"}},{"name":"has_results","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A published KS2 or KS4 headline result is held","title":"Has Results"},"description":"A published KS2 or KS4 headline result is held"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Page Size"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Cursor"}},{"name":"count_only","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Count Only"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/compare":{"get":{"summary":"Compare Schools","description":"2-5 schools of one nation and one phase side by side on a fixed comparable measure set.","operationId":"compare_schools_v1_schools_compare_get","parameters":[{"name":"refs","in":"query","required":true,"schema":{"type":"string","maxLength":200,"description":"2 to 5 school refs, comma-separated: urn:N or N","title":"Refs"},"description":"2 to 5 school refs, comma-separated: urn:N or N"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}":{"get":{"summary":"Get School","description":"Canonical school profile (England, by URN).","operationId":"get_school_v1_schools__school_ref__get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/performance":{"get":{"summary":"Get School Performance","description":"Time series from school_measures with a status on every point.","operationId":"get_school_performance_v1_schools__school_ref__performance_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}},{"name":"measures","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated codes, or a prefix ending in '*'","title":"Measures"},"description":"Comma-separated codes, or a prefix ending in '*'"},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"First period, e.g. 2022/23","title":"From"},"description":"First period, e.g. 2022/23"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last period, e.g. 2025/26","title":"To"},"description":"Last period, e.g. 2025/26"},{"name":"breakdown","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated pupil groups (default all)","default":"all","title":"Breakdown"},"description":"Comma-separated pupil groups (default all)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sitemap/schools":{"get":{"summary":"Sitemap Schools","description":"Every school with a public profile page, ordered by URN, keyset-paged.","operationId":"sitemap_schools_v1_sitemap_schools_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from the previous page (urn:N); omit for the first","title":"Cursor"},"description":"next_cursor from the previous page (urn:N); omit for the first"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"schools per page","default":5000,"title":"Limit"},"description":"schools per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/admissions":{"get":{"summary":"School Admissions","description":"One school's admissions record: offers history, distance cut-offs and score cut-offs (separately), PAN by\nyear, and its published areas (simplified GeoJSON, indicative, each with the publisher's caveat). Historical\nfact only: no likelihood, probability or chance of a place.","operationId":"school_admissions_v1_schools__school_ref__admissions_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/inspections":{"get":{"summary":"School Inspections","operationId":"school_inspections_v1_schools__school_ref__inspections_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/related":{"get":{"summary":"Related Schools","description":"Same trust, same catchment and similar schools; never ranked by quality.","operationId":"related_schools_v1_schools__school_ref__related_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/distance":{"get":{"summary":"School Distance","description":"Straight-line and walking distance to the school, each labelled, with past cut-offs as history only.","operationId":"school_distance_v1_schools__school_ref__distance_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A full UK postcode (its ONS NSPL centroid) or lat,lon","title":"From"},"description":"A full UK postcode (its ONS NSPL centroid) or lat,lon"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schools/{school_ref}/term-dates.ics":{"get":{"summary":"Term Dates Calendar","description":"The term_dates block as an iCalendar file (all-day events, each with its source). 404 with the block's own\nreason when no dates are held.","operationId":"term_dates_calendar_v1_schools__school_ref__term_dates_ics_get","parameters":[{"name":"school_ref","in":"path","required":true,"schema":{"type":"string","title":"School Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ops/status":{"get":{"summary":"Ops Status","description":"Public pipeline status: overall, per-source breach booleans, data-vintage\ndates and the dated-failure countdowns. Redacted by construction.","operationId":"ops_status_v1_ops_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/v1/stats":{"get":{"summary":"Stats","description":"Database statistics.","operationId":"stats_v1_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}}}}},"/v1/property/{uprn}":{"get":{"summary":"Get Property","description":"Full property intelligence — 300+ fields from 14+ data sources.","operationId":"get_property_v1_property__uprn__get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/property/{uprn}/{section}":{"get":{"summary":"Get Property Section","description":"Get a specific section of property data.\n\nEvery section is the shaped block the full /v1/property response carries\nfor that domain, never a stored table row; `intelligence` is an\nallow-list of property-level fields, with withheld domains null beside a\nblock saying why.\n\nresponse_model=None (2026-08-13): the old Dict[str, Any] declaration made\nevery list-returning section (schools) a guaranteed 500 via\nResponseValidationError while the same data served fine in the full\nresponse.","operationId":"get_property_section_v1_property__uprn___section__get","parameters":[{"name":"uprn","in":"path","required":true,"schema":{"type":"string","title":"Uprn"}},{"name":"section","in":"path","required":true,"schema":{"type":"string","title":"Section"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search":{"get":{"summary":"Search","description":"Search for properties by address, postcode, or coordinates.\n\nAttribute filters (bedrooms / max_price / min_price) are applied IN SQL.\nThey used to be applied by the caller AFTER fetching a handful of rows,\nwhich meant a query like \"3 bed homes in manchester under 250k\" filtered a\n25-row sample of 530,970 matches — of which only 9 had a bedroom count at\nall — and so returned nothing despite thousands of genuine matches.","operationId":"search_v1_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address text search","title":"Q"},"description":"Address text search"},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Postcode lookup","title":"Postcode"},"description":"Postcode lookup"},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latitude for spatial search","title":"Lat"},"description":"Latitude for spatial search"},{"name":"lon","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Longitude for spatial search","title":"Lon"},"description":"Longitude for spatial search"},{"name":"radius","in":"query","required":false,"schema":{"type":"integer","description":"Search radius in meters","default":500,"title":"Radius"},"description":"Search radius in meters"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Max results","default":20,"title":"Limit"},"description":"Max results"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"bedrooms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Exact bedroom count","title":"Bedrooms"},"description":"Exact bedroom count"},{"name":"max_price","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max sale estimate (GBP)","title":"Max Price"},"description":"Max sale estimate (GBP)"},{"name":"min_price","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min sale estimate (GBP)","title":"Min Price"},"description":"Min sale estimate (GBP)"},{"name":"min_growth_12m_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min 12-month AVM growth %","title":"Min Growth 12M Pct"},"description":"Min 12-month AVM growth %"},{"name":"max_growth_12m_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max 12-month AVM growth %","title":"Max Growth 12M Pct"},"description":"Max 12-month AVM growth %"},{"name":"min_growth_60m_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min 60-month AVM growth %","title":"Min Growth 60M Pct"},"description":"Min 60-month AVM growth %"},{"name":"max_growth_60m_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max 60-month AVM growth %","title":"Max Growth 60M Pct"},"description":"Max 60-month AVM growth %"},{"name":"min_cagr_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min AVM CAGR %","title":"Min Cagr Pct"},"description":"Min AVM CAGR %"},{"name":"max_cagr_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max AVM CAGR %","title":"Max Cagr Pct"},"description":"Max AVM CAGR %"},{"name":"min_drawdown_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min drawdown from peak % (negative)","title":"Min Drawdown Pct"},"description":"Min drawdown from peak % (negative)"},{"name":"max_drawdown_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max drawdown from peak % (negative)","title":"Max Drawdown Pct"},"description":"Max drawdown from peak % (negative)"},{"name":"on_market_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only properties currently on the market (live listings)","default":false,"title":"On Market Only"},"description":"Only properties currently on the market (live listings)"},{"name":"min_discount_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Min % asking sits below the AVM estimate","title":"Min Discount Pct"},"description":"Min % asking sits below the AVM estimate"},{"name":"max_discount_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Max % asking sits below the AVM estimate","title":"Max Discount Pct"},"description":"Max % asking sits below the AVM estimate"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/autocomplete":{"get":{"summary":"Autocomplete","description":"Fast address autocomplete. Understands a house number, a street, and\na postcode or outcode at either end (\"35 Alnwick Street NE15\").","operationId":"autocomplete_v1_autocomplete_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"Address or postcode prefix","title":"Q"},"description":"Address or postcode prefix"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Max results","default":10,"title":"Limit"},"description":"Max results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/area/{postcode}":{"get":{"summary":"Get Area","description":"Area-level intelligence for a postcode (no specific property).","operationId":"get_area_v1_area__postcode__get","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string","title":"Postcode"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trends/{outcode}":{"get":{"summary":"Get Trends","description":"Monthly HMLR price trends for an outcode (mv_price_trends, refreshed after each monthly load).","operationId":"get_trends_v1_trends__outcode__get","parameters":[{"name":"outcode","in":"path","required":true,"schema":{"type":"string","title":"Outcode"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/district/{outcode}":{"get":{"summary":"Get District","description":"District-level intelligence aggregated from on-market listings + PI for an outcode.","operationId":"get_district_v1_district__outcode__get","parameters":[{"name":"outcode","in":"path","required":true,"schema":{"type":"string","title":"Outcode"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sitemap/properties":{"get":{"summary":"Sitemap Properties","description":"Return paginated UPRN + postcode list for sitemap generation. No auth required.","operationId":"sitemap_properties_v1_sitemap_properties_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number (1-indexed)","default":1,"title":"Page"},"description":"Page number (1-indexed)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":50000,"minimum":1000,"description":"UPRNs per page","default":50000,"title":"Per Page"},"description":"UPRNs per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/bulk":{"post":{"summary":"Bulk Lookup","description":"Batch lookup for multiple UPRNs. Pro plan and above only.","operationId":"bulk_lookup_v1_bulk_post","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Max UPRNs","default":100,"title":"Limit"},"description":"Max UPRNs"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/compare":{"get":{"summary":"Compare","description":"Side-by-side property comparison. Requires Starter plan or above.","operationId":"compare_v1_compare_get","parameters":[{"name":"uprns","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated UPRNs (max 5)","title":"Uprns"},"description":"Comma-separated UPRNs (max 5)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/status":{"get":{"summary":"Api Status","description":"System health and data freshness.","operationId":"api_status_v1_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status"},"checks":{"additionalProperties":true,"type":"object","title":"Checks"}},"type":"object","required":["status","checks"],"title":"HealthResponse"},"MissionMandate":{"properties":{"capital":{"type":"number","maximum":10000000.0,"minimum":5000.0,"title":"Capital"},"cities":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":10},{"type":"null"}],"title":"Cities"},"outcodes":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":30},{"type":"null"}],"title":"Outcodes"},"max_price":{"anyOf":[{"type":"number","maximum":2000000.0,"minimum":20000.0},{"type":"null"}],"title":"Max Price"},"min_price":{"anyOf":[{"type":"number","minimum":20000.0},{"type":"null"}],"title":"Min Price"},"min_yield_pct":{"anyOf":[{"type":"number","maximum":30.0,"minimum":0.0},{"type":"null"}],"title":"Min Yield Pct"},"risk":{"anyOf":[{"type":"string","pattern":"^(first_investor|experienced)$"},{"type":"null"}],"title":"Risk"},"top_n":{"anyOf":[{"type":"integer","maximum":25.0,"minimum":1.0},{"type":"null"}],"title":"Top N"},"uprns":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Uprns"}},"type":"object","required":["capital"],"title":"MissionMandate"},"PropertyResponse":{"properties":{"uprn":{"type":"string","title":"Uprn"},"address":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Address"},"coordinates":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Coordinates"},"property":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Property"},"valuation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Valuation"},"value_history":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Value History"},"sale_history":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Sale History"},"planning_signals":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Planning Signals"},"epc":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Epc"},"listing":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Listing"},"scores":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Scores"},"investment":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Investment"},"market":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Market"},"risk":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Risk"},"connectivity":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Connectivity"},"planning":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Planning"},"nearby_amenities":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Nearby Amenities"},"ownership":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Ownership"},"demographics":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Demographics"},"area_profile":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Area Profile"},"crime":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Crime"},"data_quality":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data Quality"}},"additionalProperties":true,"type":"object","required":["uprn"],"title":"PropertyResponse","description":"Full property intelligence response — 379 fields across 20 sections."},"SearchResponse":{"properties":{"results":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"count_is_lower_bound":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Count Is Lower Bound"},"filters_applied":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filters Applied"},"withheld_by_value_of_record":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Withheld By Value Of Record"},"value_of_record_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Of Record Rule"}},"type":"object","required":["results","count"],"title":"SearchResponse"},"StatsResponse":{"properties":{"total_records":{"type":"integer","title":"Total Records"},"total_tables":{"type":"integer","title":"Total Tables"},"tables":{"additionalProperties":{"type":"integer"},"type":"object","title":"Tables"}},"type":"object","required":["total_records","total_tables","tables"],"title":"StatsResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}