# Apartments.com Scraper 🏡 (`epctex/apartments-scraper`) Actor
Scrape Apartments.com to crawl millions of real estate properties nationwide. Specify any US location and extract data on all available properties in that area. Our real estate scraper lets you filter and limit the results by page or total number. You can also target a specific property or area.
- **URL**: https://apify.com/epctex/apartments-scraper.md
- **Developed by:** [epctex](https://apify.com/epctex) (community)
- **Categories:** Travel, Real estate
- **Stats:** 1,022 total users, 17 monthly users, 100.0% runs succeeded, 38 bookmarks
- **User rating**: 5.00 out of 5 stars
## 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
## Actor - Apartments Scraper
> ### ⚠️ THIS ACTOR IS NO LONGER WORKING
>
> Due to new security protections on Apartments.com, this actor is currently not functional. Please use our new **[Apartments Scraper API](https://apify.com/epctex/apartments-scraper-api?fpr=yhdrb\&fp_sid=new)** which offers pay-per-event pricing — you only pay for what you get. No monthly subscriptions, no platform costs.
### Apartments scraper
Since Apartments doesn't provide a proper free API, this actor should help you to retrieve data from it.
The Apartments data scraper supports the following features:
- Scrape any address you would like to get - You can search for a specific location and scrape the results accordingly.
- Apply any of the filters - You can apply any filter provided by the website.
- Scrape property details - You can target any of the property detail links.
- Limit the results by page or amount of property. - If you don't want to get all the results but a specific amount you can limit it.
### Bugs, fixes, updates, and changelog
This scraper is under active development. If you have any feature requests you can create an issue from [here](https://github.com/epctex-support/apartments-scraper/issues).
#### Incoming Changes
- Integrate `startPage` field.
### Input Parameters
The input of this scraper should be JSON containing the list of pages on Apartments that should be visited. Possible fields are:
| Field | Type | Description |
| -------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
| startUrls | Array | (optional) List of Apartments URLs. You should only provide list or property detail URLs |
includeAllImages | Boolean | This option enables all images from the detail pages. This option will increase the total requests and the total execution time slightly. |
includeVirtualTours | Boolean | This option enables virtual tours from the detail pages. This option will increase the total requests and the total execution time slightly. |
| maxItems | Integer | (optional) You can limit scraped properties. This should be useful when you search through the big lists. |
| endPage | Integer | (optional) Final number of pages that you want to scrape. The default is `Infinite`. |
| search | String | (optional) Location keyword that you would like to search the properties in. |
| proxy | Object | Proxy configuration |
| extendOutputFunction | String | (optional) Function that takes a JQuery handle ($) as argument and returns object with data |
This solution requires the use of **Proxy servers**, either your own proxy servers or you can use Apify Proxy.
#### Tip
When you want to scrape over a specific listing URL, just copy and paste the link as one of the **startUrl**.
If you would like to scrape only the first page of a list then put the link for the page and have the `endPage` as 1.
With the last approach explained above you can also apply any of the filters to the search results. Go to Apartments.com, search for a location, apply filters, and copy/paste the link as **startUrl**.
#### Compute Unit Consumption
The actor is optimized to run blazing fast and scrape many as listings as possible. Therefore, it forefronts all listing detail requests. If the actor doesn't block very often it'll scrape 100 listings in 1 minute with ~0.03-0.04 compute units.
#### Apartments Scraper Input example
```json
{
"startUrls": [
"https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
"https://www.apartments.com/apartments/miami-fl/student-housing/",
"https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oB"
],
"search": "new york",
"proxy": {
"useApifyProxy": true
},
"endPage": 1,
"maxItems": 100
}
```
### During the Run
During the run, the actor will output messages letting you know what is going on. Each message always contains a short label specifying which page from the provided list is currently specified.
When items are loaded from the page, you should see a message about this event with a loaded item count and total item count for each page.
If you provide incorrect input to the actor, it will immediately stop with a failure state and output an explanation of what is wrong.
### Apartments Export
During the run, the actor stores results into a dataset. Each item is a separate item in the dataset.
You can manage the results in any language (Python, PHP, Node JS/NPM). See the FAQ or our API reference to learn more about getting results from this Apartments actor.
### Scraped Apartments Properties
The structure of each item in Apartments listings looks like this:
\###Property Output
```json
{
"id": "26xc7jb",
"propertyName": "SoBe Apartment Rentals",
"url": "https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb",
"breadcrumbs": [
"Home",
"Florida",
"Miami Beach",
"SoBe Apartment Rentals"
],
"location": {
"fullAddress": "907-911 Euclid Ave Miami Beach FL 33139",
"state": "Florida",
"city": "Miami Beach",
"neighborhood": "Flamingo",
"postalCode": "33139",
"streedAddress": "907-911 Euclid Ave"
},
"coordinates": {
"latitude": 25.77973,
"longitude": -80.13479
},
"rating": null,
"isVerified": true,
"rent": {
"min": 1100,
"max": 1750
},
"beds": "Studio - 2 bd",
"baths": "1 - 2 ba",
"sqft": "550 - 1,250 sq ft",
"transportation": [
{
"name": "Adrienne Arsht Center",
"url": "https://www.apartments.com/transit/fl/miami/adrienne-arsht-center/3rrs8kg/",
"drive": "9 min",
"distance": "4.5 mi"
},
{
"name": "Freedom Tower",
"url": "https://www.apartments.com/transit/fl/miami/freedom-tower/n4bgwwm/",
"drive": "10 min",
"distance": "4.8 mi"
}
],
"poi": [
{
"name": "Washington Ave Properties",
"url": "https://www.apartments.com/malls/fl/miami-beach/washington-ave-properties/94elct5/",
"walk": "5 min",
"distance": "0.3 mi"
},
{
"name": "Park on Fifth’s",
"url": "https://www.apartments.com/malls/fl/miami-beach/park-on-fifths/ct6dvmf/",
"walk": "12 min",
"distance": "0.6 mi"
}
],
"transitAndPOI": [
{
"name": "Adrienne Arsht Center",
"url": "https://www.apartments.com/transit/fl/miami/adrienne-arsht-center/3rrs8kg/",
"drive": "9 min",
"distance": "4.5 mi"
},
{
"name": "Freedom Tower",
"url": "https://www.apartments.com/transit/fl/miami/freedom-tower/n4bgwwm/",
"drive": "10 min",
"distance": "4.8 mi"
}
],
"scores": {
"walkScore": 95,
"transitScore": 53
},
"neighborhoodDescription": "Flamingo, also known as Flamingo/Lummus, is a vibrant neighborhood situated right in the heart of South Beach. Residents enjoy easy beach access along with plenty of exceptional restaurants, bars, museums, art galleries, shops, and the famous Art Deco Historic District. Flamingo is also adjacent to fantastic shopping on Lincoln Road.\n Aside from its many exciting metropolitan amenities, Flamingo offers two lush parks for residents and visitors alike to enjoy—Flamingo Park and Lummus Park. Flamingo’s prime location sits within countless additional attractions in the rest of Miami Beach as well as Downtown Miami, Brickell, and Wynwood. Getting around from Flamingo is simple with convenience to the MacArthur Causeway and I-195.\n \n \n Learn More About Flamingo",
"schools": {
"public": [
{
"type": "Public Elementary & Middle School",
"name": "Fienberg/Fisher K-8 Center",
"grades": "PK-8",
"numberOfStudents": "869"
},
{
"type": "Public Middle School",
"name": "Nautilus Middle School",
"grades": "6-8",
"numberOfStudents": "1,032"
},
{
"type": "Public High School",
"name": "Miami Beach Senior High School",
"grades": "9-12",
"numberOfStudents": "2,340"
}
],
"private": [
{
"type": "Private Elementary, Middle & High School",
"name": "Landow Yeshiva Center",
"grades": "PK-12",
"numberOfStudents": ""
},
{
"type": "Private Middle & High School",
"name": "Congregation Beth Medrash Levi",
"grades": "7-12",
"numberOfStudents": "90"
}
],
"colleges": [
{
"name": "AI Miami International University of Art and Design",
"drive": "AI Miami International University of Art and Design",
"distance": "4.6 mi"
},
{
"name": "Miami Dade College",
"drive": "Miami Dade College",
"distance": "5.4 mi"
},
{
"name": "University of Miami",
"drive": "University of Miami",
"distance": "11.5 mi"
}
]
},
"fees": [
{
"title": "Pet Policies (Pets Negotiable)",
"policies": [
{
"header": "Dogs Allowed",
"values": [
{
"key": "Weight limit",
"value": "40 lb"
},
{
"key": "Pet interview",
"value": "Not required"
},
{
"key": "Spayed/Neutered",
"value": "Not required"
},
{
"key": "Declawed",
"value": "Not required"
},
{
"key": "One time Fee",
"value": "$250"
}
]
},
{
"header": "Cats Allowed",
"values": [
{
"key": "Pet interview",
"value": "Not required"
},
{
"key": "Spayed/Neutered",
"value": "Not required"
},
{
"key": "Declawed",
"value": "Required"
},
{
"key": "One time Fee",
"value": "$250"
}
]
}
]
},
{
"title": "Fees",
"policies": [
{
"header": "Parking",
"values": [
{
"key": "Street",
"value": ""
}
]
},
{
"header": "Other Fees",
"values": [
{
"key": "Application Fee",
"value": "$100"
}
]
}
]
},
{
"title": "Details",
"policies": [
{
"header": "Utilities Included",
"values": [
{
"key": "Gas",
"value": ""
},
{
"key": "Water",
"value": ""
},
{
"key": "Trash Removal",
"value": ""
},
{
"key": "Sewer",
"value": ""
}
]
},
{
"header": "Property Information",
"values": [
{
"key": "Built in 1936",
"value": ""
},
{
"key": "16 units/2 stories",
"value": ""
},
{
"key": "Furnished",
"value": ""
}
]
}
]
}
],
"description": "About SoBe Apartment Rentals\n Welcome to South Beach Rental Apartments, where you can find an affordable luxury apartment. Our leasing specialists will show you a variety of apartments in your price range. We have full service buildings with full service amenities. We accept pets. We will work with all credit situations. Let South Beach Rental Apartments find your new home and make your move a more pleasurable experience. *Prices Subject to Change Based on Availability*\n\n SoBe Apartment Rentals is an apartment located in Miami/Dade County, the 33139 ZIP Code, and the Miami-Dade attendance zone.",
"amenities": [
{
"title": "Community Amenities",
"value": [
"Pool",
"Fitness Center",
"Laundry Facilities",
"Furnished Units Available",
"Laundry Facilities",
"Maintenance on site",
"Furnished Units Available",
"Elevator",
"Fitness Center",
"Pool",
"Gated",
"Sundeck",
"Grill",
"Picnic Area"
]
},
{
"title": "Apartment Features",
"value": [
"Air Conditioning",
"Dishwasher",
"High Speed Internet Access",
"Hardwood Floors",
"High Speed Internet Access",
"Air Conditioning",
"Heating",
"Ceiling Fans",
"Tub/Shower",
"Dishwasher",
"Kitchen",
"Range",
"Refrigerator",
"Hardwood Floors",
"Tile Floors",
"Den",
"Walk-In Closets",
"Balcony",
"Yard",
"Garden"
]
}
],
"contact": {
"phone": "+1-786-623-5446",
"logo": "https://images1.apartments.com/i2/MzLghRW57B06n9LwsCwa86cNW9bM-0BifS3NxF7_nxs/115/renters-paradise-realty-inc-logo.jpg",
"name": ""
},
"models": [
{
"modelName": "Studio",
"rentLabel": "$1,100 – $1,200",
"details": [
"Studio",
"1 bath",
"550 sq ft",
"$1,200 deposit"
],
"leaseOptions": "$1,200 deposit",
"availability": "1 Available unit",
"units": [
{
"type": "Unit 10",
"price": "$1,100",
"sqft": "550",
"availability": "Soon"
}
]
},
{
"modelName": "1 Bed/1 Bath",
"rentLabel": "$1,200 – $1,300",
"details": [
"1 bed",
"1 bath",
"685 – 875 sq ft",
"12 Month Lease",
"Available Soon"
],
"leaseOptions": "12 Month Lease,\n\t\t\t\t\t\t\t\tAvailable Soon",
"availability": "",
"units": []
},
{
"modelName": "1 Bed/1 Bath",
"rentLabel": "$1,300",
"details": [
"1 bed",
"1 bath",
"700 sq ft",
"$1,300 deposit"
],
"leaseOptions": "$1,300 deposit",
"availability": "1 Available unit",
"units": [
{
"type": "Unit 9",
"price": "$1,300",
"sqft": "700",
"availability": "Soon"
}
]
},
{
"modelName": "2 Bed/2 Bath",
"rentLabel": "$1,600 – $1,750",
"details": [
"2 beds",
"2 baths",
"1,100 – 1,250 sq ft",
"12 Month Lease",
"Available Soon"
],
"leaseOptions": "12 Month Lease,\n\t\t\t\t\t\t\t\tAvailable Soon",
"availability": "",
"units": []
}
],
"scrapedAt": "2021-11-27T12:04:06.752Z",
"photos": [
"https://images1.apartments.com/i2/cS0Cu8ytY9zn8aI0V3DcsPiSca-7KgPPd-tOowXs5Uw/111/sobe-apartment-rentals-miami-beach-fl-primary-photo.jpg?p=1",
"https://images1.apartments.com/m2/ogrZ5C9tUeyJJw1Rg_NLfNm3O6sorfEMC1OyLLDgLko/H330W495/sobe-apartment-rentals-miami-beach-fl-map-image-of-the-property.jpg?p=1",
"https://images1.apartments.com/i2/xhlEsuSaTc0Oc7ZA8jNyLrpMwmkgkgE3jW9WzfJJ0bM/117/sobe-apartment-rentals-miami-beach-fl-building.jpg?p=1",
"https://images1.apartments.com/i2/PGbG-MlQgqD0TytUnv7fuU0nlSDJJqx8_-MoePj0CcA/117/sobe-apartment-rentals-miami-beach-fl-bedroom.jpg?p=1",
"https://images1.apartments.com/i2/DG2gCa0vZy9JTfjuvPmv23hFqCIVh-iEYiQyd5vxpx8/117/sobe-apartment-rentals-miami-beach-fl-bedroom.jpg?p=1"
]
}
```
### Contact
Please visit us through [epctex.com](https://epctex.com) to see all the products that are available for you. If you are looking for any custom integration or so, please reach out to us through the chat box in [epctex.com](https://epctex.com). In need of support? is at your service.
# Actor input Schema
## `startUrls` (type: `array`):
URLs to start with. It should be listing or property detail URLs
## `includeVirtualTours` (type: `boolean`):
This option enables virtual tours from the detail pages. This option will increase the total requests and the total execution time slightly.
## `maxItems` (type: `integer`):
Maximum number of properties that you want as output. Default is all
## `endPage` (type: `integer`):
The page number that you want to end with. By default there is no end page.
## `search` (type: `string`):
Term for search on apartments.com
## `extendOutputFunction` (type: `string`):
Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output
## `proxy` (type: `object`):
Select proxies to be used by your crawler.
## Actor input object example
```json
{
"startUrls": [
"https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
"https://www.apartments.com/apartments/miami-fl/student-housing/",
"https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oB"
],
"includeVirtualTours": false,
"maxItems": 50,
"endPage": 100,
"extendOutputFunction": "($) => { return {} }",
"proxy": {
"useApifyProxy": true
}
}
```
# 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/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
"https://www.apartments.com/apartments/miami-fl/student-housing/",
"https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oB"
],
"maxItems": 50,
"endPage": 100,
"extendOutputFunction": ($) => { return {} },
"proxy": {
"useApifyProxy": true
}
};
// Run the Actor and wait for it to finish
const run = await client.actor("epctex/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/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
"https://www.apartments.com/apartments/miami-fl/student-housing/",
"https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oB",
],
"maxItems": 50,
"endPage": 100,
"extendOutputFunction": "($) => { return {} }",
"proxy": { "useApifyProxy": True },
}
# Run the Actor and wait for it to finish
run = client.actor("epctex/apartments-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/sobe-apartment-rentals-miami-beach-fl/26xc7jb/",
"https://www.apartments.com/apartments/miami-fl/student-housing/",
"https://www.apartments.com/?sk=544b92fe1f766950d57299dc624e9ff9&bb=0nijpwq7qH0t1s0oB"
],
"maxItems": 50,
"endPage": 100,
"extendOutputFunction": "($) => { return {} }",
"proxy": {
"useApifyProxy": true
}
}' |
apify call epctex/apartments-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"type": "http",
"url": "https://mcp.apify.com/?tools=fetch-actor-details,epctex/apartments-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 ` 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/0mFoOGFw7K4hp1v0f/builds/pSbrYuGZHgNHHt7OJ/openapi.json