Skip to main content
POST
/apartmentlist/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:ApartmentlistListing
alias
string | null
name
string | null
highlight
string | null
formatted_address
string | null
street_address
string | null
city
string | null
state
string | null
zip
string | null
county
string | null
neighborhood
string | null
latitude
number | null
longitude
number | null
phone
string | null
management_company
string | null
source_name
string | null
occupancy_types
string[]
show_price
boolean | null
has_unit_level_availability
boolean | null
tour_booking_allowed
boolean | null
updated_at
integer | null
availability_checked_at
integer | null
image
string | null
images
string[]
virtual_tours
object[]
community_amenities
string[]
unit_amenities
string[]
specials
object[]
application_fee
string | null
additional_fees
string | null
deposit_fee
string | null
move_in_fees
string | null
lease_terms
string | null
utilities_included
string | null
income_requirement
string | null
income_multiplier
number | null
walk_score
object | null
transit_score
object | null
top_amenities
object[]
parking
object[]
office_hours
object[]
pet_policy
object | null
average_rent
object | null
floor_plans
object[]
schools
object[]
pois
object[]
reviews
object[]
similar_listings
object[]