GetBrandboardInput
Internal place ID. Provide either this or postcode, not both.
UK postcode, e.g. 'SW1A 1AA'. Provide either this or place_id, not both.
GetBrandboardOutput
Availability ratio of super fast broadband.
Availability ratio of ultra fast broadband.
Premises unable to achieve 2mbps speed.
Premises unable to achieve 5mbps speed.
Premises unable to achieve 10mbps speed.
Median download speeds.
Avg download speeds.
Min download speeds.
Max download speeds.
Avg download speeds.
Avg basic download speeds.
Avg SFBB download speeds.
Avg UFBB download speeds.
Median upload speeds.
Avg upload speeds.
Min upload speeds.
Max upload speeds.
Avg upload speeds.
Avg basic upload speeds.
Avg SFBB upload speeds.
Avg UFBB upload speeds.
Number of connections to 2mbps.
Number of connections to 5mbps.
Number of connections to 10mbps.
Number of connections to 30mbps.
Number of connections to over 30mbps.
Number of connections to 300mbps.
Average mb data usage per month.
Average mb line data usage per month.
Average mb basic data usage per month.
Average mb SFBB data usage per month.
Average mb data UFBB usage per month.
FTTP availability (1 = true, 0 = false).
GetNearbySchoolInput
UK postcode, e.g. 'SW1A 1AA'. Provide either this or lat/lng, not both.
Latitude of the location. Must be provided together with lng.
Longitude of the location. Must be provided together with lat.
GetNearbySchoolOutput
school_urnUnique reference number for the school.
latLatitude of the school location.
lngLongitude of the school location.
distance_mDistance in metres from the search location to the school.
Name of the school.
Phase of education, e.g. 'Primary', 'Secondary'.
Type of school, e.g. 'Voluntary controlled', 'Academy'.
Age range of pupils, e.g. '2-9', '11-18'.
Gender composition, e.g. 'Mixed', 'Boys', 'Girls'.
Whether the school has a nursery (1 = yes, 0 = no).
Religious character of the school, e.g. 'Church of England'.
Name of the headteacher.
Full address of the school.
Contact phone number for the school.
School website URL.
Local authority the school belongs to.
JSON summary of pupil demographics (gender, age range, totals).
JSON summary of average class sizes.
JSON summary of pupil numbers per year group.
JSON breakdown of pupil ethnicities as percentages.
Latest Ofsted inspection rating, e.g. 'Good', 'Outstanding'.
Date of the latest Ofsted inspection.
URL to the Ofsted inspection report.
JSON inspection scores for Welsh schools (Estyn).
JSON extracted strengths and weaknesses from inspection report.
Approximate catchment area description, e.g. '~ 7.49 Miles'.
Catchment radius in miles.
JSON admissions data including acceptance rates by year.
JSON Ofsted Parent View survey results.
JSON Key Stage 2 results data.
GetPlaceInput
Internal place ID. Provide either this or postcode, not both.
UK postcode, e.g. 'SW1A 1AA'. Provide either this or place_id, not both.
GetPlaceOutput
place_idInternal ID which can be used for other API endpoints. This ID is fixed and can be stored for future ref.
Full postcode.
Outcode is the first section of a Postcode such as 'SN6'. There are roughly 2500 in the UK which each cover around 20,000 addresses.
Town name.
OS ID for mapping purposes or using with third party OS datasets.
County the place is located.
The internal ID for the Town which the place is located in.
Easting of property.
Northing of property.
Positional quality indicator.
Geo country code.
Region code.
Local authority code.
Ward code.
Parlimentary constituency code.
European electoral code.
Primary care trust code.
Lower super output area code.
Middle super output area code.
Output area code for profiling population output type.
Postcode level longitude.
Postcode level latitude.
Level of accuracy (postcode).
Geo position.
Used for third party data look ups on Socrata.
Used for third party data look ups on the census database.
Outer postcode.
Average floor area of detached houses in this area.
Average floor area of flats in this area.
Average floor area of semi-detached houses in this area.
Average floor area of terrace houses in this area.
Average floor area of bungalows in this area.
GetPropertiesInput
Outward code (first part of postcode), e.g. 'SW1A'. Provide either this or postcode, not both.
Full UK postcode, e.g. 'SW1A 1AA'. Provide either this or first_postcode, not both.
Filter by UDPRN presence. 'y' = only addresses with UDPRN, 'n' = only addresses without UDPRN. Default null (no filter).
limitNumber of results per page. Default 100, max 100.
page0-based page index. Offset = page * limit. Default 0.
GetPropertiesOutput
property_idInternal id allocated to a property.
fabric_availableWhether EPC fabric data is available (1 = yes, 0 = no).
Number of bedrooms.
Number of reception rooms.
Number of bathrooms.
Property type, e.g. 'flat', 'detached', 'terraced'.
Total floor area of the property.
Number of habitable rooms from EPC data.
Built form of the property, e.g. 'flat', 'detached'.
Property tenure type.
Predicted room count (modelled).
Predicted total floor area (modelled).
Automated valuation model selling estimate.
Internal place ID linked to the property postcode.
Unique Property Reference Number.
Unique Delivery Point Reference Number.
Outward code (first part of postcode).
Full UK postcode.
Town name.
Dependent locality.
Double dependent locality.
Street/road name.
Dependent thoroughfare.
Building number.
Building name.
Sub-building name (e.g. flat number).
Address classification code.
PO Box number.
Department name within an organisation.
Organisation name at the address.
Postcode type indicator (S = small, L = large).
Small user organisation indicator.
Representative Point Code.
Local custodian code for the address.
Primary addressable object name.
Secondary addressable object name.
Country where the property is located.
GetAnalysisDataInput
first_postcode^(?i)([A-Z]{1,2}\d[A… · requiredUK postcode outward code (e.g. 'SW1A', 'B33'). 1-2 letters followed by 1 digit and optional letter/digit.
GetAnalysisDataOutput
The primary outward code of the UK postcode (e.g., SW1A) used for regional aggregation.
Mean count of bedrooms for residential properties within the specified sector.
Mean count of bathrooms for residential properties within the specified sector.
Mean count of reception rooms (lounges, dining rooms) within the specified sector.
Average Gross Internal Area (GIA) in square metres, measured per RICS professional standards.
Current Energy Performance Certificate (EPC) rating, ranging from A (high) to G (low).
Estimated annual cost (GBP) for property lighting based on current energy prices.
Estimated annual cost (GBP) for space heating based on current energy prices.
Estimated annual cost (GBP) for domestic hot water based on current energy prices.
Categorical age range of the property's original construction (e.g., '2007 onwards').
Mean fixed-line broadband download speed (Mbps) recorded within the sector.
Total count of Detached residential dwellings within the area.
Total count of Semi-Detached residential dwellings within the area.
Total count of Terraced residential dwellings within the area.
Total count of Flats or maisonettes within the area.
GetDistributionGraphDataInput
first_postcode^(?i)([A-Z]{1,2}\d[A… · requiredUK postcode outward code (e.g. 'SW1A', 'B33'). 1-2 letters followed by 1 digit and optional letter/digit.
GetDistributionGraphDataOutput
Dynamic price range labels (10 buckets) based on the min/max selling valuations in the area.
Property counts for each dynamic price range bucket.
Fixed price range labels in £100k increments from £0 to >£1M.
Property counts for each fixed price range bucket.
GetFabricInput
Property unique identifier. Provide either this or postcode, not both.
UK postcode, e.g. 'SW1A 1AA'. Provide either this or property_id, not both.
GetFabricOutput
Primary unique identifier for the EPC record.
Internal property code key; also known as property_id.
First line of address (combination of Soan + Poan + Throughfair).
Second line of address (e.g., village name).
Town.
The UK postcode associated with the property address.
Reference number of the building for mail.
Current EPC rating (A-G).
Potential EPC rating after recommended improvements.
Current Energy Efficiency numerical value.
Potential Energy Efficiency numerical value.
The date the EPC inspection took place.
Name of the local authority.
Constituency catchment area.
County where the address is located.
Date the EPC was registered/lodged.
Reason for EPC (e.g., Rental, New Build, Property Sale).
Current Environmental Impact Rating (CO2 emissions in tonnes/year).
Potential Environmental Impact Rating after improvements.
Current estimated annual energy consumption (kWh/m2).
Potential estimated annual energy consumption (kWh/m2).
CO2 emissions per year in tonnes/year.
CO2 emissions per m2 floor area per year in kg/m2.
Estimated potential total annual CO2 emissions (Tonnes/Year).
Current estimated annual energy costs for lighting (GBP).
Potential estimated annual energy costs for lighting (GBP).
Current estimated annual energy costs for heating (GBP).
Potential annual energy costs for heating (GBP).
Current estimated annual energy costs for hot water (GBP).
Potential estimated annual energy costs for hot water (GBP).
Total useful floor area (m2) measured internally.
Type of electricity tariff (e.g., single or dual).
Indicates if mains gas is available (Yes/No).
Floor level relative to lowest level (0 for ground floor).
Whether the flat is on the top storey (Yes/No).
The total number of storeys in the apartment block.
Type of main heating controls present.
Estimated percentage range of total glazed area that is multi-glazed.
Type of glazing (single, double, or triple).
Ranged estimate of total glazed area of the habitable area.
Raw count of extensions to the property.
Count of habitable rooms (excludes kitchens/bathrooms).
Count of rooms with active heating.
Percentage of fixed lights that are low-energy.
The number of active open fireplaces in the property.
Overall description of the hot water system.
Energy efficiency rating for hot water (1 to 5 stars).
Environmental efficiency rating for hot water (1 to 5 stars).
Overall description of the floor construction.
Energy efficiency rating for floors (1 to 5 stars).
Environmental efficiency rating for floors (1 to 5 stars).
Overall description of windows/glazing features.
Energy efficiency rating for windows (1 to 5 stars).
Environmental efficiency rating for windows (1 to 5 stars).
Description of wall construction (e.g., cavity, solid).
Energy efficiency rating for walls (1 to 5 stars).
Environmental efficiency rating for walls (1 to 5 stars).
Method used for secondary heating, if any.
Energy efficiency rating for secondary heating.
Environmental efficiency rating for secondary heating.
Description of roof and insulation status.
Energy efficiency rating for the roof.
Environmental efficiency rating for the roof.
Description of the primary source of heating.
Energy efficiency rating for main heating.
Environmental efficiency rating for main heating.
Description of main heating controls.
Energy efficiency rating for main heating controls.
Environmental efficiency rating for main heating controls.
Description of fixed lighting outlets.
Energy efficiency rating for lighting.
Environmental efficiency rating for lighting.
Primary fuel type for central heating (e.g., Gas).
Number of wind turbines present at the property.
Presence and type of heat loss corridor (flats only).
Length of sheltered wall in unheated corridor (m).
Average height of the storey in metres.
Size of photovoltaic installation (kW).
Indicates if hot water is solar powered.
Type of mechanical ventilation used in the property.
Concatenated address (Address 1 + 2 + 3).
Descriptive name of the local authority.
Descriptive name of the parliamentary constituency.
Estimated age of the property (Standardized).
Property extension count; returns 'Unknown' if null.
Standardized classification of the roof structure.
Presence and type of conservatory; returns 'Unknown' if null.
GetHpiInput
postcode^(?i)([A-Z]{1,2}\d[A… · requiredFull UK postcode, e.g. 'CF10 1AA'
statistic_regionGeographic level: 'Authority' (e.g. Cardiff) or 'Region' (e.g. Wales).
statistic_timeNumber of years of data to return (1-10). Default 3.
GetHpiOutput
levelGeographic level of the data: 'Authority' or 'Region'.
The year and month to which the monthly statistics apply.
Name of geography (Country, Regional, County/Unitary/District Authority and London Borough).
Code of geography (Country, Regional, County/Unitary/District Authority and London Borough).
Average house price for a geography in a particular period.
House price index for a geography in a particular period (January 2015=100).
Seasonally adjusted house price index (January 2015=100).
Percentage change in Average Price compared to previous month.
Percentage change in Average Price compared to same period twelve months earlier.
Seasonally adjusted Average Price for a geography in a particular period.
Number of registered transactions for a geography in a particular period.
Average house price for a Detached House.
House price index for Detached House (January 2015=100).
Percentage change in Detached Price compared to previous month.
Percentage change in Detached Price compared to same period twelve months earlier.
Average house price for a Semi-Detached House.
House price index for Semi-Detached House (January 2015=100).
Percentage change in Semi-Detached Price compared to previous month.
Percentage change in Semi-Detached Price compared to same period twelve months earlier.
Average house price for a Terraced House.
House price index for Terraced House (January 2015=100).
Percentage change in Terraced Price compared to previous month.
Percentage change in Terraced Price compared to same period twelve months earlier.
Average house price for a Flat/Maisonette.
House price index for Flat/Maisonette (January 2015=100).
Percentage change in Flat Price compared to previous month.
Percentage change in Flat Price compared to same period twelve months earlier.
Average house price by funding status 'CASH'.
House price index by funding status 'CASH' (January 2015=100).
Percentage change in Cash Price compared to previous month.
Percentage change in Cash Price compared to same period twelve months earlier.
Number of registered transactions 'CASH'.
Average house price by funding status 'MORTGAGE'.
House price index by funding status 'MORTGAGE' (January 2015=100).
Percentage change in Mortgage Price compared to previous month.
Percentage change in Mortgage Price compared to same period twelve months earlier.
Number of registered transactions 'MORTGAGE'.
Average house price by buyer status 'first time buyer'.
House price index by buyer status 'first time buyer' (January 2015=100).
Percentage change in FTB Price compared to previous month.
Percentage change in FTB Price compared to same period twelve months earlier.
Average house price by buyer status 'former owner occupier'.
House price index by buyer status 'former owner occupier' (January 2015=100).
Percentage change in FOO Price compared to previous month.
Percentage change in FOO Price compared to same period twelve months earlier.
Average house price by property status 'new build'.
House price index by property status 'new build' (January 2015=100).
Percentage change in New Price compared to previous month.
Percentage change in New Price compared to same period twelve months earlier.
Number of registered transactions 'New'.
Average house price by property status 'existing build'.
House price index by property status 'existing build' (January 2015=100).
Percentage change in Old Price compared to previous month.
Percentage change in Old Price compared to same period twelve months earlier.
Number of registered transactions 'Old'.
GetLeaseholdsInput
property_idProperty unique identifier
GetLeaseholdsOutput
property_idProperty ID.
uprnUnique Property Reference Number.
Register order number.
Description of the registered property.
Price paid for the lease.
Description of the associated property.
Date the lease was granted.
Date the lease expires.
Length of the lease term.
Lease term description.
GetListingsInput
Outward code (first part of postcode), e.g. 'SW1A'. Provide either this or postcode, not both.
Full UK postcode, e.g. 'SW1A 1AA'. Provide either this or first_postcode, not both.
typeListing type: 'all' (sales+rentals), 'sale' (sales only), 'rent' (rentals only).
progressEvent status filter. Valid values depend on 'type': type=all: all, reduction, for_sale, withdrawn, sstc_letAgree, sold_let. type=sale: all, reduction, for_sale, withdrawn, sstc, sold, all_sale. type=rent: all, reduction, for_sale, withdrawn, letAgree, let, all_let.
Filter on event (progress) date. Format: 'DDMMYYYY' for single date, 'DDMMYYYY-DDMMYYYY' for date range. E.g. '01012025' or '01012025-31012025'. This filters the event date based on the selected progress type (e.g. if progress=reduction, this filters the reduction date period).
Minimum event (progress) date filter (inclusive). Format: 'DDMMYYYY'. E.g. '01012025' → events on or after 2025-01-01. Takes priority over period.
Maximum event (progress) date filter (exclusive). Format: 'DDMMYYYY'. E.g. '31012025' → events before 2025-01-31. Takes priority over period.
Filter on original listed date (first event date for the listing). Format: 'DDMMYYYY' or 'DDMMYYYY-DDMMYYYY'.
Price filter. Single value: '250000'. Range: '250000-500000'.
Minimum price filter (inclusive). E.g. 250000. Takes priority over price.
Maximum price filter (exclusive). E.g. 500000. Takes priority over price.
matched0 = all listings (default), 1 = only listings linked to a known property.
featureFeature filter: 'all' (no filter), 'discount' (discounted properties), 'shared' (shared ownership), 'hmo' (HMO/student), 'retirement' (retirement properties).
limitNumber of results per page. Default 100, max 100.
page0-based page index. Offset = page * limit. Default 0.
GetListingsOutput
Internal ID allocated to a property.
Date the event took place.
Unique listing identifier.
Type of price request such as offers_in_excess_of, etc.
The asking price for sale or rent.
Is the property new-build or re-sale.
Description of the property's key features.
The organisation brand name responsible for the event (e.g. agency brand).
The organisation branch name responsible for the event.
The price the property was first listed for.
The price after a price reduction.
Date a property was last registered as sold on the official registrar.
Price a property was sold for on the official registrar.
The ID type of listing: 1 = Sale, 2 = Rent.
The deposit required as a rental bond.
Type of listing: Sale or Rent.
The type of building use such as house or flat.
The build type such as semi-detached, terrace, or detached.
Number of floor plans on the portal listing.
Number of images on the portal listing.
Number of videos on the portal listing.
Whether the listing is marketed as premium on property portals.
Number of bedrooms.
1 if listing is believed to be sold below potential market value (discount, refurbishment, or un-mortgageable).
1 if shared ownership (key worker / family income below £80k, government co-ownership).
1 if house of multiple occupancy (typically rented room-by-room, may require licence).
1 if retirement home (lease restricts occupants to over 55).
1 if identified as an auction listing (price may be below final achieved / market value).
1 if a probate property.
1 if chain free property.
1 if investment property.
1 if the house has a conservatory room.
URL of the listing house image.
Current status of the property (e.g. Reduced, Withdrawn, Sold).
Listing type name.
Number identifying the premise on a thoroughfare.
Name of residential or commercial premise.
Individual unit name (flat, apartment, business unit).
Royal Mail assigned town.
Unique Property Reference Number.
Street or road name. Uses address_street if property_id is NULL.
Property number.
Building number.
Building latitude.
Building longitude.
Royal Mail assigned postal code.
Date the listing was first published.
Number of residents at the property.
Number of email contacts for the property.
Number of mobile phone contacts for the property.
Number of landline phone contacts for the property.
GetMonthlyMarketAnalysisInput
first_postcode^(?i)([A-Z]{1,2}\d[A… · requiredUK postcode outward code (e.g. 'SW1A', 'B33'). 1-2 letters followed by 1 digit and optional letter/digit.
return_national^[yn]$Whether to include national statistics for comparison. 'y' or 'n'.
GetMonthlyMarketAnalysisOutput
The specific month/period of the analysis (e.g. 'January 2026').
The geographic area or postcode district (e.g. 'AB10').
Count of properties listed in this period (All property types).
Count of properties sold in this period (All property types).
The median listing price of properties (All property types).
The median sold price of properties (All property types).
Average days from listing to SSTC (All property types).
Count of properties listed (Detached).
Count of properties sold (Detached).
The median listing price (Detached).
The median sold price (Detached).
Average days from listing to SSTC (Detached).
Count of properties listed (Flat).
Count of properties sold (Flat).
The median listing price (Flat).
The median sold price (Flat).
Average days from listing to SSTC (Flat).
Count of properties listed (Semi-Detached).
Count of properties sold (Semi-Detached).
The median listing price (Semi-Detached).
The median sold price (Semi-Detached).
Average days from listing to SSTC (Semi-Detached).
Count of properties listed (Terraced).
Count of properties sold (Terraced).
The median listing price (Terraced).
The median sold price (Terraced).
Average days from listing to SSTC (Terraced).
Ratio of properties sold within 30 days (All types).
Ratio of properties sold within 30 days (Detached).
Ratio of properties sold within 30 days (Semi-Detached).
Ratio of properties sold within 30 days (Terraced).
Ratio of properties sold within 30 days (Flat).
Ratio of properties sold within 60 days (All types).
Ratio of properties sold within 60 days (Detached).
Ratio of properties sold within 60 days (Semi-Detached).
Ratio of properties sold within 60 days (Terraced).
Ratio of properties sold within 60 days (Flat).
Ratio of properties sold within 90 days (All types).
Ratio of properties sold within 90 days (Detached).
Ratio of properties sold within 90 days (Semi-Detached).
Ratio of properties sold within 90 days (Terraced).
Ratio of properties sold within 90 days (Flat).
GetPropertyHistoryInput
property_idInternal id allocated to a property.
GetPropertyHistoryOutput
property_idInternal id allocated to a property.
The asking price for sale or rent if there is a recorded event of a listing.
Date the event took place.
The current status of the property such as Reduced, Withdrawn, Sold if there is a recorded event of a listing.
The Brand Name of the agent associated with the event, e.g. 'LandRegistry'.
An internal ID allocated to a agent brand associated with an event, e.g. 'lr01'.
URL link to the property listing on the source portal (Rightmove or Zoopla).
The listing identifier from the source portal.
The portal source code, e.g. 'RMP' for Rightmove.
GetPropertyInput
Internal property ID. Provide exactly one of property_id, uprn, or udprn.
Unique Property Reference Number (OS). Provide exactly one of property_id, uprn, or udprn.
Unique Delivery Point Reference Number (Royal Mail). Provide exactly one of property_id, uprn, or udprn.
GetPropertyOutput
Internal ID allocated to a property.
Number of bedrooms in property.
Number of reception rooms in property.
Number of bathrooms in property.
Type of property (e.g., Detached, Flat).
Internal size in sqm (aliased from total_floor_area).
Building construction type (semi, detached, terrace).
Freehold or Leasehold tenure.
1 = Building fabric features are modelled; 0 = From valid source.
1 = Size is modelled based on similar properties; 0 = Size is measured/accurate.
Estimated current valuation based on available comparables.
Unique Property Reference Number (OS).
Unique Delivery Point Reference Number (Royal Mail).
Postcode outcode (e.g., SW1A).
Full Postal Code of the address.
Post Town of the address.
Locality used when thoroughfares are not unique within a town.
Secondary locality used to further distinguish address locations.
Street or road name.
Secondary street name.
Number of the premise on the street.
Name of the residential or commercial premise.
Specific unit name/number (e.g., Flat 1).
Property classification code (e.g., RD02).
PO Box number if applicable.
Specific department within an organisation.
Name of the organisation at this address.
L = Commercial, S = Residential.
Y = Commercial premises, N/Null = Not commercial.
Two-character code used to identify a unique delivery point.
Royal Mail Address status code.
Local authority identifier code.
Primary Addressable Object Name (Property Number).
Secondary Addressable Object Name (Building Number).
WGS84 Latitude coordinate of the property location.
WGS84 Longitude coordinate of the property location.
1 = EPC/Fabric data is available; 0 = Not available.
Standardized age band of the property (e.g., 1900-1929).
Current EPC Energy Efficiency Rating (A-G).
Full single-line formatted address string including postcode.
Country of address location (England, Wales, etc.).
Total land area of the plot measured in Square Feet.
Measures the density of properties in the surrounding area.
Human-readable description of the class code (e.g., Semi-Detached).
1 = Property is residential; 0 = Non-residential.
Indicates if the property is a known House in Multiple Occupation.
Predicted likelihood that the property is an HMO.
Remaining or original term length of a short lease.
The date on which the current short lease is set to expire.
Council Tax band (A-I).
Comma-separated list of HMLR Title Numbers linked to this UPRN.
GetQuarterlyMarketAnalysisInput
first_postcode^(?i)([A-Z]{1,2}\d[A… · requiredUK postcode outward code (e.g. 'SW1A', 'B33'). 1-2 letters followed by 1 digit and optional letter/digit.
return_national^[yn]$Whether to include national statistics for comparison. 'y' or 'n'.
GetQuarterlyMarketAnalysisOutput
The specific quarter/period of the analysis.
The geographic area or postcode district (e.g. 'AB10').
Count of properties listed in this period (All property types).
Count of properties sold in this period (All property types).
The median listing price of properties (All property types).
Percentage change in median listing price (All property types).
The median sold price of properties (All property types).
Average days from listing to Sold Subject to Contract (All property types).
Percentage change in average days to SSTC (All property types).
Count of properties listed (Detached).
Count of properties sold (Detached).
The median listing price (Detached).
Percentage change in median listing price (Detached).
The median sold price (Detached).
Average days from listing to SSTC (Detached).
Percentage change in average days to SSTC (Detached).
Count of properties listed (Flat).
Count of properties sold (Flat).
The median listing price (Flat).
Percentage change in median listing price (Flat).
The median sold price (Flat).
Average days from listing to SSTC (Flat).
Percentage change in average days to SSTC (Flat).
Count of properties listed (Semi-Detached).
Count of properties sold (Semi-Detached).
The median listing price (Semi-Detached).
Percentage change in median listing price (Semi-Detached).
The median sold price (Semi-Detached).
Average days from listing to SSTC (Semi-Detached).
Percentage change in average days to SSTC (Semi-Detached).
Count of properties listed (Terraced).
Count of properties sold (Terraced).
The median listing price (Terraced).
Percentage change in median listing price (Terraced).
The median sold price (Terraced).
Average days from listing to SSTC (Terraced).
Percentage change in average days to SSTC (Terraced).
Probability ratio that a property will receive a price reduction.
Ratio of properties with price reductions (All types).
Ratio of properties with price reductions (Detached).
Ratio of properties with price reductions (Semi-Detached).
Ratio of properties with price reductions (Terraced).
Ratio of properties with price reductions (Flats).
Total count of properties that reached legal Land Registry completion.
Average days from SSTC to legal completion (All property types).
Average days from SSTC to legal completion (Houses).
Average days from SSTC to legal completion (Flats).
Price reduction ratio based on final Land Registry sold price (All property types).
Price reduction ratio based on final Land Registry sold price (Flats).
Price reduction ratio based on final Land Registry sold price (Houses).
GetSoldPropertiesInput
Outward code (first part of postcode), e.g. 'SW1A'. Provide either this or postcode, not both.
Full UK postcode, e.g. 'SW1A 1AA'. Provide either this or first_postcode, not both.
limitMaximum number of results to return (max 100).
pagePage offset (0-based).
GetSoldPropertiesOutput
property_idInternal id allocated to a property.
Date the event took place.
Sold price of the listing.
ErrorOutput
errorHuman-readable error message
codeMachine-readable error code
GetComparableByPropertyIdInput
property_idPropalt inner property key.
Outward postcode only (e.g. 'SA11', 'NW3'). Case-insensitive. Overrides DB value if provided.
typeQuery type: 'selling' for sales comparables, 'letting' for rental comparables.
Number of bedrooms (1–20). Overrides DB value if provided.
Total floor area in square metres (10–600). Overrides DB value if provided.
Property type. Overrides DB value if provided.
Built form / sub-type. Overrides DB value if provided.
return_amountNumber of comparable properties to return (5–30).
current_statusStatus filter: 0=All, 1=For sale/rent, 2=Reduction, 3=Sold/Let, 4=Archive.
GetComparableByPropertyIdOutput
The subject property features used for the comparable search.
List of comparable properties matching the search criteria.
countNumber of comparable properties returned.
GetComparableInput
postcode^(?i)([A-Z]{1,2}\d[A… · requiredFull UK postcode, e.g. 'SA11 2LR', 'NW3 5HT'.
num_bedsNumber of bedrooms (1–20).
property_typeProperty type.
built_formBuilt form / sub-type of the property.
typeQuery type: 'selling' for sales comparables, 'letting' for rental comparables.
Total floor area in square metres (10–600). Optional.
return_amountNumber of comparable properties to return (5–30).
current_statusStatus filter: 0=All, 1=For sale/rent, 2=Reduction, 3=Sold/Let, 4=Archive.
GetComparableOutput
Address identifier in the property database.
Property type (e.g. house, flat, bungalow).
Built form (e.g. semi_detached, detached, terraced).
Number of bedrooms.
Full UK postcode of the comparable property.
Listing or sold price in GBP.
Distance from the query postcode in km.
Similarity score (0–100) indicating how closely the property matches the query.
Total floor area in square metres.
Plot size in square metres.
Price per square metre in GBP.
Price per bedroom in GBP.
Tenure type (e.g. Freehold, Leasehold).
Number of bathrooms.
Number of reception rooms.
Date the property was first listed.
Date the property was sold (portal data).
Date recorded in the Land Registry.
Price recorded in the Land Registry in GBP.
Ratio of land registry price to listing price.
Date of the most recent event for this property.
Days from first listing to sold date.
Current listing status (e.g. Sold, Archive_from_sold, For_sale).
Latitude coordinate.
Longitude coordinate.
Unique Property Reference Number.
Property address line.
Street name.
Estate agent brand name.
Estate agent branch name.
Property portal (Rightmove or Zoopla).
URL to the property listing on the portal.
Portal image URL(s), pipe-separated if multiple.
Primary property image URL.
Secondary property image URL.
Tertiary property image URL.
Floor plan image URL.
Listing ID with portal suffix (e.g. RS=Rightmove Sale, ZS=Zoopla Sale).
Hashed brand identifier with portal suffix.
Whether this is an auction property.
Whether this is a probate property.
Whether this is a discount/below-market property.
Whether this is an investment property.
Whether this is a House in Multiple Occupation.
Whether the property is owned by a company.
Owning company name, if applicable.
Companies House number, if applicable.
Cluster identifier for property grouping.
Construction age band (e.g. 'before 1900', '1950-1966').
Current EPC energy rating (A–G).
List of Land Registry title numbers.
GetValuationByPropertyIdInput
property_idPropalt inner property key.
Outward postcode only (e.g. 'SA11', 'NW3'). Case-insensitive. Overrides DB value if provided.
typeQuery type: 'selling' for sales valuation, 'letting' for rental valuation.
Number of bedrooms (1–20). Overrides DB value if provided.
Total floor area in square metres (10–600). Overrides DB value if provided.
Property type. Overrides DB value if provided.
Built form / sub-type. Overrides DB value if provided.
GetValuationByPropertyIdOutput
The subject property features used for the valuation.
Valuation prediction with confidence bands.
running_idUnique identifier for this valuation run.
SubjectPropertyFeature
property_idPropalt inner property key.
property_typeProperty type used for search.
built_formBuilt form used for search.
num_bedsNumber of bedrooms used for search.
postcodePostcode used for search.
query_typeQuery type: selling or letting.
Total floor area in square metres, if available.
ValuationResult
predict_pricePredicted property value in GBP.
predict_price_up_bandUpper confidence band of the predicted price in GBP.
predict_price_low_bandLower confidence band of the predicted price in GBP.
confidence_levelConfidence score for the valuation (1–10, higher is more confident).
price_per_bedroomPrice per bedroom in GBP.
target_property_latLatitude of the target property.
target_property_lngLongitude of the target property.
Price per square metre in GBP, if floor area is available.
GetEpcFabricOutput
Primary unique identifier for the EPC record.
Internal property code key; also known as property_id.
First line of address (combination of Soan + Poan + Throughfair).
Second line of address (e.g., village name).
Town.
The UK postcode associated with the property address.
Reference number of the building for mail.
Current EPC rating (A-G).
Potential EPC rating after recommended improvements.
Current Energy Efficiency numerical value.
Potential Energy Efficiency numerical value.
The date the EPC inspection took place.
Name of the local authority.
Constituency catchment area.
County where the address is located.
Date the EPC was registered/lodged.
Reason for EPC (e.g., Rental, New Build, Property Sale).
Current Environmental Impact Rating (CO2 emissions in tonnes/year).
Potential Environmental Impact Rating after improvements.
Current estimated annual energy consumption (kWh/m2).
Potential estimated annual energy consumption (kWh/m2).
CO2 emissions per year in tonnes/year.
CO2 emissions per m2 floor area per year in kg/m2.
Estimated potential total annual CO2 emissions (Tonnes/Year).
Current estimated annual energy costs for lighting (GBP).
Potential estimated annual energy costs for lighting (GBP).
Current estimated annual energy costs for heating (GBP).
Potential annual energy costs for heating (GBP).
Current estimated annual energy costs for hot water (GBP).
Potential estimated annual energy costs for hot water (GBP).
Total useful floor area (m2) measured internally.
Type of electricity tariff (e.g., single or dual).
Indicates if mains gas is available (Yes/No).
Floor level relative to lowest level (0 for ground floor).
Whether the flat is on the top storey (Yes/No).
The total number of storeys in the apartment block.
Type of main heating controls present.
Estimated percentage range of total glazed area that is multi-glazed.
Type of glazing (single, double, or triple).
Ranged estimate of total glazed area of the habitable area.
Raw count of extensions to the property.
Count of habitable rooms (excludes kitchens/bathrooms).
Count of rooms with active heating.
Percentage of fixed lights that are low-energy.
The number of active open fireplaces in the property.
Overall description of the hot water system.
Energy efficiency rating for hot water (1 to 5 stars).
Environmental efficiency rating for hot water (1 to 5 stars).
Overall description of the floor construction.
Energy efficiency rating for floors (1 to 5 stars).
Environmental efficiency rating for floors (1 to 5 stars).
Overall description of windows/glazing features.
Energy efficiency rating for windows (1 to 5 stars).
Environmental efficiency rating for windows (1 to 5 stars).
Description of wall construction (e.g., cavity, solid).
Energy efficiency rating for walls (1 to 5 stars).
Environmental efficiency rating for walls (1 to 5 stars).
Method used for secondary heating, if any.
Energy efficiency rating for secondary heating.
Environmental efficiency rating for secondary heating.
Description of roof and insulation status.
Energy efficiency rating for the roof.
Environmental efficiency rating for the roof.
Description of the primary source of heating.
Energy efficiency rating for main heating.
Environmental efficiency rating for main heating.
Description of main heating controls.
Energy efficiency rating for main heating controls.
Environmental efficiency rating for main heating controls.
Description of fixed lighting outlets.
Energy efficiency rating for lighting.
Environmental efficiency rating for lighting.
Primary fuel type for central heating (e.g., Gas).
Number of wind turbines present at the property.
Presence and type of heat loss corridor (flats only).
Length of sheltered wall in unheated corridor (m).
Average height of the storey in metres.
Size of photovoltaic installation (kW).
Indicates if hot water is solar powered.
Type of mechanical ventilation used in the property.
Concatenated address (Address 1 + 2 + 3).
Descriptive name of the local authority.
Descriptive name of the parliamentary constituency.
Estimated age of the property (Standardized).
Property extension count; returns 'Unknown' if null.
Standardized classification of the roof structure.
Presence and type of conservatory; returns 'Unknown' if null.
AddressLookupItem
typeResult type: "address", "postcode", "first_postcode", or "authority".
textFormatted display text. For addresses: title-cased with postcode uppercase. For postcodes: full postcode string. For first_postcode: outward code. For authority: local authority name.
Internal property ID. Present for address type only; may be null for unmatched listings.
Latitude of the property. Present for Typesense address results only.
Longitude of the property. Present for Typesense address results only.
AddressLookupOutput
statusAlways "OK" on success.
List of address, postcode, first_postcode, or authority results.
GetAgentOutput
Name of the estate agent branch.
Outward postcode of the agent branch.
Full address of the agent branch.
Number of properties currently listed for sale by this branch.
Number of properties currently listed for let by this branch.
Brand identifier for the agent group.