Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Listings

Retrieves residential listings matching the specified criteria.

Search results are limited to the first 1000 results.

If the number of results is greater, the intention is to refine the search by adding more restrictive parameters, to find a relevant set of results.

post/v1/listings/residential/_search

Request body

listingType'Sale' | 'Rent' | 'Share' | 'Sold' | 'NewHomes'
propertyTypesstring[]
propertyFeaturesstring[]
listingAttributesstring[]
propertyEstablishedType'Any' | 'New' | 'Established'
minBedroomsnumber float
maxBedroomsnumber float
minBathroomsnumber float
maxBathroomsnumber float
minCarspacesinteger
maxCarspacesinteger
minPriceinteger
maxPriceinteger
minLandAreainteger
maxLandAreainteger
advertiserIdsinteger[]
adIdsinteger[]
excludeAdIdsinteger[]
locationTermsstring
keywordsstring[]
newDevOnlyboolean
inspectionFromstring date-time
inspectionTostring date-time
auctionFromstring date-time
auctionTostring date-time
dateAvailableFromstring date-time
dateAvailableTostring date-time
ruralOnlyboolean
excludePriceWithheldboolean
excludeDepositTakenboolean
topspotKeywordsstring[]
pageSizeinteger
updatedSincestring date-time
listedSincestring date-time
includeInspectionAggregationsboolean
aggregationsstring[]
pageNumberinteger

Response

OK

type'PropertyListing' | 'Project'