Skip to main content
POST
/apartments/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:ApartmentsListing
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
pets_allowed
boolean | null
year_built
integer | null
unit_count
integer | null
rating
number | null
rating_count
integer | null
image
string | null
images
string[]
community_amenities
string[]
apartment_amenities
string[]
floor_plans
object[]
reviews
object[]
scores
object
lease_options
string[]