Get Property

Query Parameters

string

required

Full apartments.com property URL, e.g. https://www.apartments.com/urbane-kansas-city-mo/wcd6e5k/. You can take this straight from a search result’s url.

There is also GET /v1/apartments/properties/{slug}/{property_id} if you would rather address the property by its parts — slug being the SEO segment (urbane-kansas-city-mo) and property_id the 7-character listing key (wcd6e5k).

Response

string

apartments.com listing key (nullable).

string

The property URL that was fetched.

string

Property name (nullable).

string

Full address as rendered (nullable).

string

City (nullable).

string

Two-letter state code (nullable).

string

ZIP code (nullable).

string

Neighborhood, when the property lists one (nullable).

number

Latitude (nullable).

number

Longitude (nullable).

string

Leasing phone number (nullable).

string

Advertised range as rendered, e.g. $1,288 - $5,412 (nullable).

integer

Low end of the advertised range (nullable).

integer

High end of the advertised range (nullable).

string

Advertised bed range, e.g. 1 - 3 bd (nullable).

string

Property description (nullable).

array

Amenity labels, deduplicated.

array

Leasing-office hours as rendered.

array

Gallery image URLs.

integer

Count of individually-listed units across all floor plans.

array

Schools from the property’s Schools section, as provided by GreatSchools.

Show School object

string

School name (nullable).

string

Type as rendered, e.g. Public Elementary School (nullable).

boolean

Whether the school sits under the page’s Private Schools tab.

string

Grade range, e.g. PK-5, 9-12 (nullable).

integer

Enrolled students (nullable).

string

Attendance Zone (the property is zoned for this school) or Nearby (nullable).

integer

GreatSchools rating out of 10. null means the school is unrated — apartments.com renders no badge for those. It is never 0.

integer

Always 10.

string

apartments.com’s page for the school (nullable).

The Schools section also lists nearby colleges and universities. Those are not returned as schools — they carry a drive time rather than a grade range.

array

Floor-plan models.

Show FloorPlan object

string

Plan name, e.g. Axis (nullable).

string

Site-internal model key (nullable).

string

Site-internal rental key (nullable).

number

Bedrooms — 0.0 for a studio (nullable).

number

Bathrooms (nullable).

string

Price as rendered, e.g. Starting at $1,288 (nullable).

integer

Low end for this plan (nullable).

integer

High end for this plan (nullable).

string

The plan header verbatim — mixed content, not just size (nullable).

integer

Smallest square footage for this plan (nullable).

integer

Largest square footage for this plan (nullable).

array

The individually-listed units for this plan.

integer

Count of units on this plan. 0 is normal on properties that advertise plans rather than individual units.

array

Every unit across every floor plan, flattened — usually the shape you want.

Show Unit object

string

Unit label, e.g. 8625-2231 (nullable).

string

Site-internal unit key (nullable).

string

Site-internal rental key (nullable).

string

The floor plan this unit belongs to (nullable).

number

Bedrooms — 0.0 for a studio (nullable).

number

Bathrooms (nullable).

integer

The advertised monthly rent. Use this one (nullable).

string

The price column verbatim, so you can see qualifiers we did not parse (nullable).

integer

Raw data-maxrent from the site — roughly 2x the advertised rent, apparently an upper bound across lease terms. Exposed unparsed; do not use it as the rent (nullable).

string

Always USD.

integer

Square footage (nullable).

string

Availability verbatim — Now, Sep 3. No year is rendered, so this is deliberately not a date (nullable).

string

Floor-plan name for this unit (nullable).

integer

Photos attached to this unit.

integer

Videos attached to this unit.

integer

Floor-plan images attached to this unit.

integer

Virtual tours attached to this unit.

string

Direct application URL, when the property offers one (nullable).

rent vs max_term_rent. Both are on every unit. On a model advertised “Starting at $1,288", the units rendered `$1,298whiledata-maxrentread2876— roughly double.rentis the advertised price;max_term_rent` is the raw attribute, exposed for completeness only.

Example

curl -H "X-API-Key: YOUR_KEY" \
  "https://scrapebadger.com/v1/apartments/property?url=https%3A%2F%2Fwww.apartments.com%2Furbane-kansas-city-mo%2Fwcd6e5k%2F"

prop = await client.apartments.get_property(
    "https://www.apartments.com/urbane-kansas-city-mo/wcd6e5k/"
)
for unit in prop.units:
    print(unit.unit_number, unit.rent, unit.beds, unit.sqft, unit.available_text)

const prop = await client.apartments.getProperty(
  "https://www.apartments.com/urbane-kansas-city-mo/wcd6e5k/",
);

Cost: 8 credits.

Overview

Search

Properties

Query Parameters

Response

Example

​Query Parameters

​Response

​Example

Query Parameters

Response

Example