Skip to main content
POST
/hotpads/listings

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
listing
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
@type
string
default:HotpadsListing
unit
string | null
name
string | null
property_type
string | null
listing_type
string | null
alias
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
unit_count
integer | null
is_furnished
boolean | null
lease_terms
string | null
amenities
string[]
amenity_highlights
string[]
pet_policies
object[]
image
string | null
images
string[]
photo_count
integer | null
videos
string[]
tour_urls
string[]
costs_fees_note
string | null
special_offers
string[]
property_manager
string | null
property_manager_contact
string | null
property_manager_phone
string | null
property_manager_website
string | null
models
object[]
schools
object[]
listed_at
integer | null
created_at
integer | null
updated_at
integer | null