Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
ListingSearch

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/listingSearch/residential/search

Request body

listingType'Sale' | 'Rent' | 'Share' | 'Sold' | 'NewHomes'

Gets or Sets ListingType

saleMethodsstring[] nullable

Gets or Sets SaleMethods

minBedroomsnumber float nullable

Filter listing by minimum number of bedrooms

maxBedroomsnumber float nullable

Filter listing by maximum number of bedrooms

minBathroomsnumber float nullable

Filter listing by minimum number of bathrooms

maxBathroomsnumber float nullable

Filter listing by maximum number of bathrooms 0.5 means no shower

minCarspacesinteger nullable

Filter listing by minimum number of car spaces

maxCarspacesinteger nullable

Filter listing by maximum number of car spaces

minPriceinteger nullable

Filter listing at or above a minimum price

maxPriceinteger nullable

Filter listing at or below a maximum price

minLandAreainteger nullable

Min Land Area in square meters

maxLandAreainteger nullable

Max Land Area in square meters

advertiserIdsinteger[] nullable

Return listings only created by these agencies.

adIdsinteger[] nullable

Filter based on Ad Ids (Include in search result if AdID is in this list)

excludeAdIdsinteger[] nullable

Filter out listings with Ad Ids (Exclude listings from search result if AdID is in this list)

propertyTypesstring[] nullable

Filter by one or more types of properties

propertyFeaturesstring[] nullable

Filter by one or more property features such as Gas or AC

locationTermsstring nullable

Filter by location terms. This can be used in conjunction with Locations

keywordsstring[] nullable

Filter by one or more keywords that a listing should contain

listingAttributesstring[] nullable

Limit the results to listing with specific attributes

newDevOnlyboolean nullable

Gets or Sets NewDevOnly

inspectionFromstring date-time nullable

Filter listings with inspection time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.

inspectionTostring date-time nullable

Filter listings with inspection time on or before date specified. Strings of the format: yyyy-MM-dd are acceptable.

auctionFromstring date-time nullable

Filter listings with auction time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.

auctionTostring date-time nullable

Filter listings with auction on or before from the date specified. Strings of the format: yyyy-MM-dd are acceptable.

dateAvailableFromstring date-time nullable

Return only those listings whose DateAvailable is null, or is at or after the specified time. Strings of the format: yyyy-MM-dd are acceptable.

dateAvailableTostring date-time nullable

Return only those listings whose DateAvailable is null, or is at or before the specified time. Strings of the format: yyyy-MM-dd are acceptable.

ruralOnlyboolean nullable

if true, the response will include only listings flagged with IsRural

excludePriceWithheldboolean nullable

If true, exclude listings whose price has been withheld.

excludeDepositTakenboolean nullable

If truec>, exclude listings (rental) has deposit taken

topspotKeywordsstring[] nullable

Search by topspot keywords

pageinteger nullable

The specific result page to return. Defaults to 1 when omitted or less than zero.

pageSizeinteger nullable

Specify the number of result items in a page

updatedSincestring date-time nullable

Only return listings that have been updated since the specified date. Strings of the format: yyyy-MM-dd are acceptable.

listedSincestring date-time nullable

Only return listings that have been listed since the specified date. Strings of the format: yyyy-MM-dd are acceptable.

propertyEstablishedType'Any' | 'New' | 'Established'

Gets or Sets PropertyEstablishedType

includeInspectionAggregationsboolean nullable

Gets or Sets IncludeInspectionAggregations

aggregationsstring[] nullable

Gets or Sets Aggregations

Response

OK

totalResultsinteger nullable

Gets or Sets TotalResults

totalPagesinteger nullable

Gets or Sets TotalPages

pageinteger nullable

Gets or Sets Page

actualTotalResultsinteger nullable

Gets or Sets ActualTotalResults

actualTotalResultsExceedsMaximumboolean nullable

Gets or Sets ActualTotalResultsExceedsMaximum