Skip to main content
POST
/apartmentlist/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
beds
enum<string>[] | null
Available options:
studio,
1,
2,
3
baths
enum<string> | null
Available options:
1,
2,
3
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
amenities
enum<string>[] | null
Available options:
accessible,
air_conditioning,
bbq,
balcony,
bathtub,
business_center,
carpet,
cat_friendly,
ceiling_fan,
dishwasher,
dog_friendly,
pet_friendly,
pickleball,
doorman,
elevator,
fireplace,
furnished,
garage,
garbage_disposal,
granite_counter,
gym,
hardwood_floors,
heat,
hot_tub,
ice_maker,
in_unit_laundry,
on_site_laundry,
parking,
pool,
stainless_steel,
walk_in_closet,
laundry_connections
occupancy_type
enum<string> | null
Available options:
student,
senior
collection
enum<string> | null
Available options:
most_popular,
best_rent_specials,
luxury,
best_in_budget
move_in_date
string | null

Response

Successful Response

id
string
required
@type
string
default:ApartmentlistSearchListing
url
string | null
alias
string | null
name
string | null
latitude
number | null
longitude
number | null
price_studio
number | null
price_1br
number | null
price_2br
number | null
price_3br
number | null
show_price
boolean | null
rank
integer | null