# Apartments.com Scraper (`parseforge/apartments-com-scraper`) Actor Extracts rental apartment listings from Apartments.com, capturing property details, prices, amenities, contact information, and location data. Supports filtering by location, bedrooms, price range, and property type for housing research, competitive analysis, and market monitoring workflows. - **URL**: https://apify.com/parseforge/apartments-com-scraper.md - **Developed by:** [ParseForge](https://apify.com/parseforge) (community) - **Categories:** Real estate, Automation, Developer tools - **Stats:** 23 total users, 9 monthly users, 96.1% runs succeeded, 1 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing Pay per event This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. 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 ![ParseForge Banner](https://github.com/ParseForge/apify-assets/blob/ad35ccc13ddd068b9d6cba33f323962e39aed5b2/banner.jpg?raw=true) ## 🏠 Apartments.com Scraper > πŸ•’ **Last updated:** 2026-05-05
Pull structured records from Apartments.com β€” clean fields ready as CSV, JSON, JSONL, Excel, or XML for downstream pipelines.
##### Copy to your AI assistant Copy this block into ChatGPT, Claude, Cursor, or any LLM to start using this actor. ```` parseforge/apartments-com-scraper on Apify. Call: ApifyClient("TOKEN").actor("parseforge/apartments-com-scraper").call(run\_input={...}), then client.dataset(run\["defaultDatasetId"]).list\_items().items for results. Key inputs: startUrl (string, default "https://www.apartments.com/los-angeles-ca/"), maxItems (integer, default 10), location (string), bedrooms (string), priceMax (integer), propertyType (string). Full actor spec: fetch build via GET https://api.apify.com/v2/acts/parseforge~apartments-com-scraper (Bearer TOKEN). Get token: https://console.apify.com/account/integrations ```` Collect rental apartment listings from Apartments.com without coding. Extract property details, rent by bedroom count, amenities, contact information, and location data. Perfect for real estate investors, market researchers, and property managers who need to monitor rental prices and availability. Download Apartments.com data as CSV, Excel, or JSON in minutes. > **The Apartments.com Scraper collects up to 1,000,000 rental listings with 20+ fields per property, including rent by bedroom, amenities, virtual tour availability, and location coordinates.** ### ✨ What Does It Do - πŸ–ΌοΈ **Image URL** - Display the property listing's main thumbnail for visual reference in your spreadsheet - πŸ’° **Base Price** - Get the starting monthly rent to quickly compare property affordability across locations - 🏠 **Bedroom and Bathroom Range** - Filter and analyze properties by unit size to identify market gaps and demand - 🎯 **Amenities List** - Extract every feature from parking to fitness centers, allowing you to segment properties by lifestyle appeal - πŸ”— **Direct Listing URL** - Link directly to the full property listing for instant access and verification - πŸ“ **Location Coordinates** - Use latitude and longitude to map properties in your CRM or GIS software for geographic analysis - πŸ‘€ **Management Company** - Identify which management firms operate which properties to track competitors or consolidate deals - πŸ“ž **Contact Phone** - Get property management contact numbers for direct inquiry and negotiation - πŸ’΅ **Multi-Bedroom Rent** - See rent for studios, 1BR, 2BR, 3BR, and 4BR+ units to understand rental strategies by unit type - ✨ **Special Offers and Virtual Tour Indicators** - Know which properties have current specials or virtual tours to prioritize your viewing schedule ### πŸ”§ Input - **Direct URL** - Paste an Apartments.com search results page URL to scrape specific searches with pre-applied filters - **Location** - Enter a city and state to search for apartments (e.g., Los Angeles, CA) or use a direct URL, not both - **Bedrooms** - Filter results by number of bedrooms (Studio, 1, 2, 3, or 4+) to focus on specific unit types - **Maximum Price** - Set a monthly rent limit in USD to exclude overpriced listings - **Property Type** - Choose between Apartments, Houses, Townhomes, or Condos to narrow your search - **Max Items** - Set how many listings to collect per run (free users limited to 100, paid users can collect up to 1,000,000) - **Proxy Configuration** - Configure proxy settings, with residential proxies recommended for Apartments.com Example input: ```json { "startUrl": "https://www.apartments.com/los-angeles-ca/", "maxItems": 100, "bedrooms": "2", "priceMax": 3000, "propertyType": "apartments" } ```` ### πŸ“Š Output Each listing includes up to 20 data fields. Download as JSON, CSV, or Excel. | πŸ–ΌοΈ Image URL | πŸ“ Listing ID | 🏠 Property Name | |--|--|--| | πŸ“ Street Address | πŸ™οΈ City | 🌍 State | | πŸ“¬ ZIP Code | πŸ’° Base Price | πŸ’΅ Rent by Bedroom | | πŸ›οΈ Bedroom Range | 🚿 Bathroom Range | πŸ“ Square Footage Range | | 🎯 Amenities List | πŸ“ž Phone Number | πŸ–ΌοΈ Image Count | | πŸŽ₯ Virtual Tour Available | ✨ Special Offers | πŸ‘€ Management Company | | πŸ“ Latitude | πŸ“ Longitude | πŸ’΅ Min Price | πŸ’΅ Max Price | | πŸ”— Listing URL | πŸ“… Scraped At | ⚠️ Error Notes | ### πŸ’Ž Why Choose the Apartments.com Scraper? | Feature | Our Scraper | Similar Scrapers | |--|--|--| | Multi-bedroom rent breakdown | βœ”οΈ | ❌ | | Virtual tour detection | βœ”οΈ | ❌ | | Management company info | βœ”οΈ | Partial | | Amenities extraction | βœ”οΈ | Partial | | Coordinates (lat/long) | βœ”οΈ | ❌ | | Direct URL passing | βœ”οΈ | ❌ | | Special offers detection | βœ”οΈ | ❌ | | Image count tracking | βœ”οΈ | ❌ | | Real-time data extraction | βœ”οΈ | Partial | | Geographic filtering | βœ”οΈ | ❌ | | Property type filtering | βœ”οΈ | Partial | | Zero maintenance required | βœ”οΈ | ❌ | ### πŸ“‹ How to Use No technical skills required. Follow these simple steps: 1. **Sign Up** - [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) 2. **Find the Tool** - Search for "Apartments.com Scraper" in the Apify Store and configure your input 3. **Run It** - Click "Start" and watch your results appear That's it. No coding, no setup, no complicated configuration. Now you can export your data in CSV, Excel, or JSON format. ### 🎯 Business Use Cases - πŸ“Š **Real Estate Analyst** - Monitor monthly rent changes across 10 US markets to forecast price trends and identify seasonal patterns before adjusting investment portfolio strategy - πŸ’Ό **Property Manager** - Track competitor properties in your geographic region weekly to benchmark your unit rents and adjust lease rates to remain competitive - 🏒 **Corporate Real Estate** - Collect listings near company offices to understand relocation market rates and build an employee housing subsidy program based on actual local costs *** *** ### ✨ Why choose this Actor | | Capability | |---|---| | 🎯 | **Built for the job.** Scoped specifically to this data source so you skip the parser engineering entirely. | | πŸ”– | **Structured output.** Clean, typed fields ready for analysis, dashboards, or downstream pipelines. | | ⚑ | **Fast.** Optimized request patterns return results in seconds, not minutes. | | πŸ” | **Always fresh.** Every run pulls live data, so the dataset reflects the source as of run time. | | 🌐 | **No infra to manage.** Apify handles proxies, retries, scaling, scheduling, and storage. | | πŸ›‘οΈ | **Reliable.** Battle-tested across many runs and edge cases, with graceful error handling. | | 🚫 | **No code required.** Configure in the UI, run from CLI, schedule via cron, or call from any language with the Apify SDK. | > πŸ“Š Production-grade structured data without the engineering overhead of building and maintaining your own scraper. *** ### πŸ“ˆ How it compares to alternatives | Approach | Cost | Coverage | Refresh | Filters | Setup | |---|---|---|---|---|---| | **⭐ Apartments.com Scraper** *(this Actor)* | $5 free credit, then pay-per-use | Full source coverage | **Live per run** | Source-native filters supported | ⚑ 2 min | | Build your own scraper | Engineering hours | Full once built | Whenever you maintain it | Custom code | 🐒 Days to weeks | | Paid managed APIs | $$$ monthly | Vendor-defined | Live | Vendor-defined | ⏳ Hours | | Third-party data dumps | Varies | Subset, often stale | Periodic | None | πŸ•’ Variable | Pick this Actor when you want broad coverage, server-side filtering, and no pipeline maintenance. *** ### πŸš€ How to use 1. πŸ“ **Sign up.** [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) (takes 2 minutes). 2. 🌐 **Open the Actor.** Go to the Apartments.com Scraper page on the Apify Store. 3. 🎯 **Set input.** Configure the input fields in the form (or paste a JSON), then set maxItems. 4. πŸš€ **Run it.** Click **Start** and let the Actor collect your data. 5. πŸ“₯ **Download.** Grab your results in the **Dataset** tab as CSV, Excel, JSON, or XML. > ⏱️ Total time from signup to downloaded dataset: **3-5 minutes.** No coding required. *** ### πŸ’Ό Business use cases
#### πŸ“Š Data & Analytics - Build trend reports and dashboards from live source data - Feed BI tools, warehouses, and ML pipelines with structured records - Run periodic snapshots to track changes over time - Compare segments, regions, or categories with consistent fields #### 🏒 Operations & Strategy - Monitor competitor moves, pricing, and inventory shifts - Build internal directories and lookup tools backed by current data - Power workflows that depend on fresh source records - Cut manual data-gathering time from hours to minutes
#### 🎯 Marketing & Growth - Identify market opportunities and trending topics - Research target audiences and customer personas at scale - Power lead-generation pipelines with verified records - Track sentiment, reviews, or social signals over time #### πŸ› οΈ Engineering & Product - Prototype features that need real-world data without owning a crawler - Replace fragile in-house scrapers with a managed Actor - Wire datasets into your apps via the Apify API or webhooks - Skip the proxy, retry, and parsing maintenance entirely
*** ### 🌟 Beyond business use cases Data like this powers more than commercial workflows. The same structured records support research, education, civic projects, and personal initiatives.
#### πŸŽ“ Research and academia - Empirical datasets for papers, thesis work, and coursework - Longitudinal studies tracking changes across snapshots - Reproducible research with cited, versioned data pulls - Classroom exercises on data analysis and ethical scraping #### 🎨 Personal and creative - Side projects, portfolio demos, and indie app launches - Data visualizations, dashboards, and infographics - Content research for bloggers, YouTubers, and podcasters - Hobbyist collections and personal trackers
#### 🀝 Non-profit and civic - Transparency reporting and accountability projects - Advocacy campaigns backed by public-interest data - Community-run databases for local issues - Investigative journalism on public records #### πŸ§ͺ Experimentation - Prototype AI and machine-learning pipelines with real data - Validate product-market hypotheses before engineering spend - Train small domain-specific models on niche corpora - Test dashboard concepts with live input
### πŸ€– Ask an AI assistant about this scraper Open a ready-to-send prompt about this ParseForge actor in the AI of your choice: - πŸ’¬ [**ChatGPT**](https://chat.openai.com/?q=How%20do%20I%20use%20the%20Apartments.com%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - 🧠 [**Claude**](https://claude.ai/new?q=How%20do%20I%20use%20the%20Apartments.com%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - πŸ” [**Perplexity**](https://perplexity.ai/search?q=How%20do%20I%20use%20the%20Apartments.com%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - πŸ…’ [**Copilot**](https://copilot.microsoft.com/?q=How%20do%20I%20use%20the%20Apartments.com%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) ### ❓ Frequently Asked Questions
πŸ’³ Do I need a paid Apify plan to run this actor? No. You can start right now on the free Apify plan, which includes **$5 in free monthly credit**. That is enough to run this actor several times and explore the output before committing to anything. Paid plans unlock higher limits, more concurrent runs, and larger datasets. [Create a free Apify account here](https://console.apify.com/sign-up?fpr=vmoqkp) to get started.
🚨 What happens if my run fails or returns no results? Failed runs are not charged. If the source site changes, proxies get rate-limited, or a specific input matches nothing, re-run the actor or open our [contact form](https://tally.so/r/BzdKgA) and we will investigate. You can also check the run log in the Apify console to see why the run stopped.
πŸ“ How many items can I scrape per run? Free users are limited to **10 items per run** so you can preview the output and confirm the actor works for your use case. Paid users can raise maxItems up to **1,000,000** per run. [Upgrade here](https://console.apify.com/sign-up?fpr=vmoqkp) if you need full scale.
πŸ•’ How fresh is the data? Every run fetches live data at the moment of execution. There is no cache or delay: the records you get reflect what the source returned at that moment. Schedule the actor to maintain a rolling snapshot of the data you need.
πŸ§‘β€πŸ’» Can I call this actor from my own code? Yes. Apify exposes every actor as a REST endpoint and ships first-class SDKs for [Node.js](https://docs.apify.com/sdk/js) and [Python](https://docs.apify.com/sdk/python). You can start a run, read the dataset, and handle webhooks from your own app in a few lines. All you need is your Apify API token.
πŸ“€ How do I export the data? Every Apify dataset can be downloaded in one click from the console as CSV, JSON, JSONL, Excel, HTML, XML, or RSS. You can also pull results programmatically via the [Apify API](https://docs.apify.com/api/v2) or stream them into BigQuery, S3, and other destinations through built-in integrations.
πŸ“… Can I schedule the actor to run automatically? Yes. Use the Apify scheduler to run the actor on any cadence, from hourly to monthly. Results are saved to your dataset and can be delivered to webhooks, email, Slack, cloud storage, or automation tools such as Zapier and Make. ***
### πŸ”Œ Integrate with any app Apartments.com Scraper connects to any cloud service via [Apify integrations](https://apify.com/integrations): - [**Make**](https://docs.apify.com/platform/integrations/make) - Automate multi-step workflows - [**Zapier**](https://docs.apify.com/platform/integrations/zapier) - Connect with 5,000+ apps - [**Slack**](https://docs.apify.com/platform/integrations/slack) - Get run notifications in your channels - [**Airbyte**](https://docs.apify.com/platform/integrations/airbyte) - Pipe results into your warehouse - [**GitHub**](https://docs.apify.com/platform/integrations/github) - Trigger runs from commits and releases - [**Google Drive**](https://docs.apify.com/platform/integrations/drive) - Export datasets straight to Sheets You can also use webhooks to trigger downstream actions when a run finishes. Push fresh data into your product backend, or alert your team in Slack. *** ### πŸ’‘ More ParseForge Actors - [Zillow Rentals Scraper](https://apify.com/parseforge/zillow-rentals-scraper) - Extract rental listings from Zillow with rent amounts and property details - [Booking Com Scraper](https://apify.com/parseforge/booking-com-scraper) - Collect accommodation listings and booking data from Booking.com - [Etsy Scraper](https://apify.com/parseforge/etsy-scraper) - Extract product listings with prices and reviews from Etsy - [Trade Me Property Scraper](https://apify.com/parseforge/trade-me-property-scraper) - Collect property listings from Trade Me New Zealand - [Alibaba.com Rental Scraper](https://apify.com/parseforge/alibaba-com-rental-scraper) - Extract rental equipment listings from Alibaba.com Browse our complete collection of [data extraction tools](https://apify.com/parseforge) for more. ### πŸš€ Ready to Start? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) and collect your first 100 results for free. No coding, no setup. ### πŸ†˜ Need Help? - Check the FAQ section above for common questions - Visit the [Apify support page](https://docs.apify.com) for documentation and tutorials - Contact us to request a new scraper, propose a custom project, or report an issue at [Tally contact form](https://tally.so/r/BzdKgA) ### ⚠️ Disclaimer > This Actor is an independent tool and is not affiliated with, endorsed by, or sponsored by Apartments.com or any of its subsidiaries. All trademarks mentioned are the property of their respective owners. *** ### πŸ”— Recommended Actors - [**πŸ” Google Search Scraper**](https://apify.com/parseforge/google-search-scraper) - Multi-engine SERP results with country and language targeting - [**πŸ—ΊοΈ Nominatim OSM Scraper**](https://apify.com/parseforge/nominatim-osm-scraper) - Geocode addresses via OpenStreetMap - [**πŸ“Š Indexmundi Scraper**](https://apify.com/parseforge/indexmundi-scraper) - Global demographic and economic indicators - [**πŸ“° RAG Web Browser**](https://apify.com/parseforge/rag-web-browser) - Crawl and extract clean text from any URL for AI retrieval - [**🌐 Website Content Crawler**](https://apify.com/parseforge/website-content-crawler) - Crawl entire sites and export structured content > πŸ’‘ **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for more reference-data scrapers. # Actor input Schema ## `startUrl` (type: `string`): Direct Apartments.com search results URL to scrape. Use this to scrape a specific search with pre-applied filters. Either provide this OR location, not both. ## `maxItems` (type: `integer`): Maximum number of listings to scrape. Free users are limited to 100 items. ## `location` (type: `string`): City and state to search for apartments (e.g., 'Los Angeles, CA' or 'los-angeles-ca'). Either provide this OR a direct URL, not both. ## `bedrooms` (type: `string`): Filter by number of bedrooms ## `priceMax` (type: `integer`): Maximum monthly rent price in USD ## `propertyType` (type: `string`): Type of property to search for ## `proxyConfiguration` (type: `object`): Proxy settings for the scraper. Residential proxies are recommended for Apartments.com. ## Actor input object example ```json { "startUrl": "https://www.apartments.com/los-angeles-ca/", "maxItems": 10, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } ``` # Actor output Schema ## `results` (type: `string`): Dataset with scraped rental 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrl": "https://www.apartments.com/los-angeles-ca/", "maxItems": 10, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }; // Run the Actor and wait for it to finish const run = await client.actor("parseforge/apartments-com-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.apartments.com/los-angeles-ca/", "maxItems": 10, "proxyConfiguration": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], }, } # Run the Actor and wait for it to finish run = client.actor("parseforge/apartments-com-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.apartments.com/los-angeles-ca/", "maxItems": 10, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }' | apify call parseforge/apartments-com-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=parseforge/apartments-com-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Apartments.com Scraper", "description": "Extracts rental apartment listings from Apartments.com, capturing property details, prices, amenities, contact information, and location data. Supports filtering by location, bedrooms, price range, and property type for housing research, competitive analysis, and market monitoring workflows.", "version": "1.0", "x-build-id": "tTnpIb6xHc5Q3sv8V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~apartments-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-apartments-com-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/parseforge~apartments-com-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-apartments-com-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/parseforge~apartments-com-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-apartments-com-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": "Direct URL", "type": "string", "description": "Direct Apartments.com search results URL to scrape. Use this to scrape a specific search with pre-applied filters. Either provide this OR location, not both." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of listings to scrape. Free users are limited to 100 items." }, "location": { "title": "Location", "type": "string", "description": "City and state to search for apartments (e.g., 'Los Angeles, CA' or 'los-angeles-ca'). Either provide this OR a direct URL, not both." }, "bedrooms": { "title": "Bedrooms", "enum": [ "studio", "1", "2", "3", "4" ], "type": "string", "description": "Filter by number of bedrooms" }, "priceMax": { "title": "Maximum Price", "minimum": 100, "maximum": 50000, "type": "integer", "description": "Maximum monthly rent price in USD" }, "propertyType": { "title": "Property Type", "enum": [ "apartments", "houses", "townhomes", "condos" ], "type": "string", "description": "Type of property to search for" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the scraper. Residential proxies are recommended for Apartments.com." } } }, "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 } } } } } } } } } } ```