# Apartments.com Rental Listing & Floor Plan Scraper (`dataspryva/apartments-com-rental-listing-and-floor-plan`) Actor

Search Apartments.com rentals by city, bedroom count, price, property type, pet policy, and amenities, or scrape specific listing URLs directly. Returns rent ranges, per-unit floor plans, walkability scores, amenities, and leasing contact details.

- **URL**: https://apify.com/dataspryva/apartments-com-rental-listing-and-floor-plan.md
- **Developed by:** [Dataspryva](https://apify.com/dataspryva) (community)
- **Categories:** Real estate, Lead generation, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.49 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Apartments.com Rentals, Floor Plans & Fees Scraper

Apartments.com is where US renters compare managed communities, houses, condos and townhomes. This actor turns those public property pages into structured records: rent by bedroom count, floor plans, individual available units, fees, pet and parking rules, schools, office hours, the leasing manager, the property website and the photo gallery.

Use it to research a move, compare neighborhoods, track rent changes, or feed a rental dataset into a spreadsheet, CRM or analytics pipeline.

### What it does

- Searches a US city/state or ZIP code with filters for rent, bedrooms, bathrooms, square footage, property type, pets, amenities, rating, move-in date, specials and lifestyle.
- Accepts Apartments.com city-search URLs and property URLs in one mixed list.
- Looks up listing keys directly when you already have them.
- Returns one record per property, with the fields the property actually publishes.
- Omits fields a property does not publish instead of sending empty values.
- Reports partial failures (stale keys, failed detail requests) in the run status instead of failing the whole run.

### Services

- **Location search** — city/state or 5-digit ZIP.
- **URL mode** — paste search-result pages or individual property pages.
- **Listing-key lookup** — one record per key, with invalid keys reported.
- **Rent by bedroom** — the rent range for studios, 1-bed, 2-bed and larger plans.
- **Floor plans and units** — model names, beds, baths, square footage, rent, total monthly price, unit counts, and individual unit numbers with availability dates and apply links.
- **Monthly and one-time fees** — application, admin, deposit, pet, parking, storage, utility and other published fees.
- **Policies** — pet rules, parking options, lease terms, office hours and languages.
- **Local context** — schools, neighborhood, submarket, market and rating.
- **Contact and media** — manager, website, phone and photo gallery.

### How it works

1. Reads your mode and filters.
2. For search mode, resolves the city or ZIP and scans the site's public listing index for that place, up to the `maxPages` depth you set.
3. Reads each candidate property's public details, applies your filters, and keeps the matching listings.
4. For `urls` and `listingKeys`, reads exactly the properties you provide.
5. When full details are enabled, attaches floor plans, units, fees, policies, schools, office hours, manager, website and photos.
6. De-duplicates by listing key and URL, removes empty fields, and saves the records.

No account, login, cookie or API key is required.

### Input

| Field | Type | Default | Description |
|---|---|---|---|
| `mode` | select | `search` | `search`, `urls` or `listingKeys` |
| `searchLocation` | string | – | US city and state (`New York, NY`) or ZIP (`10001`); used by `search` |
| `bedrooms` | select | `any` | `any`, `studio`, `1`, `2`, `3`, `4`, `5plus` |
| `bathrooms` | select | `any` | `any`, `1plus`, `2plus`, `3plus` |
| `priceMin` / `priceMax` | integer | – | Monthly rent range in USD (0–50,000) |
| `sqftMin` / `sqftMax` | integer | – | Floor-plan size range (0–20,000) |
| `propertyType` | select | `any` | `any`, `apartments`, `houses`, `condos`, `townhomes` |
| `petPolicy` | select | `any` | `any`, `dogs`, `cats`, `pets` |
| `amenities` | array | `[]` | 40 amenities, including pool, in-unit washer/dryer, parking, gym, elevator, dishwasher, air conditioning, balcony, furnished, gated, EV charging and more |
| `rentSpecials` | boolean | `false` | Only listings advertising a current move-in deal |
| `minRating` | select | `any` | `any`, `1`–`5` |
| `moveInDate` | string | – | Keep listings with a unit available on or before this date (`YYYY-MM-DD`) |
| `specialties` | array | `[]` | `student`, `senior`, `military`, `corporate`, `luxury`, `affordable`, `cheap` |
| `keywords` | string | – | Match name, description, amenities, neighborhood or floor-plan names (requires `scrapeDetails`) |
| `sortBy` | select | `relevance` | `relevance`, `priceAsc`, `priceDesc`, `bedsAsc`, `bedsDesc`, `newest` |
| `startUrls` | array | – | Search or property URLs for `urls`; plain listing keys are accepted too |
| `listingKeys` | array | – | Listing keys for `listingKeys` |
| `maximizeCoverage` | boolean | `false` | Try an additional coverage path when the public index cannot fill your request |
| `scrapeDetails` | boolean | `true` | Attach floor plans, units, fees, policies, schools, hours, manager, website and photos |
| `maxItems` | integer | `50` | Maximum records to return (1–5,000) |
| `maxPages` | integer | `5` | Search discovery depth, in 40-listing pages (1–20) |

#### Example: pet-friendly two-bedrooms under $2,500

```json
{
  "mode": "search",
  "searchLocation": "Austin, TX",
  "bedrooms": "2",
  "priceMax": 2500,
  "petPolicy": "dogs",
  "amenities": ["pool", "parking"],
  "maxItems": 50,
  "maxPages": 5,
  "scrapeDetails": true
}
```

#### Example: mixed URLs

```json
{
  "mode": "urls",
  "startUrls": [
    "https://www.apartments.com/austin-tx/2-bedrooms-under-2500/",
    "https://www.apartments.com/amli-river-north-chicago-il/1pc7xx7/"
  ],
  "maxItems": 20,
  "scrapeDetails": true
}
```

#### Example: known listing keys

```json
{
  "mode": "listingKeys",
  "listingKeys": ["d3pj6rk", "1pc7xx7", "lv3pbsf"],
  "maxItems": 10,
  "scrapeDetails": true
}
```

### Output

Every record is one property. Fields are omitted when the property does not publish them.

**Identity and place**

- `listingId`, `url`, `name`
- `address`, `fullAddress`, `city`, `state`, `zipCode`, `country`, `county`
- `neighborhood`, `submarket`, `marketName`, `dma`
- `latitude`, `longitude`
- `propertyType`, `listingType`, `listingStatus`

**Pricing**

- `priceMin`, `priceMax`, `priceCurrency`
- `baseRentMin`, `baseRentMax`
- `totalMonthlyPriceMin`, `totalMonthlyPriceMax`
- `rentText`
- `rentByBedType` — array of `{beds, priceMin, priceMax, priceText, baseRentMin, baseRentMax, totalMonthlyPriceMin, totalMonthlyPriceMax, sqftMin, sqftMax, availabilityDate}`
- `rentSpecial` — `{title, description, expiresAt}`
- `hasRentSpecials`

**Size and plans**

- `bedsMin`, `bedsMax`, `bathsMin`, `bathsMax`, `sqftMin`, `sqftMax`
- `floorPlans` — `{name, modelKey, beds, baths, sqftMin, sqftMax, rentMin, rentMax, totalMonthlyPriceMin, totalMonthlyPriceMax, unitCount, availableUnits, amenities}`
- `units` — the same floor-plan data in the legacy shape, with `bedsMin`/`bedsMax`/`bathsMin`/`bathsMax`/`rentMin`/`rentMax`/`sqftMin`/`sqftMax`
- `availableUnits` — `{unitKey, unitNumber, modelName, modelKey, beds, baths, sqft, rent, totalMonthlyPriceMin, totalMonthlyPriceMax, deposit, availableDate, availabilityText, leaseTerm, amenities, applyNowUrl}`

**Building and policies**

- `yearBuilt`, `unitCount`, `stories`, `lotSize`, `lotSizeUnit`
- `amenities`, `amenityCategories`, `uniqueFeatures`
- `petPolicies`, `parkingOptions`
- `fees` — `{oneTime[], monthly[], parking[], pets[], other[]}`, each fee with `name`, `amountMin`, `amountMax`, `amountText` or `period`
- `leaseTerms`, `officeHours`, `languagesSpoken`

**Contact, reputation and media**

- `phoneNumber`, `propertyWebsite`, `propertyManager` — `{name, companyKey, logoUrl}`
- `rating`
- `schools` — `{public[], private[]}`
- `photos`, `coverPhoto`, `photoCount`
- `availabilityDate`, `availabilityText`
- `description`
- `lastUpdated`, `scrapedAt`

The original 32 fields remain available. Walk, transit, bike and sound scores (`walkScore`, `transitScore`, `bikeScore`, `soundScore`) are kept for compatibility but are only filled when a source publishes them.

### Usage cost

This actor runs on Apify's platform and is billed by Apify compute usage for the time and memory the run consumes. There are no external API keys, subscriptions or per-record fees. A small run (one city, 10–50 listings, full details) usually finishes in under a minute; large runs scale with the number of listings and detail pages requested. Keep `maxItems` and `maxPages` at the smallest values that answer your question.

### FAQ

**Do I need an Apartments.com account?**
No. The actor reads publicly visible property information and needs no login, cookie or key.

**Why did I get fewer records than `maxItems`?**
Search mode also stops at the `maxPages` discovery depth. A narrow filter may need a higher `maxPages`; direct `urls` and `listingKeys` modes are not limited by search depth. The run status says when a request was cut short.

**Why are some fields missing for a property?**
Apartments.com does not publish every field for every property. Fees, pet rules, parking, office hours, schools, descriptions and photos are conditional. Missing values are omitted, never filled with placeholders.

**What is the difference between `priceMin` and `baseRentMin`?**
`priceMin`/`priceMax` are the rent range across the property's plans. Base rent and total monthly price are also reported separately because some communities add required monthly fees.

**What does `availableUnits` contain?**
Individual units the property is advertising, with unit number, rent, square feet, availability date and apply link. Not every property publishes individual units; many only publish floor-plan models.

**Does `scrapeDetails: false` still return useful data?**
Yes. It returns the property-level record (address, rent ranges, bedrooms, amenities, fees where published and similar fields) but skips the extra media/fee/unit enrichment. It is faster and cheaper.

**Are reviews or walk scores included?**
Reviews and walk/transit/bike/sound scores are not part of the public property data used here. The score fields are kept for backward compatibility but are normally absent.

**Can I use ZIP codes?**
Yes. A 5-digit US ZIP resolves to its city and is searched the same way as `City, ST`.

### Notes

- Search filters are applied to the listings returned by the public index, not to a private search API. Combining several narrow filters works best with a higher `maxPages`.
- URLs in `urls` mode can mix search pages and property pages; URL filters override the corresponding input filters.
- Listing keys are case-insensitive and validated before lookup.
- Records are de-duplicated by listing key and URL.
- `scrapedAt` is the time the record was produced; `lastUpdated` is the property's own freshness date when published.

### Limitations

- **US only.** Canadian provinces are not covered.
- **Public index coverage.** The site's public listing index is large but not a complete inventory of every unit. Major metros are well covered; very small towns may return few or no results. The run status reports a shortfall when this happens.
- **Search depth.** `maxPages` is capped at 20 (about 800 candidate listings). Use `listingKeys` or multiple URL runs when you need deeper coverage.
- **Conditional fields.** Fees, pet rules, parking, office hours, schools and individual units are published by the property, not by every listing.
- **Reviews, walkability scores, floor-plan images and virtual tours** are not exposed in the public property data. The legacy score fields remain reserved but are usually absent.
- **Photo hosting.** Photo URLs point to Apartments.com's image CDN. They load in browsers; some command-line clients may be refused by the CDN.
- **Coverage fallback.** `maximizeCoverage` adds an optional fallback path, but it can be unavailable or blocked. The actor then returns the direct results and explains the shortfall instead of failing.

# Actor input Schema

## `mode` (type: `string`):

How to find listings: `search` uses a city or ZIP plus filters; `urls` uses the Apartments.com URLs you paste; `listingKeys` looks up the listing keys you paste.

## `searchLocation` (type: `string`):

US city and state (`New York, NY`) or 5-digit ZIP (`10001`). Used only in search mode.

## `bedrooms` (type: `string`):

Match listings with at least one floor plan of this bedroom count.

## `bathrooms` (type: `string`):

Match listings with a floor plan at or above this bathroom count.

## `priceMin` (type: `integer`):

Lowest monthly rent to include. Leave unset for no minimum.

## `priceMax` (type: `integer`):

Highest monthly rent to include. Leave unset for no maximum.

## `sqftMin` (type: `integer`):

Smallest floor plan to include. Leave unset for no minimum.

## `sqftMax` (type: `integer`):

Largest floor plan to include. Leave unset for no maximum.

## `propertyType` (type: `string`):

Restrict results to one property type.

## `petPolicy` (type: `string`):

Require listings that allow dogs, cats, or both.

## `amenities` (type: `array`):

Only return listings that publish every selected amenity.

## `rentSpecials` (type: `boolean`):

Only return listings advertising a current move-in deal.

## `minRating` (type: `string`):

Only return listings rated at or above this score (1–5).

## `moveInDate` (type: `string`):

Only return listings with a unit available on or before this date (YYYY-MM-DD).

## `specialties` (type: `array`):

Return listings matching at least one selected lifestyle or housing program. Student and senior housing are the most consistently published; other values are applied when the source exposes them.

## `keywords` (type: `string`):

Keep listings whose name, description, amenities, neighborhood or floor-plan names contain this text. Requires scrapeDetails=true.

## `sortBy` (type: `string`):

How to order returned listings.

## `startUrls` (type: `array`):

Apartments.com city-search or property URLs. Used only in `urls` mode. A listing key is also accepted.

## `listingKeys` (type: `array`):

Apartments.com listing keys such as `d3pj6rk`. Used only in `listingKeys` mode.

## `maximizeCoverage` (type: `boolean`):

When the public listing index cannot fill your request, automatically try the site's search page as a last resort. Off by default.

## `scrapeDetails` (type: `boolean`):

Fetch floor plans, available units, fees, pets, parking, schools, office hours, manager, website and photos for each listing. Turn off for faster card-level results.

## `maxItems` (type: `integer`):

Maximum listings to return (1–5,000). Search mode also stops at the maxPages scan depth.

## `maxPages` (type: `integer`):

How many 40-listing discovery pages to scan in search mode (1–20). Raise it when filters are narrow.

## Actor input object example

```json
{
  "mode": "search",
  "searchLocation": "New York, NY",
  "bedrooms": "any",
  "bathrooms": "any",
  "propertyType": "any",
  "petPolicy": "any",
  "amenities": [],
  "rentSpecials": false,
  "minRating": "any",
  "specialties": [],
  "sortBy": "relevance",
  "maximizeCoverage": false,
  "scrapeDetails": true,
  "maxItems": 1,
  "maxPages": 1
}
```

# Actor output Schema

## `listings` (type: `string`):

Dataset containing the scraped Apartments.com properties.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "mode": "search",
    "searchLocation": "New York, NY",
    "bedrooms": "any",
    "bathrooms": "any",
    "propertyType": "any",
    "petPolicy": "any",
    "amenities": [],
    "rentSpecials": false,
    "minRating": "any",
    "specialties": [],
    "sortBy": "relevance",
    "maximizeCoverage": false,
    "scrapeDetails": true,
    "maxItems": 1,
    "maxPages": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("dataspryva/apartments-com-rental-listing-and-floor-plan").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "mode": "search",
    "searchLocation": "New York, NY",
    "bedrooms": "any",
    "bathrooms": "any",
    "propertyType": "any",
    "petPolicy": "any",
    "amenities": [],
    "rentSpecials": False,
    "minRating": "any",
    "specialties": [],
    "sortBy": "relevance",
    "maximizeCoverage": False,
    "scrapeDetails": True,
    "maxItems": 1,
    "maxPages": 1,
}

# Run the Actor and wait for it to finish
run = client.actor("dataspryva/apartments-com-rental-listing-and-floor-plan").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "mode": "search",
  "searchLocation": "New York, NY",
  "bedrooms": "any",
  "bathrooms": "any",
  "propertyType": "any",
  "petPolicy": "any",
  "amenities": [],
  "rentSpecials": false,
  "minRating": "any",
  "specialties": [],
  "sortBy": "relevance",
  "maximizeCoverage": false,
  "scrapeDetails": true,
  "maxItems": 1,
  "maxPages": 1
}' |
apify call dataspryva/apartments-com-rental-listing-and-floor-plan --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,dataspryva/apartments-com-rental-listing-and-floor-plan"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/uECeNxejUQFA2OJXF/builds/p6YkqUxP9rFhfClUk/openapi.json