# ApartmentList Scraper - Apartment Rentals (`jongoose/apartment-list-scraper`) Actor Scrape apartment & rental listings from ApartmentList by city - address, rent range, beds/baths, square footage, amenities, phone, photo, availability, geo-coordinates & canonical URL. One request returns a city's entire result set. Paste ApartmentList city URLs or just enter a city + state. - **URL**: https://apify.com/jongoose/apartment-list-scraper.md - **Developed by:** [James Scott](https://apify.com/jongoose) (community) - **Categories:** Real estate, Lead generation - **Stats:** 2 total users, 0 monthly users, 91.7% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $1.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. 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/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 ## ApartmentList Scraper - Apartment Rentals Scrape **apartment and rental listings from ApartmentList** into clean, structured data - no ApartmentList account or API key required. Enter a city (or paste city URLs) and get that city's **entire result set** back in a single request. ### What you get (per listing) - **listingId** and canonical **ApartmentList URL** - **name** / property title - **address**, city, state, ZIP - **lat / lng** geo-coordinates - **rentMin / rentMax** (price range across available floorplans) - **bedsMin / bedsMax** bedroom range and **baths** - **sqft** (square footage) - **amenities** (community + in-unit) - **phone**, **photoUrl**, and **availability** (soonest move-in date) - **propertyType**, **neighborhood**, **unitsAvailable** > Every listing in a city gets core fields (id, name, URL, geo, rent range, beds). The > deeper fields (full address, baths, sqft, amenities, phone, photo, availability) are > populated for the listings ApartmentList renders in detail on the city page. ### Input - **ApartmentList city URLs** - paste one or more, e.g. `https://www.apartmentlist.com/tx/austin`. Each city page returns the whole city in one request. - Or leave URLs empty and set **City** + **State** (e.g. `Austin` / `tx`) to build the URL for you. - **Max listings** caps the run across all cities. #### Example input ```json { "startUrls": [ { "url": "https://www.apartmentlist.com/tx/austin" }, { "url": "https://www.apartmentlist.com/ny/new-york" } ], "maxItems": 500, "proxyConfiguration": { "useApifyProxy": true } } ```` Or, without URLs: ```json { "city": "San Antonio", "state": "tx", "maxItems": 200 } ``` #### Example output (one record) ```json { "listingId": "p15604029", "name": "Charming 3/2/2 with Private Fenced Backyard!", "address": "5810 Avery Island Avenue", "city": "Austin", "state": "TX", "zip": "78727", "lat": 30.434, "lng": -97.742975, "rentMin": 2150, "rentMax": 2150, "bedsMin": 3, "bedsMax": 3, "baths": 2, "sqft": 1230, "propertyType": null, "amenities": ["Pet friendly", "Parking", "Garage", "W/D hookup", "Walk in closets"], "photoUrl": "https://cdn.apartmentlist.com/image/upload/f_auto,q_auto,t_web-base/29027c5a27f5ca538ad69b36bca14e66.jpg", "url": "https://www.apartmentlist.com/tx/austin/charming-3-2-2-with-private-fenced-backyard", "phone": "(737) 250-7592", "availability": "2026-08-10", "neighborhood": "Milwood", "unitsAvailable": 1, "scrapedFrom": "apartmentlist.com" } ``` ### Why this actor - **Whole city in one request:** a single city page embeds ApartmentList's complete result set for that city (every match, with geo + price + beds), so runs are fast and cheap - no per-listing detail requests and no result-page clicking. - **Reads straight from the page's embedded JSON**, which is far more durable than CSS selectors that break on every redesign. - **Runs on Apify's default datacenter proxy** - ApartmentList is open, so no pricey residential proxy is needed. - Export as JSON, CSV, Excel, or pull via the Apify API. Great for renters, real-estate analysts, and PropTech teams doing **rental-market analysis, price benchmarking, and inventory monitoring**. ### Legal / usage Public listing data for research and market-analysis purposes. This is **not a consumer report** and must **not** be used for **FCRA or tenant-screening** purposes, or for any use governed by the Fair Credit Reporting Act. Respect ApartmentList's Terms of Use and applicable laws. # Actor input Schema ## `startUrls` (type: `array`): One or more ApartmentList city URLs, e.g. https://www.apartmentlist.com/tx/austin or https://www.apartmentlist.com/ny/new-york. Each city page returns that city's entire result set in a single request. If left empty, the City + State below are used. ## `city` (type: `string`): City to scrape when no Start URL is given (e.g. "Austin", "San Antonio"). Combined with State to build the city URL. ## `state` (type: `string`): Two-letter state abbreviation for the City above (e.g. "tx", "ny", "ca"). Used only when no Start URL is given. ## `maxItems` (type: `integer`): Stop after collecting this many listings (across all cities). ## `proxyConfiguration` (type: `object`): ApartmentList works fine through Apify's default (datacenter) proxy - no residential proxy needed. ## Actor input object example ```json { "startUrls": [ { "url": "https://www.apartmentlist.com/tx/austin" } ], "city": "austin", "state": "tx", "maxItems": 100, "proxyConfiguration": { "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": [ { "url": "https://www.apartmentlist.com/tx/austin" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("jongoose/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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrls": [{ "url": "https://www.apartmentlist.com/tx/austin" }] } # Run the Actor and wait for it to finish run = client.actor("jongoose/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 '{ "startUrls": [ { "url": "https://www.apartmentlist.com/tx/austin" } ] }' | apify call jongoose/apartment-list-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jongoose/apartment-list-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "ApartmentList Scraper - Apartment Rentals", "description": "Scrape apartment & rental listings from ApartmentList by city - address, rent range, beds/baths, square footage, amenities, phone, photo, availability, geo-coordinates & canonical URL. One request returns a city's entire result set. Paste ApartmentList city URLs or just enter a city + state.", "version": "0.1", "x-build-id": "qTavTfjWJcid8T4UR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jongoose~apartment-list-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jongoose-apartment-list-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/jongoose~apartment-list-scraper/runs": { "post": { "operationId": "runs-sync-jongoose-apartment-list-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/jongoose~apartment-list-scraper/run-sync": { "post": { "operationId": "run-sync-jongoose-apartment-list-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": { "startUrls": { "title": "ApartmentList city URLs", "type": "array", "description": "One or more ApartmentList city URLs, e.g. https://www.apartmentlist.com/tx/austin or https://www.apartmentlist.com/ny/new-york. Each city page returns that city's entire result set in a single request. If left empty, the City + State below are used.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "city": { "title": "City", "type": "string", "description": "City to scrape when no Start URL is given (e.g. \"Austin\", \"San Antonio\"). Combined with State to build the city URL.", "default": "austin" }, "state": { "title": "State", "type": "string", "description": "Two-letter state abbreviation for the City above (e.g. \"tx\", \"ny\", \"ca\"). Used only when no Start URL is given.", "default": "tx" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after collecting this many listings (across all cities).", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "ApartmentList works fine through Apify's default (datacenter) proxy - no residential proxy needed.", "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 } } } } } } } } } } ```