Get Comparable Properties
Retrieve comparable properties from the external comparables API.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
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.
Responses
Comparable properties matching the query
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.
Get Comparable Properties By Property ID
Look up property features by property_id, merge with client overrides, and retrieve comparable properties.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
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.
Responses
Subject property features and comparable properties
The subject property features used for the comparable search.
List of comparable properties matching the search criteria.
countNumber of comparable properties returned.