Skip to main content
POST
/hotpads/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
category
enum<string>
default:apartments
Available options:
apartments,
houses,
condos,
townhomes,
rooms,
sublets,
corporate_housing
home_type
enum<string>[] | null
Available options:
apartment,
condo,
duplex,
house,
townhouse
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
beds
enum<string> | null
Available options:
studio,
one_plus,
two_plus,
three_plus,
four_plus
baths
enum<string> | null
Available options:
one_plus,
one_half_plus,
two_plus,
three_plus,
four_plus
pets
enum<string>[] | null
Available options:
cats,
dogs
amenities
enum<string>[] | null
Available options:
cooling,
heating,
parking,
gated_entry,
doorman,
fitness_center,
swimming_pool,
dishwasher
laundry
enum<string>[] | null
Available options:
in_unit,
shared
furnished
boolean | null
sqft_min
integer | null
Required range: x >= 0
sqft_max
integer | null
Required range: x >= 0
keywords
string | null
restricted_housing
enum<string> | null
Available options:
income,
senior,
student,
military
has_promotions
boolean | null
sort
enum<string>
default:newest
Available options:
recommended,
newest

Response

Successful Response

id
string
required
url
string
required
@type
string
default:HotpadsSearchListing
property_type
string | null
listing_type
string | null
alias
string | null
name
string | null
address
object | null
neighborhood
string | null
latitude
number | null
longitude
number | null
price_min
number | null
price_max
number | null
bed_min
number | null
bed_max
number | null
bath_min
number | null
bath_max
number | null
sqft_min
number | null
sqft_max
number | null
image
string | null
photo_count
integer | null
has_special_offers
boolean | null
income_restricted
boolean | null
senior_housing
boolean | null
student_housing
boolean | null
military_housing
boolean | null
amenity_highlights
string[]
activated_at
integer | null
updated_at
integer | null