---
title: "Retrieves residential listings matching the specified criteria."
method: POST
path: "/v1/listings/residential/_search"
tags: ["Listings"]
---

# Retrieves residential listings matching the specified criteria.

`POST /v1/listings/residential/_search`

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.

## Request body

- DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsSearchParameters
  - `listingType` 'Sale' | 'Rent' | 'Share' | 'Sold' | 'NewHomes'
  - `propertyTypes` string[]
  - `propertyFeatures` string[]
  - `listingAttributes` string[]
  - `propertyEstablishedType` 'Any' | 'New' | 'Established'
  - `minBedrooms` number, float
  - `maxBedrooms` number, float
  - `minBathrooms` number, float
  - `maxBathrooms` number, float
  - `minCarspaces` integer
  - `maxCarspaces` integer
  - `minPrice` integer
  - `maxPrice` integer
  - `minLandArea` integer
  - `maxLandArea` integer
  - `advertiserIds` integer[]
  - `adIds` integer[]
  - `excludeAdIds` integer[]
  - `locations` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsSearchLocation[]
    - `state` 'ACT' | 'NSW' | 'QLD' | 'VIC' | 'SA' | 'WA' | 'NT' | 'TAS'
    - `region` string
    - `area` string
    - `suburb` string
    - `postCode` string
    - `includeSurroundingSuburbs` boolean
    - `surroundingRadiusInMeters` integer
  - `schoolCatchments` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsSchoolCatchment[]
    - `name` string
    - `state` string
    - `postcode` string
  - `locationTerms` string
  - `keywords` string[]
  - `newDevOnly` boolean
  - `inspectionFrom` string, date-time
  - `inspectionTo` string, date-time
  - `auctionFrom` string, date-time
  - `auctionTo` string, date-time
  - `dateAvailableFrom` string, date-time
  - `dateAvailableTo` string, date-time
  - `ruralOnly` boolean
  - `excludePriceWithheld` boolean
  - `excludeDepositTaken` boolean
  - `topspotKeywords` string[]
  - `customSort` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsCustomSort
    - `elements` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsCustomSortElement[]
      - `field` 'AdId' | 'PromoLevelScore' | 'FreshnessLevel' | 'ProductBoost' | 'DateUpdated' | 'DateListed' | 'SuburbName' | 'PriceDisplayOption' | 'SoldDate' | 'Price' | 'EarliestInspectionOpenTime' | 'EarliestAuctionTime' | 'DateAvailable'
      - `direction` 'Ascending' | 'Descending'
    - `boostPrimarySuburbs` boolean
  - `sort` DomainSearchServiceV2ModelSystemNullableDomainSearchWebApiV2ModelsSortBy
    - `sortKey` 'Default' | 'Suburb' | 'Price' | 'DateUpdated' | 'InspectionTime' | 'AuctionTime' | 'SoldDate' | 'DefaultThenDateUpdated' | 'DateAvailable' | 'DateListed'
    - `direction` 'Ascending' | 'Descending'
  - `pageSize` integer
  - `geoWindow` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsGeoWindow
    - `box` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsBox
      - `topLeft` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsGeoPoint
        - `lat` number, double
        - `lon` number, double
      - `bottomRight` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsGeoPoint
        - `lat` number, double
        - `lon` number, double
    - `circle` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsCircle
      - `center` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsGeoPoint
        - `lat` number, double
        - `lon` number, double
      - `radiusInMeters` integer
    - `polygon` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsPolygon
      - `points` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsGeoPoint[]
        - `lat` number, double
        - `lon` number, double
  - `updatedSince` string, date-time
  - `listedSince` string, date-time
  - `includeInspectionAggregations` boolean
  - `aggregations` string[]
  - `tags` DomainSearchServiceV2ModelDomainSearchWebApiV2ModelsTagQuery[]
    - `criteria` 'Include' | 'Exclude'
    - `tag` string
  - `pageNumber` integer

## Response `200`

OK

- DomainSearchServiceV2ModelDomainSearchContractsV2SearchResult[]
  - `type` 'PropertyListing' | 'Project'
  - `listing` DomainSearchServiceV2ModelDomainSearchContractsV2PropertyListing
    - `promoLevel` 'Standard' | 'StandardPP' | 'Elite' | 'ElitePP' | 'PremiumPlus'
    - `listingType` 'Sale' | 'Rent' | 'Share' | 'Sold' | 'NewHomes'
    - `id` integer
    - `projectId` integer
    - `advertiser` DomainSearchServiceV2ModelDomainSearchContractsV2Advertiser
      - `type` 'Agency' | 'Private'
      - `id` integer
      - `name` string
      - `logoUrl` string
      - `preferredColourHex` string
      - `bannerUrl` string
      - `contacts` DomainSearchServiceV2ModelDomainSearchContractsV2Contact[]
        - `name` string
        - `photoUrl` string
    - `priceDetails` DomainSearchServiceV2ModelDomainSearchContractsV2PriceDetails
      - `price` integer
      - `priceFrom` integer
      - `priceTo` integer
      - `displayPrice` string
    - `media` DomainSearchServiceV2ModelDomainSearchContractsV2Media[]
      - `category` 'Image'
      - `url` string
    - `propertyDetails` DomainSearchServiceV2ModelDomainSearchContractsV2PropertyDetails
      - `state` 'ACT' | 'NSW' | 'QLD' | 'VIC' | 'SA' | 'WA' | 'NT' | 'TAS'
      - `features` string[]
      - `propertyType` 'Unknown' | 'AcreageSemiRural' | 'ApartmentUnitFlat' | 'Aquaculture' | 'BlockOfUnits' | 'CarSpace' | 'DairyFarming' | 'DevelopmentSite' | 'Duplex' | 'Farm' | 'FishingForestry' | 'NewHomeDesigns' | 'House' | 'NewHouseLand' | 'IrrigationServices' | 'NewLand' | 'Livestock' | 'NewApartments' | 'Penthouse' | 'RetirementVillage' | 'Rural' | 'SemiDetached' | 'SpecialistFarm' | 'Studio' | 'Terrace' | 'Townhouse' | 'VacantLand' | 'Villa' | 'Cropping' | 'Viticulture' | 'MixedFarming' | 'Grazing' | 'Horticulture' | 'Equine' | 'Farmlet' | 'Orchard' | 'RuralLifestyle'
      - `allPropertyTypes` string[]
      - `bathrooms` number, float
      - `bedrooms` number, float
      - `carspaces` integer
      - `unitNumber` string
      - `streetNumber` string
      - `street` string
      - `area` string
      - `region` string
      - `suburb` string
      - `suburbId` integer
      - `postcode` string
      - `displayableAddress` string
      - `latitude` number, float
      - `longitude` number, float
      - `mapCertainty` integer
      - `landArea` number, double
      - `buildingArea` number, double
      - `onlyShowProperties` string[]
      - `displayAddressType` string
      - `isRural` boolean
      - `topSpotKeywords` string[]
      - `isNew` boolean
      - `tags` string[]
    - `headline` string
    - `summaryDescription` string
    - `hasFloorplan` boolean
    - `hasVideo` boolean
    - `labels` string[]
    - `auctionSchedule` DomainSearchServiceV2ModelDomainSearchContractsV2AuctionSchedule
      - `time` string, date-time
      - `auctionLocation` string
    - `dateAvailable` string, date-time
    - `dateListed` string, date-time
    - `inspectionSchedule` DomainSearchServiceV2ModelDomainSearchContractsV2InspectionSchedule
      - `byAppointment` boolean
      - `recurring` boolean
      - `times` DomainSearchServiceV2ModelDomainSearchContractsV2Inspection[]
        - `openingTime` string, date-time
        - `closingTime` string, date-time
    - `soldData` DomainSearchServiceV2ModelDomainSearchContractsV2SoldData
      - `source` 'Agency' | 'Apm'
      - `saleMethod` 'NotStated' | 'SoldByAuction' | 'SoldByPrivateTreaty' | 'Withdrawn' | 'SoldPriorToAuction'
      - `soldDate` string, date-time
      - `soldPrice` integer
    - `listingSlug` string
  - `listings` DomainSearchServiceV2ModelDomainSearchContractsV2PropertyListing[]
    - `promoLevel` 'Standard' | 'StandardPP' | 'Elite' | 'ElitePP' | 'PremiumPlus'
    - `listingType` 'Sale' | 'Rent' | 'Share' | 'Sold' | 'NewHomes'
    - `id` integer
    - `projectId` integer
    - `advertiser` DomainSearchServiceV2ModelDomainSearchContractsV2Advertiser
      - `type` 'Agency' | 'Private'
      - `id` integer
      - `name` string
      - `logoUrl` string
      - `preferredColourHex` string
      - `bannerUrl` string
      - `contacts` DomainSearchServiceV2ModelDomainSearchContractsV2Contact[]
        - `name` string
        - `photoUrl` string
    - `priceDetails` DomainSearchServiceV2ModelDomainSearchContractsV2PriceDetails
      - `price` integer
      - `priceFrom` integer
      - `priceTo` integer
      - `displayPrice` string
    - `media` DomainSearchServiceV2ModelDomainSearchContractsV2Media[]
      - `category` 'Image'
      - `url` string
    - `propertyDetails` DomainSearchServiceV2ModelDomainSearchContractsV2PropertyDetails
      - `state` 'ACT' | 'NSW' | 'QLD' | 'VIC' | 'SA' | 'WA' | 'NT' | 'TAS'
      - `features` string[]
      - `propertyType` 'Unknown' | 'AcreageSemiRural' | 'ApartmentUnitFlat' | 'Aquaculture' | 'BlockOfUnits' | 'CarSpace' | 'DairyFarming' | 'DevelopmentSite' | 'Duplex' | 'Farm' | 'FishingForestry' | 'NewHomeDesigns' | 'House' | 'NewHouseLand' | 'IrrigationServices' | 'NewLand' | 'Livestock' | 'NewApartments' | 'Penthouse' | 'RetirementVillage' | 'Rural' | 'SemiDetached' | 'SpecialistFarm' | 'Studio' | 'Terrace' | 'Townhouse' | 'VacantLand' | 'Villa' | 'Cropping' | 'Viticulture' | 'MixedFarming' | 'Grazing' | 'Horticulture' | 'Equine' | 'Farmlet' | 'Orchard' | 'RuralLifestyle'
      - `allPropertyTypes` string[]
      - `bathrooms` number, float
      - `bedrooms` number, float
      - `carspaces` integer
      - `unitNumber` string
      - `streetNumber` string
      - `street` string
      - `area` string
      - `region` string
      - `suburb` string
      - `suburbId` integer
      - `postcode` string
      - `displayableAddress` string
      - `latitude` number, float
      - `longitude` number, float
      - `mapCertainty` integer
      - `landArea` number, double
      - `buildingArea` number, double
      - `onlyShowProperties` string[]
      - `displayAddressType` string
      - `isRural` boolean
      - `topSpotKeywords` string[]
      - `isNew` boolean
      - `tags` string[]
    - `headline` string
    - `summaryDescription` string
    - `hasFloorplan` boolean
    - `hasVideo` boolean
    - `labels` string[]
    - `auctionSchedule` DomainSearchServiceV2ModelDomainSearchContractsV2AuctionSchedule
      - `time` string, date-time
      - `auctionLocation` string
    - `dateAvailable` string, date-time
    - `dateListed` string, date-time
    - `inspectionSchedule` DomainSearchServiceV2ModelDomainSearchContractsV2InspectionSchedule
      - `byAppointment` boolean
      - `recurring` boolean
      - `times` DomainSearchServiceV2ModelDomainSearchContractsV2Inspection[]
        - `openingTime` string, date-time
        - `closingTime` string, date-time
    - `soldData` DomainSearchServiceV2ModelDomainSearchContractsV2SoldData
      - `source` 'Agency' | 'Apm'
      - `saleMethod` 'NotStated' | 'SoldByAuction' | 'SoldByPrivateTreaty' | 'Withdrawn' | 'SoldPriorToAuction'
      - `soldDate` string, date-time
      - `soldPrice` integer
    - `listingSlug` string
  - `project` DomainSearchServiceV2ModelDomainSearchContractsV2Project
    - `promoLevel` 'Standard' | 'Premium'
    - `state` 'ACT' | 'NSW' | 'QLD' | 'VIC' | 'SA' | 'WA' | 'NT' | 'TAS'
    - `id` integer
    - `name` string
    - `bannerUrl` string
    - `preferredColorHex` string
    - `logoUrl` string
    - `labels` string[]
    - `displayableAddress` string
    - `suburb` string
    - `suburbId` integer
    - `features` string[]
    - `media` DomainSearchServiceV2ModelDomainSearchContractsV2Media[]
      - `category` 'Image'
      - `url` string
    - `projectSlug` string

---

[API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/revisions/839de6c29cc3/schema)