Skip to main content
POST
/
api
/
apartments
/
listings
/apartments/listings
curl --request POST \
  --url https://api.anysite.io/api/apartments/listings \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "listing": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@apartments_listing",
    "name": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "address": {
      "@type": "@apartments_address",
      "street": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "geo": {
      "@type": "@apartments_geo",
      "latitude": 123,
      "longitude": 123
    },
    "rent_low": 123,
    "rent_high": 123,
    "currency": "<string>",
    "availability": "<string>",
    "pets_allowed": true,
    "year_built": 123,
    "unit_count": 123,
    "rating": 123,
    "rating_count": 123,
    "image": "<string>",
    "images": [],
    "community_amenities": [],
    "apartment_amenities": [],
    "floor_plans": [],
    "reviews": [],
    "scores": {},
    "lease_options": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
listing
string
required

Apartments.com listing shortcode or a listing URL containing it

Minimum string length: 1
Examples:

"40n18nj"

"https://www.apartments.com/edison-austin-austin-tx/40n18nj/"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@apartments_listing
name
string | null
description
string | null
phone
string | null
address
ApartmentsAddress · object
geo
ApartmentsGeo · object
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
ApartmentsFloorPlan · object[]
reviews
ApartmentsReview · object[]
scores
Scores · object
lease_options
string[]