Comparable Properties
Retrieve comparable properties from the external comparables API.
[Usage & billing] Each call costs 12 credits.
Request Body
postcode^([A-Za-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
countComparable Properties By Property ID
Look up property features by property_id / uprn / udprn, merge with client overrides, and retrieve comparable properties.
[Usage & billing] Each call costs 12 credits.
Request Body
Propalt 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.
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.