Skip to main content
POST
/domain/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
channel
enum<string>
default:buy
Available options:
buy,
rent,
sold,
new-homes
property_types
enum<string>[]
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
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
beds_min
integer | null
Required range: x >= 0
beds_max
integer | null
Required range: x >= 0
baths_min
integer | null
Required range: x >= 0
parking_min
integer | null
Required range: x >= 0
area_min
integer | null
Required range: x >= 0
area_max
integer | null
Required range: x >= 0
area_unit
enum<string>
default:m2
Available options:
m2,
acres,
hectares
features
enum<string>[]
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
include_surrounding
boolean
default:false
exclude_price_withheld
boolean
default:false
sort
enum<string>
default:featured
Available options:
featured,
newest,
price-asc,
price-desc,
suburb

Response

Successful Response

id
string
required
@type
string
default:DomainSearchListing
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
object | null