# Apartment List Scraper (`crawlerbros/apartment-list-scraper`) Actor

Scrape Apartment List - the US apartment rental marketplace. Browse by city and state, or fetch specific listings; get price, beds, baths, amenities, photos, and location data per building.

- **URL**: https://apify.com/crawlerbros/apartment-list-scraper.md
- **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community)
- **Categories:** Real estate, Automation, Lead generation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 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/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Apartment List Scraper

Scrape **Apartment List** — one of the largest US apartment rental marketplaces with millions of rentable units. Browse apartment buildings by city and state, or fetch specific listings by URL, and get rent, beds, baths, amenities, photos, and location data per building. No login, no API key.

### What this actor does

- **Two modes:** `search` (default) and `byUrl`
- **51 state dropdowns** — every US state plus Washington, DC
- **41 popular city dropdowns** — with a free-text override for any city slug
- **Filters:** bedrooms (studio–5+), rent range, pet-friendly buildings only
- **Rich listing data:** rents per bedroom count, addresses, neighborhoods, amenity lists, photo galleries, management company, phone, and more
- **Detail enrichment:** `mode=byUrl` adds available units (bed/bath/sqft/price), lease terms, pet policies, fees, and virtual tours
- **Empty fields are omitted**

### Output per listing

Browse records (`mode = search`) include:

- `rentalId` — Apartment List's building ID
- `name` — building name
- `streetAddress`, `neighborhood`, `zip`, `city`, `county`, `state`, `formattedAddress`
- `lat`, `lon` — building coordinates
- `prices` — cheapest rent per bedroom count (e.g. `{"0": 1800, "1": 2100}`)
- `minPrice`, `bedroomsAvailable[]`
- `bath`, `rentalType`, `yearBuilt`, `yearRemodeled`
- `topAmenities[]`, `unitAmenities[]`, `communityAmenities[]`
- `utilitiesIncluded` — e.g. "Cable, Electric, Gas, Hot Water…"
- `photoUrls[]`, `imageUrl` — photo gallery
- `specials[]` — active offers
- `managementCompany`, `brokerageName`, `sourceName`, `phone`, `mlsNumber`
- `listingUrl`, `sourceUrl` — canonical listing URL
- `recordType: "listing"`, `scrapedAt`

Detail records (`mode = byUrl`) additionally include:

- `availableUnits[]` — per-unit `name`, `bed`, `bath`, `sqft`, `price`
- `leaseTerms`, `incomeRequirement`, `additionalFees`, `applicationFee`, `moveInFees`, `depositFee`
- `petPolicies[]`, `parkingDetails`, `storageDetails`, `occupancyTypes`
- `websiteUrl`, `sourceListingUrl` — operator's own site

### Input

| Field | Type | Default | Description |
|---|---|---|---|
| `mode` | string | `search` | `search` / `byUrl` |
| `state` | string | `ca` | US state (mode=search) |
| `city` | string | `san-francisco` | Popular city slug (mode=search) |
| `cityOverride` | string | – | Any city slug, takes precedence over `city` |
| `urls` | array | – | Listing URLs (mode=byUrl) |
| `beds` | string | `""` (any) | Bedroom-size filter (mode=search): `""` any, `"0"` studio, `"1"`–`"4"`, `"5"` = 5+; only buildings whose available bedroom set includes the value are kept |
| `priceMin` | int | – | Min rent in USD |
| `priceMax` | int | – | Max rent in USD |
| `petFriendly` | boolean | `false` | Pet-friendly buildings only |
| `maxItems` | int | `50` | Hard cap (1–500) |
| `proxyConfiguration` | object | Apify AUTO | Optional; engaged only if geo-blocked |

#### Example: browse a city with filters

```json
{
  "mode": "search",
  "state": "ca",
  "city": "san-francisco",
  "beds": "2",
  "priceMax": 4000,
  "petFriendly": true,
  "maxItems": 30
}
```

#### Example: any city via override

```json
{
  "mode": "search",
  "state": "tx",
  "cityOverride": "fort-lauderdale",
  "maxItems": 20
}
```

#### Example: fetch specific listings

```json
{
  "mode": "byUrl",
  "urls": [
    "https://www.apartmentlist.com/ca/san-francisco/1405-franklin"
  ]
}
```

### Use cases

- **Rental market research** — track asking rents per bedroom across cities and neighborhoods
- **Property analytics** — compare amenity sets, pet policies, and pricing between buildings
- **Rental search products** — power apartment-search UIs with live building data
- **Relocation tools** — inventory of buildings with photos and contact details per city
- **Proptech lead generation** — management company + phone data for outreach

### FAQ

**Is a proxy required?**
Apartment List geo-gates traffic from outside the US. The actor first tries a direct connection; if it gets blocked (403), it automatically retries through the free Apify AUTO datacenter proxy. Enable `proxyConfiguration` if you still see 0 results.

**What is `prices` on each record?**
A map of the cheapest advertised rent per bedroom count — `{"1": 2100}` means a 1-bedroom unit starts at $2,100/month. `minPrice` is the cheapest unit of any size.

**Why are some fields only on detail records?**
Fields like available units, lease terms, and pet policies only exist on a building's own page. Browse results carry the essentials; use `mode=byUrl` (or open any `listingUrl`) for the full profile. The actor deliberately does not fetch every detail page while browsing to keep runs fast.

**What currency are rents in?**
USD, per month.

**Does this actor use Apartment List's API?**
No. It reads the same data the public website renders, including the JSON payload the site itself embeds in its pages.

**Is this actor affiliated with Apartment List?**
No. This is a third-party actor using publicly visible pages.

# Actor input Schema

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

How to find listings.

## `state` (type: `string`):

US state for the city search (mode=search).

## `city` (type: `string`):

Popular US city to browse (mode=search). Use `cityOverride` for any other city slug.

## `cityOverride` (type: `string`):

Any Apartment List city slug, e.g. `san-ramon`, `fort-lauderdale`. Takes precedence over `city` (mode=search).

## `urls` (type: `array`):

Full apartmentlist.com listing URLs, e.g. `https://www.apartmentlist.com/ca/san-francisco/1405-franklin`.

## `beds` (type: `string`):

Only keep buildings with units of this size. Defaults to any size.

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

Only keep buildings whose cheapest unit is at or above this rent.

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

Only keep buildings whose cheapest unit is at or below this rent.

## `petFriendly` (type: `boolean`):

Only keep buildings that allow pets.

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

Hard cap on emitted records.

## `proxyConfiguration` (type: `object`):

Optional Apify proxy. Apartment List geo-gates non-US traffic; the actor tries direct access first and engages the (free) AUTO datacenter proxy automatically when blocked.

## Actor input object example

```json
{
  "mode": "search",
  "state": "ca",
  "city": "san-francisco",
  "urls": [],
  "beds": "",
  "petFriendly": false,
  "maxItems": 50,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# Actor output Schema

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

Dataset containing all scraped Apartment List listings.

# 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",
    "state": "ca",
    "city": "san-francisco",
    "urls": [],
    "beds": "",
    "petFriendly": false,
    "maxItems": 50,
    "proxyConfiguration": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("crawlerbros/apartment-list-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 = {
    "mode": "search",
    "state": "ca",
    "city": "san-francisco",
    "urls": [],
    "beds": "",
    "petFriendly": False,
    "maxItems": 50,
    "proxyConfiguration": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("crawlerbros/apartment-list-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).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",
  "state": "ca",
  "city": "san-francisco",
  "urls": [],
  "beds": "",
  "petFriendly": false,
  "maxItems": 50,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}' |
apify call crawlerbros/apartment-list-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=crawlerbros/apartment-list-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

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