v1

latestSwagger 2.02026-08-042776106.6 KB
Property

Property Details - Comparables (Unified)

Returns comparable properties near the target property. status selects the listing category — sales: available, sstc, forsalewithdrawn, soldwithdrawn; lettings: tolet, letagreed, letagreedwithdrawn, letwithdrawn. Price, bedroom, property-type, distance and sort filters behave the same as on /currentlyforsale and /recentlysold.

get/property/{uprn}/{status}

Path parameters

uprninteger required

Unique Property Reference Number

status'available' | 'sstc' | 'forsalewithdrawn' | 'soldwithdrawn' | 'tolet' | 'letagreed' | 'letagreedwithdrawn' | 'letwithdrawn' required

Listing status to filter by. Sales: available (currently listed for sale), sstc (sold subject to contract — sale agreed but not completed), forsalewithdrawn (was listed for sale, then withdrawn without a sale), soldwithdrawn (was listed for sale, went SSTC, then withdrawn from portal after sale completed). Lettings: tolet (currently listed to let), letagreed (tenant agreed), letagreedwithdrawn (was let agreed, then withdrawn), letwithdrawn (was listed to let, then withdrawn without agreement).

Query parameters

bedroomstring
typestring

Property types seperated by comma. Flat,Detached,Semi-Detached,Terraced,Other

price1integer
price2integer
searchDistancenumber

Search radius in miles (default 0.5)

sortnumber

1: Price asc, 2: Price desc, 3: Distance asc

limitinteger

Maximum number of results to return. Default 30, max 100.

daysinteger

Only return listings from the last N days. Omit for all time.

newBuildstring

Set to 1 to return new-build properties only.

bungalowstring

Set to 1 to return bungalows only.

Headers

SPRIFT-API-KEYstring required

Response

Comparables list

statusboolean
category'SALE' | 'LETTINGS'
typestring[]

The listing-status values that were queried against OpenSearch for the requested type.