/domain/properties/search

POST /api/domain/properties/search

Price: 1 credit

Search Domain.com.au property listings by location (suburb/postcode) and channel (buy/rent/sold/new-homes) with filters for property type, price, bedrooms, bathrooms, parking, land area, features, keywords and ordering.

How to use it

Search Domain.com.au listings under a location slug ({suburb}-{state}-{postcode}, e.g. sydney-nsw-2000) and a channel (buy/rent/sold/new-homes). Filters: property_types, price_min/price_max, beds_min/beds_max, baths_min, parking_min, area_min/area_max (with area_unit m2/acres/hectares), features, keywords, include_surrounding, exclude_price_withheld, sort (featured/newest/price-asc/price-desc/suburb). Each item: id, url, listing_type, property_type, bedroom_count, bathroom_count, parking_count, is_rural, is_retirement, is_new, price_label, address, suburb, state, postcode, unit_number, land_size, land_unit, features, image, geolocation.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Suburb/postcode location slug in the form {suburb}-{state}-{postcode} (examples: "sydney-nsw-2000", "bondi-beach-nsw-2026"; minLength: 1)
• channel string — Listing channel (default: "buy"; one of: "buy", "rent", "sold", "new-homes")
• property_types array — Property types to include (default: []; one of: "house", "apartment", "townhouse", "villa", "studio", "penthouse", "semi-detached", "acreage", "block-of-units", "vacant-land", "new-land", "new-apartments", "new-house-land", "new-home-designs", "development-site", "rural", "farm", "retirement")
• price_min integer nullable — Minimum price (min: 0)
• price_max integer nullable — Maximum price (min: 0)
• beds_min integer nullable — Minimum bedrooms (min: 0)
• beds_max integer nullable — Maximum bedrooms (min: 0)
• baths_min integer nullable — Minimum bathrooms (min: 0)
• parking_min integer nullable — Minimum parking spaces (min: 0)
• area_min integer nullable — Minimum land area (min: 0)
• area_max integer nullable — Maximum land area (min: 0)
• area_unit string — Unit for area_min/area_max (default: "m2"; one of: "m2", "acres", "hectares")
• features array — Required property features (default: []; one of: "air-conditioning", "built-in-wardrobes", "swimming-pool", "study", "gas", "pets-allowed", "internal-laundry", "ensuite", "secure-parking", "balcony-deck", "garden-courtyard", "heating", "dishwasher", "furnished", "fully-fenced", "solar-hot-water", "water-views", "floorboards")
• keywords string nullable — Free-text keywords (e.g. waterfront, views)
• include_surrounding boolean — Include surrounding suburbs (default: false)
• exclude_price_withheld boolean — Exclude listings with a withheld price (default: false)
• sort string — Result ordering (default: "featured"; one of: "featured", "newest", "price-asc", "price-desc", "suburb")
• count integer required — Number of results to return (min: 1)

Response

• @type string (default: "DomainSearchListing")
• id string required
• url string nullable
• listing_type string nullable
• property_type string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• parking_count integer nullable
• is_rural boolean nullable
• is_retirement boolean nullable
• is_new boolean nullable
• price_label string nullable
• address string nullable
• suburb string nullable
• state string nullable
• postcode string nullable
• unit_number string nullable
• land_size number nullable
• land_unit string nullable
• features array (default: [])
• image string nullable
• geolocation object nullable
  • @type string (default: "DomainGeolocation")
  • latitude number nullable
  • longitude number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.