DomainComAu

get/domain-com-au/search

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/domain-com-au/search
  • Auth: API key in header X-API-KEY

Query parameters

mode'buy' | 'rent' | 'sold' | 'new-homes' | 'commercial' | 'rural' required

buy, rent, sold, new-homes, or rural. Commercial is refused with a 400: the upstream search API exposes no commercial listings, and the commercial web tier is blocked, so it cannot be served.

suburbstring nullable

Suburb name, for example Pyrmont.

suburbs[]string[]

Up to 20 suburb names. Each is searched as its own location; combining them with suburb sends them all.

regionstring nullable

Region name, for example Inner West.

statestring nullable

State name, for example NSW.

postcodestring nullable

Postcode, for example 2009.

pageinteger

1-based page number. Ten listings per page.

property_types[]string[]

House, Apartment, Townhouse, Land, Rural, NewApartments, NewHomeDesigns, or NewHouseLand.

listing_attributes[]string[]

HasPhotos, HasPrice, HasMatterport, NotUpForAuction, MarkedAsNew, or NotUnderContract.

min_bedroomsinteger nullable

Lower bedroom bound.

max_bedroomsinteger nullable

Upper bedroom bound.

min_bathroomsinteger nullable

Lower bathroom bound.

max_bathroomsinteger nullable

Upper bathroom bound.

min_carspacesinteger nullable

Lower carspace bound.

max_carspacesinteger nullable

Upper carspace bound.

min_priceinteger nullable

Lower price bound in AUD.

max_priceinteger nullable

Upper price bound in AUD.

min_land_areainteger nullable

Lower land-area bound in square metres.

max_land_areainteger nullable

Upper land-area bound in square metres.

sold_date_range'ALL' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_THREE_MONTHS' | 'LAST_SIX_MONTHS' | 'LAST_YEAR' | 'LAST_TWO_YEARS' | 'null' nullable

Sold mode only: ALL, LAST_WEEK, LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_YEAR, or LAST_TWO_YEARS.

Response

string required

Changes

No recorded changes to this operation across all 3 revisions of this API.