Skip to main content

Query Parameters

string
required
The apartments.com location slug — the segment right after the domain in the site’s own URLs. E.g. kansas-city-mo, new-york-ny, austin-tx, or a ZIP like 64108.
integer
default:"1"
Page number, 1-28. Each page holds up to 40 property cards.
integer
Bedroom count: 0 for studios, 1 to 4 for bedroom counts.
integer
Minimum monthly rent in USD (100-20000). Combine with max_price for a range.
integer
Maximum monthly rent in USD (100-20000).

Response

string
The location slug that was searched.
string
The apartments.com URL that was fetched.
integer
Current page number.
integer
Total pages available for this query (nullable).
integer
Total matching properties as apartments.com reports them (nullable).
integer
Number of cards on this page (up to 40).
array
The property cards.
A card is a summary. For per-unit rent, beds, baths, square footage and availability, pass its url to Get Property.

Filter behaviour

Filters are applied by apartments.com itself. Measured against live result counts on kansas-city-mo (700 unfiltered): beds=1 → 374, beds=2 → 490, beds=0 → 145, max_price=1500 → 646, beds=1&max_price=1500 → 320.

Example

Cost: 5 credits per page.