Skip to main content
POST
/apartments/listings/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
bedrooms
enum<string> | null
Available options:
studio,
1,
2,
3,
4
home_type
enum<string> | null
Available options:
apartments,
houses,
condos,
townhomes
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0

Response

Successful Response

id
string
required
url
string
required
@type
string
default:ApartmentsSearchListing
name
string | null
phone
string | null
address
object | null
geo
object | null
rent_low
integer | null
rent_high
integer | null
currency
string | null
availability
string | null
image
string | null
amenities
string[]
specials
string[]
bed_rents
object[]