# ApartmentFinder Scraper (`shahidirfan/apartmentfinder-scraper`) Actor Scrape rental listings from ApartmentFinder with prices, locations, bedrooms, amenities & landlord contact info. Perfect for rental market analysis, price intelligence, investment due diligence, competitor monitoring & real estate datasets. Structured JSON output. - **URL**: https://apify.com/shahidirfan/apartmentfinder-scraper.md - **Developed by:** [Shahid Irfan](https://apify.com/shahidirfan) (community) - **Categories:** Real estate, Automation, Developer tools - **Stats:** 2 total users, 1 monthly users, 60.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/platform/actors/running/actors-in-store#pay-per-usage ## 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## ApartmentFinder Scraper Extract apartment and home rental listings from ApartmentFinder.com. Collect property names, rents, addresses, deals, and photos across cities, neighborhoods, and amenity filters. Perfect for renters comparing options, real estate research, and ongoing market monitoring. ### Features - **City and state search** - Enter a location like "Washington, DC" or "Los Angeles, CA" and collect every matching community. - **Neighborhood and amenity filters** - Scrape niche pages such as pet friendly, pool, or specific neighborhood results. - **Rich listing details** - Capture rent ranges, per-bedroom pricing, total monthly price, deals, ratings, and contact numbers. - **Automatic pagination** - The actor walks through result pages until it reaches your desired number of listings. - **Flexible input** - Provide a direct results URL or a simple keyword and location; no technical setup required. - **Clean output** - Every record contains only the fields the source actually provides, so your dataset stays tidy. ### Use Cases #### Rental Market Research Track average rents and available inventory across multiple cities. Spot where prices rise or fall and compare neighborhoods side by side. #### Lead Generation for Relocation Services Build lists of communities with phone numbers and addresses to power outreach, relocation guidance, or local service businesses. #### Deal and Promotion Monitoring Follow price drops, rent specials, and best value badges over time to surface the strongest rental deals for clients or personal searches. #### Competitive Intelligence for Property Managers Monitor what nearby communities charge, which amenities they advertise, and how they position deals against your own listings. --- ### Input Parameters | Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | `startUrl` | String | No | - | A full ApartmentFinder results URL (city, neighborhood, or amenity page). Highest priority. | | `keyword` | String | No | - | Search term such as a city or amenity. Used when no `startUrl` is given. | | `location` | String | No | - | Location filter like "Washington, DC". Combine with `keyword` to add an amenity. | | `results_wanted` | Integer | No | `20` | Maximum number of listings to collect. The actor stops once reached. | | `max_pages` | Integer | No | `5` | Safety limit on how many result pages are visited. | | `proxyConfiguration` | Object | No | Residential proxy | Proxy settings; residential is recommended for reliable access. | --- ### Output Data Each item in the dataset contains: | Field | Type | Description | |-------|------|-------------| | `listingId` | String | Unique property identifier | | `name` | String | Community or building name | | `url` | String | Link to the listing detail page | | `address` | String | Street address | | `city` | String | City | | `state` | String | State code | | `priceRange` | String | Overall minimum and maximum rent shown on the card | | `bedrooms` | Array | Per-bedroom rent rollup with bedroom type and price | | `totalMonthlyPrice` | Array | Base rent, required fees, and total monthly price breakdown | | `deals` | Array | Special offers such as Price Drop, Rent Special, or Best Value | | `phone` | String | Contact phone number | | `rating` | String | Property rating or score | | `tier` | String | Property tier such as Diamond | | `latitude` | Number | Latitude coordinate | | `longitude` | Number | Longitude coordinate | | `imageUrl` | String | Primary building photo URL | | `imageGallery` | Array | Full set of property photo URLs from the detail page | --- ### Usage Examples #### Scrape a City Collect up to 50 apartments listed in Washington, DC: ```json { "startUrl": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments", "results_wanted": 50 } ```` #### Search by Keyword and Location Use a plain location string instead of a URL: ```json { "keyword": "Los Angeles, CA", "results_wanted": 30, "max_pages": 3 } ``` #### Filter by Amenity Combine a location with an amenity keyword such as pool: ```json { "location": "Washington, DC", "keyword": "pool", "results_wanted": 25 } ``` *** ### Sample Output ```json { "listingId": "cjj3v2e", "name": "Aerie at Wardman Park", "url": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments/Aerie-At-Wardman-Park-Apartments-cjj3v2e", "address": "2650 Woodley Rd NW, Washington, DC 20008", "city": "Washington", "state": "DC", "priceRange": "$4,029 - $8,951", "bedrooms": [ { "bedroom": "1 BED", "price": "$4,029+" }, { "bedroom": "2 BEDS", "price": "$5,215+" } ], "totalMonthlyPrice": [ { "label": "Base Rent", "value": "$4,007 - $8,929" }, { "label": "Required Monthly Fees", "value": "None" }, { "label": "Total Monthly Price", "value": "$4,029 - $8,951" } ], "deals": ["Price Drop. $650 Off"], "phone": "(202) 516-7716", "rating": "5", "tier": "Diamond", "latitude": 38.92456, "longitude": -77.0546, "imageUrl": "https://image1.apartmentfinder.com/i2/M-j51ZXDpWYU7YI4PYLfVPg00JHXmFoAmArU0ueGHnI/117/aerie-at-wardman-park-washington-dc-building-photo.jpg?p=1", "imageGallery": [ "https://image1.apartmentfinder.com/i2/M-j51ZXDpWYU7YI4PYLfVPg00JHXmFoAmArU0ueGHnI/110/aerie-at-wardman-park-washington-dc-primary-photo.jpg?p=1", "https://image1.apartmentfinder.com/i2/rM2wiBd11mTb4VoT03IHz9kWQ3YI6P0jsRXvKyRza6s/110/aerie-at-wardman-park-washington-dc-building-photo.jpg?p=1", "https://image1.apartmentfinder.com/i2/hgerHwoWOr6VXrcLmlkMNeP1Te1m-k8b3jb73lByaZE/110/aerie-at-wardman-park-washington-dc-building-photo.jpg?p=1", "https://image1.apartmentfinder.com/i2/2gR-vpz36984xjRwZAf9IsZk2nAB2ZYZvg3wltx9O0I/110/aerie-at-wardman-park-washington-dc-floorplan.jpg?p=1", "https://image1.apartmentfinder.com/m2/GJdDN2UhbHL3DU1YDAYDA-Xb0hW7d6vNGY70KDkEFsI/H260W390/aerie-at-wardman-park-washington-dc-map-image-of-the-property.jpg?p=1" ] } ``` *** ### Tips for Best Results #### Choose Working URLs Start from a live results page such as a city, neighborhood, or amenity URL. Copy the address directly from your browser. #### Begin with a Small Count Run with `results_wanted` set to 20 for a quick check, then raise it for full production collection. #### Use Residential Proxy The source applies strong bot protection. Keep the residential proxy enabled to avoid blocked requests. #### Combine Location and Amenity Pass both `location` and `keyword` to narrow results to communities with a specific feature. *** ### Proxy Configuration For reliable results, residential proxies are recommended: ```json { "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": ["RESIDENTIAL"] } } ``` *** ### Integrations Connect your data with: - **Google Sheets** - Export for quick analysis - **Airtable** - Build searchable rental databases - **Slack** - Receive new listing alerts - **Webhooks** - Send data to custom endpoints - **Make** - Automate multi-step workflows - **Zapier** - Trigger actions in other apps #### Export Formats Download the dataset in several formats: - **JSON** - For developers and APIs - **CSV** - For spreadsheet analysis - **Excel** - For business reporting - **XML** - For system integrations *** ### Frequently Asked Questions #### How many listings can I collect? You can collect as many as the source provides. The actor continues through pages until it reaches your `results_wanted` value or the available results run out. #### Can I scrape multiple pages automatically? Yes. Pagination is handled for you. Each results page links to the next, and the actor follows it up to `max_pages`. #### What if some fields are empty? Some communities do not publish every detail. The dataset only includes fields the source provides, so missing values are simply omitted from that record. #### Do I need to provide a URL? No. You can pass a `keyword` such as a city name, or both `location` and `keyword` to filter by amenity. A direct `startUrl` is optional but gives the most control. #### Why are my requests blocked? The source uses aggressive bot protection. Enable the residential proxy in `proxyConfiguration` to reduce blocks. #### Can I target a specific neighborhood? Yes. Paste the neighborhood results URL into `startUrl` and the actor will scrape that page set. *** ### Support For issues or feature requests, contact support through the Apify Console. #### Resources - [Apify Documentation](https://docs.apify.com/) - [API Reference](https://docs.apify.com/api/v2) - [Scheduling Runs](https://docs.apify.com/schedules) *** ### Legal Notice This actor is designed for legitimate data collection purposes. Users are responsible for ensuring compliance with website terms of service and applicable laws. Use data responsibly and respect rate limits. # Actor input Schema ## `startUrl` (type: `string`): ApartmentFinder results URL to scrape. Works with city, state, neighborhood, or amenity-filtered pages, e.g. https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments or https://www.apartmentfinder.com/California/Los-Angeles-Apartments-With-Pool ## `keyword` (type: `string`): Search term (city, neighborhood, or amenity). Used only when Start URL is empty. Resolved through the site's location search. Example: 'Washington, DC' or 'New York'. ## `location` (type: `string`): Location filter used when Start URL is empty. Example: 'Los Angeles, CA'. ## `results_wanted` (type: `integer`): The maximum number of listings to collect. The actor stops early once reached. ## `max_pages` (type: `integer`): Safety cap on the number of result pages to visit. ## `includeGalleries` (type: `boolean`): Optional. When enabled, the actor fetches individual property pages concurrently to collect larger image galleries. Keep disabled for fastest JSON-LD/listing-page extraction. ## `proxyConfiguration` (type: `object`): Recommended: RESIDENTIAL proxy. The site uses Akamai protection that may block datacenter IPs. ## Actor input object example ```json { "startUrl": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments", "results_wanted": 20, "max_pages": 5, "includeGalleries": false, "proxyConfiguration": { "useApifyProxy": true } } ``` # Actor output Schema ## `overview` (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 = { "startUrl": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments", "results_wanted": 20, "max_pages": 5, "includeGalleries": false }; // Run the Actor and wait for it to finish const run = await client.actor("shahidirfan/apartmentfinder-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 = { "startUrl": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments", "results_wanted": 20, "max_pages": 5, "includeGalleries": False, } # Run the Actor and wait for it to finish run = client.actor("shahidirfan/apartmentfinder-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 '{ "startUrl": "https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments", "results_wanted": 20, "max_pages": 5, "includeGalleries": false }' | apify call shahidirfan/apartmentfinder-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=shahidirfan/apartmentfinder-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "ApartmentFinder Scraper", "description": "Scrape rental listings from ApartmentFinder with prices, locations, bedrooms, amenities & landlord contact info. Perfect for rental market analysis, price intelligence, investment due diligence, competitor monitoring & real estate datasets. Structured JSON output.", "version": "0.0", "x-build-id": "UqYPZqV6yzFH5WvVd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shahidirfan~apartmentfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shahidirfan-apartmentfinder-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/shahidirfan~apartmentfinder-scraper/runs": { "post": { "operationId": "runs-sync-shahidirfan-apartmentfinder-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/shahidirfan~apartmentfinder-scraper/run-sync": { "post": { "operationId": "run-sync-shahidirfan-apartmentfinder-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", "properties": { "startUrl": { "title": "Start URL", "type": "string", "description": "ApartmentFinder results URL to scrape. Works with city, state, neighborhood, or amenity-filtered pages, e.g. https://www.apartmentfinder.com/District-Of-Columbia/Washington-Apartments or https://www.apartmentfinder.com/California/Los-Angeles-Apartments-With-Pool" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search term (city, neighborhood, or amenity). Used only when Start URL is empty. Resolved through the site's location search. Example: 'Washington, DC' or 'New York'." }, "location": { "title": "Location", "type": "string", "description": "Location filter used when Start URL is empty. Example: 'Los Angeles, CA'." }, "results_wanted": { "title": "Maximum number of results", "minimum": 1, "type": "integer", "description": "The maximum number of listings to collect. The actor stops early once reached.", "default": 20 }, "max_pages": { "title": "Maximum number of pages", "minimum": 1, "type": "integer", "description": "Safety cap on the number of result pages to visit.", "default": 5 }, "includeGalleries": { "title": "Fetch detail galleries", "type": "boolean", "description": "Optional. When enabled, the actor fetches individual property pages concurrently to collect larger image galleries. Keep disabled for fastest JSON-LD/listing-page extraction.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Recommended: RESIDENTIAL proxy. The site uses Akamai protection that may block datacenter IPs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } } ```