# Apartments.com Scraper (`datascoutapi/apartments-com-scraper`) Actor

Scrape millions of active U.S. & Canada rental listings from Apartments.com & ApartmentList.com – any city, state, province, ZIP, or neighborhood. Full details: pricing, photos, amenities, exact coordinates, contact info. Blazing-fast, anti-block, full North America coverage.

- **URL**: https://apify.com/datascoutapi/apartments-com-scraper.md
- **Developed by:** [halam](https://apify.com/datascoutapi) (community)
- **Categories:** Real estate, MCP servers, Lead generation
- **Features:** Limited permissions
- **Stats:** 16 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

## 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 Scraper US, Canada, Search, Listing

A fast and reliable scraper for extracting apartment listings from Apartments.com and ApartmentList.com. This actor uses a high-performance API backend to deliver comprehensive property data quickly and efficiently.

### Features

- **Multiple URL Support** - Scrape city searches, filtered results, and individual property pages
- **Fast Performance** - Powered by optimized scraping API for quick results
- **Comprehensive Data** - Get detailed property information including amenities, pricing, location data, and photos
- **No Blocking Issues** - Uses advanced techniques to avoid rate limiting and blocking

### URL Support & Coverage

This scraper supports all major apartment listing URL formats across both platforms:

| URL Type | Platform | Example |
|----------|----------|---------|
| **City Search** | Apartments.com | `https://www.apartments.com/miami-fl/` |
| **Filtered Results** | Apartments.com | `https://www.apartments.com/?bb=v565-usgtHyl5o6vY` |
| **Advanced Search** | Apartments.com | `https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc` |
| **Property Details** | Apartments.com | `https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/` |
| **Bedroom Filter** | Apartments.com | `https://www.apartments.com/miami-beach-fl/4-bedrooms/` |
| **City Listings** | ApartmentList.com | `https://www.apartmentlist.com/tx/frisco/` |
| **Property Pages** | ApartmentList.com | `https://www.apartmentlist.com/tx/frisco/sorrel-phillips-creek-ranch` |

#### Supported Search Parameters

- **bb=** - Bounding box search results
- **sk=** - Search key with location data
- **City filters** - State/city combinations (e.g., miami-fl, dallas-tx)
- **Bedroom filters** - Specific bedroom counts (1-bedrooms, 4-bedrooms, etc.)
- **Property IDs** - Direct property page access

### Input Parameters

| Field | Type | Description |
|-------|------|-------------|
| startUrls | Array | List of apartment URLs to scrape. Supports all URL types mentioned above |

### Input Example

```json
{
  "startUrls": [
    {"url": "https://www.apartments.com/miami-fl/"},
    {"url": "https://www.apartments.com/?bb=v565-usgtHyl5o6vY"},
    {"url": "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/"},
    {"url": "https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc"},
    {"url": "https://www.apartments.com/miami-beach-fl/4-bedrooms/"},
    {"url": "https://www.apartmentlist.com/tx/frisco/"},
    {"url": "https://www.apartmentlist.com/tx/frisco/sorrel-phillips-creek-ranch"}
  ]
}
```

### Output Data

Each scraped property includes comprehensive information across these key fields:

- **id**: Unique identifier for the apartment listing
- **propertyName**: Name or title of the apartment property
- **url**: Direct URL to the apartment listing
- **address**: Complete street address of the property
- **location**: Full address details with coordinates and neighborhood information
- **pricing**: Rent ranges with minimum and maximum values
- **amenities**: Community and apartment features like pools, fitness centers, parking
- **phone**: Contact phone number for inquiries
- **contact**: Management company details and contact information
- **imageUrl**: Primary property image URL
- **photos**: Array of all property images and virtual tour links
- **transitAndPOI**: Nearby transportation options and points of interest
- **scores**: Walkability and transit accessibility ratings
- **schools**: Public, private schools and colleges in the area
- **breadcrumbs**: Location hierarchy (State → County → City → Neighborhood)
- **coordinates**: GPS latitude and longitude coordinates
- **neighborhoodDescription**: Detailed area overview and highlights
- **scrapedAt**: Timestamp of when the data was collected

### Sample Output

The scraper returns comprehensive apartment data in JSON format. Here's an example of what you can expect:

```json
[
  {
    "id": "sobe001",
    "propertyName": "Ocean View Residences",
    "url": "https://www.apartments.com/?bb=v565-usgtHyl5o6vY",
    "breadcrumbs": [
      "Florida",
      "Miami/Dade County", 
      "Miami Beach",
      "South Beach"
    ],
    "location": {
      "fullAddress": "800 Ocean Dr, Miami Beach, FL 33139",
      "state": "FL",
      "city": "Miami Beach",
      "neighborhood": "South Beach",
      "postalCode": "33139",
      "streetAddress": "800 Ocean Dr"
    },
    "coordinates": {
      "latitude": 25.7617,
      "longitude": -80.1918
    },
    "isVerified": true,
    "rent": {
      "min": 1800,
      "max": 2800
    },
    "transitAndPOI": [
      {
        "name": "Lincoln Road Mall",
        "walk": "3 min",
        "distance": "0.2 mi"
      },
      {
        "name": "Miami Beach Convention Center", 
        "drive": "5 min",
        "distance": "1.1 mi"
      }
    ],
    "scores": {
      "walkScore": 85,
      "transitScore": 60
    },
    "neighborhoodDescription": "South Beach is known for its vibrant nightlife, beautiful beaches, and Art Deco architecture...",
    "schools": {
      "public": [
        {
          "type": "Public High School",
          "name": "Miami Beach Senior High",
          "grades": "9-12",
          "numberOfStudents": "2175"
        }
      ],
      "private": [],
      "colleges": []
    },
    "amenities": [
      {
        "title": "Community Amenities",
        "value": ["Pool", "Fitness Center", "Rooftop Deck", "Concierge"]
      },
      {
        "title": "Apartment Features", 
        "value": ["Air Conditioning", "Hardwood Floors", "Balcony"]
      }
    ],
    "contact": {
      "phone": "",
      "logo": "",
      "name": ""
    },
    "models": [],
    "scrapedAt": "2025-12-01T00:08:39.132Z",
    "photos": [
      "https://images1.apartments.com/i2/J0qjpyRz9Acb6IOM0TIt5SEfVnPYIslQrUwHLDoEuvE/111/sobe-apartment-rentals-miami-beach-fl-primary-photo.jpg"
    ]
  }
]
```

### Performance

- **Speed**: Optimized for fast execution with minimal overhead
- **Reliability**: Built-in error handling and retry mechanisms
- **Scalability**: Can handle multiple URLs simultaneously

### Usage Tips

1. **For City Searches**: Use URLs like `https://www.apartments.com/miami-fl/` to get listings for entire cities
2. **For Specific Properties**: Use direct property URLs for detailed information
3. **For Filtered Results**: Apply filters on the website first, then copy the URL with parameters
4. **Batch Processing**: Add multiple URLs to scrape several locations at once

### 📬 Contact & Support

Have questions, need help, or interested in a private or custom instance?

Reach our team anytime at **datascoutapi@gmail.com**

# Actor input Schema

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

One or more URLs of apartment listings to scrape

## Actor input object example

```json
{
  "startUrls": [
    "https://www.apartments.com/miami-fl/",
    "https://www.apartments.com/?bb=v565-usgtHyl5o6vY",
    "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
    "https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc"
  ]
}
```

# Actor output Schema

## `results` (type: `string`):

Complete apartment data with pricing, location, amenities, and contact information

# 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 = {
    "startUrls": [
        "https://www.apartments.com/miami-fl/",
        "https://www.apartments.com/?bb=v565-usgtHyl5o6vY",
        "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
        "https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("datascoutapi/apartments-com-scraper").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 = { "startUrls": [
        "https://www.apartments.com/miami-fl/",
        "https://www.apartments.com/?bb=v565-usgtHyl5o6vY",
        "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
        "https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("datascoutapi/apartments-com-scraper").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 '{
  "startUrls": [
    "https://www.apartments.com/miami-fl/",
    "https://www.apartments.com/?bb=v565-usgtHyl5o6vY",
    "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
    "https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oc"
  ]
}' |
apify call datascoutapi/apartments-com-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,datascoutapi/apartments-com-scraper"
        }
    }
}
```

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/GuTLbn8lde8iO3zbs/builds/RFMLlvxcMFpBd4aez/openapi.json