# Apartments.com Rental Scraper (`crawlerbros/apartments-scraper`) Actor Extract apartment rental listings from Apartments.com including property name, address, rent range, beds/baths, sqft, amenities, neighborhood, walk/transit scores, and more. - **URL**: https://apify.com/crawlerbros/apartments-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Real estate, Automation, Developer tools - **Stats:** 4 total users, 3 monthly users, 75.0% runs succeeded, 15 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing from $5.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 a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## Apartments.com Rental Scraper Extract apartment rental listings from **Apartments.com** — property name, address, rent range, beds/baths, sqft, amenities, location, photos, and more. Uses Camoufox (anti-detect Firefox) with US residential proxy to bypass Akamai bot protection. ### Features - **22 output fields** per property - **Supports city listings** (e.g., `/miami-fl/`) and direct property URLs - **Latitude/longitude** — geographic coordinates - **Rent range** — min/max parsed from text - **Beds, baths, sqft** — apartment size info - **Amenities** — full amenity list - **Photo URLs** — property images - **US RESIDENTIAL proxy hardcoded** — Apartments.com is Akamai-protected - **No nulls** — every field has a typed default ### Input | Field | Type | Description | |---|---|---| | `startUrls` | Array | Apartments.com URLs (city listing or property detail) | | `maxItems` | Integer | Max properties to scrape (default 20) | #### Example Input ```json { "startUrls": [ "https://www.apartments.com/miami-fl/", "https://www.apartments.com/los-angeles-ca/" ], "maxItems": 50 } ```` ### Output Each property has **22 fields**: | Field | Type | Description | |---|---|---| | `id` | String | Apartments.com property ID | | `propertyName` | String | Property name | | `url` | String | Property URL | | `fullAddress` | String | Complete address | | `streetAddress` | String | Street address | | `city` | String | City | | `state` | String | State code | | `neighborhood` | String | Neighborhood | | `postalCode` | String | ZIP code | | `latitude` | Number | Latitude | | `longitude` | Number | Longitude | | `rentMin` | Integer | Minimum monthly rent | | `rentMax` | Integer | Maximum monthly rent | | `beds` | String | Beds range (e.g., "Studio - 2 bd") | | `baths` | String | Baths range | | `sqft` | String | Square footage range | | `isVerified` | Boolean | Verified listing flag | | `rating` | Number | Aggregate rating (0-5) | | `phoneNumber` | String | Leasing office phone | | `amenities` | Array | Amenity list | | `photoUrls` | Array | Property image URLs | | `scrapedAt` | String | ISO 8601 scrape timestamp | ### FAQ **Q: Why does this need US RESIDENTIAL proxy?** Apartments.com is protected by Akamai Bot Manager which blocks all datacenter IPs and non-browser clients. Camoufox (anti-detect Firefox) combined with residential proxy is required. Both are hardcoded — no configuration needed. **Q: How fresh is the data?** Real-time — the scraper fetches pages live from Apartments.com on each run. **Q: Can I filter by price or beds?** Yes — use Apartments.com URL filters like `/miami-fl/2-bedrooms-under-2000/` as your start URL. ### Use Cases - **Rental market research** — track rents across cities - **Competitive analysis** — compare property amenities and pricing - **Relocation planning** — find apartments matching specific criteria - **Data aggregation** — build rental databases # Actor input Schema ## `startUrls` (type: `array`): Apartments.com city listings or property detail URLs (e.g., https://www.apartments.com/miami-fl/). ## `maxItems` (type: `integer`): Maximum number of properties to scrape. ## Actor input object example ```json { "startUrls": [ "https://www.apartments.com/miami-fl/" ], "maxItems": 3 } ``` # Actor output Schema ## `properties` (type: `string`): No description # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrls": [ "https://www.apartments.com/miami-fl/" ], "maxItems": 3 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/apartments-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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrls": ["https://www.apartments.com/miami-fl/"], "maxItems": 3, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/apartments-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 '{ "startUrls": [ "https://www.apartments.com/miami-fl/" ], "maxItems": 3 }' | apify call crawlerbros/apartments-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/apartments-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Apartments.com Rental Scraper", "description": "Extract apartment rental listings from Apartments.com including property name, address, rent range, beds/baths, sqft, amenities, neighborhood, walk/transit scores, and more.", "version": "1.0", "x-build-id": "onmVcbBR5ocFFppdq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~apartments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-apartments-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~apartments-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-apartments-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~apartments-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-apartments-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Apartments.com city listings or property detail URLs (e.g., https://www.apartments.com/miami-fl/).", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum number of properties to scrape.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```