Skip to main content
POST
/
api
/
domain
/
properties
/
search
/domain/properties/search
curl --request POST \
  --url https://api.anysite.io/api/domain/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "channel": "buy",
  "property_types": [],
  "price_min": 1,
  "price_max": 1,
  "beds_min": 1,
  "beds_max": 1,
  "baths_min": 1,
  "parking_min": 1,
  "area_min": 1,
  "area_max": 1,
  "area_unit": "m2",
  "features": [],
  "keywords": "<string>",
  "include_surrounding": false,
  "exclude_price_withheld": false,
  "sort": "featured"
}
'
[
  {
    "id": "<string>",
    "@type": "@domain_search_listing",
    "url": "<string>",
    "listing_type": "<string>",
    "property_type": "<string>",
    "bedroom_count": 123,
    "bathroom_count": 123,
    "parking_count": 123,
    "is_rural": true,
    "is_retirement": true,
    "is_new": true,
    "price_label": "<string>",
    "address": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "unit_number": "<string>",
    "land_size": 123,
    "land_unit": "<string>",
    "features": [],
    "image": "<string>",
    "geolocation": {
      "@type": "@domain_geolocation",
      "latitude": 123,
      "longitude": 123
    }
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
location
string
required

Suburb/postcode location slug in the form {suburb}-{state}-{postcode}

Minimum string length: 1
Examples:

"sydney-nsw-2000"

"bondi-beach-nsw-2026"

​
count
integer
required

Number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
channel
enum<string>
default:buy

Listing channel

Available options:
buy,
rent,
sold,
new-homes
​
property_types
enum<string>[]

Property types to include

Available options:
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 | null

Minimum price

Required range: x >= 0
​
price_max
integer | null

Maximum price

Required range: x >= 0
​
beds_min
integer | null

Minimum bedrooms

Required range: x >= 0
​
beds_max
integer | null

Maximum bedrooms

Required range: x >= 0
​
baths_min
integer | null

Minimum bathrooms

Required range: x >= 0
​
parking_min
integer | null

Minimum parking spaces

Required range: x >= 0
​
area_min
integer | null

Minimum land area

Required range: x >= 0
​
area_max
integer | null

Maximum land area

Required range: x >= 0
​
area_unit
enum<string>
default:m2

Unit for area_min/area_max

Available options:
m2,
acres,
hectares
​
features
enum<string>[]

Required property features

Available options:
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 | null

Free-text keywords (e.g. waterfront, views)

​
include_surrounding
boolean
default:false

Include surrounding suburbs

​
exclude_price_withheld
boolean
default:false

Exclude listings with a withheld price

​
sort
enum<string>
default:featured

Result ordering

Available options:
featured,
newest,
price-asc,
price-desc,
suburb

Response

Successful Response

​
id
string
required
​
@type
string
default:@domain_search_listing
​
url
string | null
​
listing_type
string | null
​
property_type
string | null
​
bedroom_count
integer | null
​
bathroom_count
integer | null
​
parking_count
integer | null
​
is_rural
boolean | null
​
is_retirement
boolean | null
​
is_new
boolean | null
​
price_label
string | null
​
address
string | null
​
suburb
string | null
​
state
string | null
​
postcode
string | null
​
unit_number
string | null
​
land_size
number | null
​
land_unit
string | null
​
features
string[]
​
image
string | null
​
geolocation
DomainGeolocation · object