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
keywords
string | null
Minimum string length: 1
min_baths
integer | null
Required range: 1 <= x <= 3
min_sqft
integer | null
Required range: x >= 0
max_sqft
integer | null
Required range: x >= 0
pets
enum<string> | null
Available options:
dogs,
cats,
dogs_and_cats
amenities
enum<string>[] | null
Available options:
in_unit_washer_dryer,
dishwasher,
air_conditioning,
balcony,
fireplace,
furnished,
fitness_center,
pool,
playground,
parking,
wheelchair_access,
elevator,
washer_dryer_hookups,
laundry_facilities,
utilities_included,
lofts,
doorman,
gated,
concierge,
clubhouse,
controlled_access,
business_center,
garage,
patio,
hardwood_floors,
den,
office,
yard,
walk_in_closets,
basement,
ev_charging,
storage_units,
high_ceilings,
dog_park
specialty
enum<string> | null
Available options:
senior,
military,
student,
corporate,
short_term,
income_restricted,
luxury,
cheap,
rent_specials
min_rating
integer | null
Required range: 4 <= x <= 5
move_in_date
string | null

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[]