Skip to main content
POST
Search selected listing platforms
Check live capabilities before calling this operation. A documented contract does not imply active coverage for every source or country.

Authorizations

x-api-key
string
header
required

Body

application/json
platforms
string[]
required
Required array length: 1 - 5 elements
location
object
required
transaction
enum<string>
required
Available options:
sale,
rent,
lease,
auction
property_types
string[]
status
string[]
price
object
bedrooms
object

At least one bound is required; min <= max when both supplied.

bathrooms
object

At least one bound is required; min <= max when both supplied.

area
object
listed_since
string<date-time>
sort
enum<string>
Available options:
source_order,
price_asc,
price_desc,
newest
include
enum<string>[]
Available options:
media,
history,
agent,
agency,
units,
open_houses,
source_fields
source_filters
object
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string
allow_partial
boolean
default:false
group_by_property
boolean
default:false

Response

Successful response; meta discloses source completeness

data
object[]
required
meta
object
required