# Homes (`getdataforme/homes-scraper`) Actor Homes is an Apify Actor that scrapes real estate listings from Homes.com, extracting detailed property data via location queries and flexible price filters.... - **URL**: https://apify.com/getdataforme/homes-scraper.md - **Developed by:** [GetDataForMe](https://apify.com/getdataforme) (community) - **Categories:** Real estate, Automation, Lead generation - **Stats:** 16 total users, 1 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: No ratings yet ## Pricing from $10.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.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 ### PART 1: Generate README.md ## Homes Homes is a powerful Apify Actor designed to scrape real estate listings from Homes.com, enabling users to extract detailed property data based on specific location queries and price filters. This tool automates the collection of homes for sale, providing structured data for analysis, research, or integration into other applications. Whether you're a real estate professional, investor, or researcher, Homes delivers reliable, up-to-date information to streamline your workflow. ### Features - **Targeted Scraping**: Search and extract listings by custom location queries, such as city or region-specific URLs. - **Flexible Price Filtering**: Set minimum, maximum, and step prices to narrow down results within desired ranges. - **Configurable Limits**: Control the number of items scraped to manage data volume and processing time. - **Proxy Support**: Built-in proxy configuration to ensure anonymous and efficient scraping, avoiding IP blocks. - **High Reliability**: Handles dynamic web content with robust error recovery for consistent data extraction. - **JSON Output**: Produces clean, structured JSON data ready for export or further processing. - **Apify Integration**: Seamlessly runs on the Apify platform with easy monitoring and scaling options. ### Input Parameters | Parameter | Type | Required | Description | Example | |-----------|------|----------|-------------|---------| | query | string | No | The location query to search for homes, typically a URL path like "house-springs-mo/all-inventory/". | "house-springs-mo/all-inventory/" | | price_min | integer | No | The minimum price threshold for listings to include. | 1000 | | price_max | integer | No | The maximum price threshold for listings to include. | 510000 | | price_step | integer | No | The price increment for filtering ranges (e.g., to group results in bands). | 10000 | | max_limit | integer | No | The maximum number of listings to scrape. | 100 | | proxyConfiguration | object | Yes | Proxy settings to mask the scraper's IP and ensure smooth operation. | {"useApifyProxy": true} | ### Example Usage To run the Homes Actor, provide input parameters in JSON format. Here's an example input: ```json { "query": "house-springs-mo/all-inventory/", "price_min": 1000, "price_max": 510000, "price_step": 10000, "max_limit": 100, "proxyConfiguration": { "useApifyProxy": true } } ```` Example output (in case of errors or partial data): ```json [ { "error": "'HomesSpider' object has no attribute 'max_price'", "contact_us": "If you are not getting the expected data, please contact us.", "url": "https://www.homes.com/homes-for-sale/?bb=n328ylyrtNt5wuoqsD&property_type=1%2C2%2C4%2C256&price-min=1000&price-max=510000" } ] ``` ### Use Cases - **Market Research and Analysis**: Gather data on property prices and availability in specific areas for trend analysis. - **Competitive Intelligence**: Monitor competitors' listings or regional market dynamics. - **Price Monitoring**: Track price changes over time for investment opportunities. - **Content Aggregation**: Build databases of real estate content for websites or apps. - **Academic Research**: Collect data for studies on housing markets, demographics, or economics. - **Business Automation**: Integrate scraped data into CRM systems or automated reporting tools. ### Installation and Usage 1. Search for "Homes" in the Apify Store 2. Click "Try for free" or "Run" 3. Configure input parameters 4. Click "Start" to begin extraction 5. Monitor progress in the log 6. Export results in your preferred format (JSON, CSV, Excel) ### Output Format The Actor outputs data in JSON format as an array of objects. Each object may include fields like "error" for any issues encountered, "contact\_us" with support information, and "url" linking to the scraped listing page. Successful runs typically provide detailed property data such as prices, locations, and descriptions, but the example shows error handling. Ensure parameters are set correctly to avoid errors. ### Support For custom/simplified outputs or bug reports, please contact: - Email: support@getdataforme.com - Subject line: "custom support" - Contact form: https://getdataforme.com/contact/ We're here to help you get the most out of this Actor! ### PART 2: Generate Description # Actor input Schema ## `query` (type: `string`): The query term to search for location. ## `price_min` (type: `integer`): The minimum price of items to scrape. ## `price_max` (type: `integer`): The maximum price of items to scrape. ## `price_step` (type: `integer`): This is the price difference that you want to e.g : 50,000 to 60,000 difference is 10,000 ## `max_limit` (type: `integer`): The maximum number of items to scrape. ## `proxyConfiguration` (type: `object`): Specifies proxy servers that will be used by the scraper in order to hide its origin. ## Actor input object example ```json { "query": "house-springs-mo/all-inventory/", "price_min": 1000, "price_max": 510000, "price_step": 10000, "max_limit": 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 = { "query": "house-springs-mo/all-inventory/", "price_min": 1000, "price_max": 510000, "price_step": 10000, "max_limit": 100, "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("getdataforme/homes-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 = { "query": "house-springs-mo/all-inventory/", "price_min": 1000, "price_max": 510000, "price_step": 10000, "max_limit": 100, "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("getdataforme/homes-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 '{ "query": "house-springs-mo/all-inventory/", "price_min": 1000, "price_max": 510000, "price_step": 10000, "max_limit": 100, "proxyConfiguration": { "useApifyProxy": true } }' | apify call getdataforme/homes-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=getdataforme/homes-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Homes", "description": "Homes is an Apify Actor that scrapes real estate listings from Homes.com, extracting detailed property data via location queries and flexible price filters....", "version": "0.0", "x-build-id": "1OlUcnNPmd3LTfg2c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getdataforme~homes-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getdataforme-homes-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/getdataforme~homes-scraper/runs": { "post": { "operationId": "runs-sync-getdataforme-homes-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/getdataforme~homes-scraper/run-sync": { "post": { "operationId": "run-sync-getdataforme-homes-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": [ "proxyConfiguration" ], "properties": { "query": { "title": "Location Query", "type": "string", "description": "The query term to search for location.", "default": "house-springs-mo/all-inventory/" }, "price_min": { "title": "Minimum Price", "type": "integer", "description": "The minimum price of items to scrape.", "default": 1000 }, "price_max": { "title": "Maximum Price", "type": "integer", "description": "The maximum price of items to scrape.", "default": 510000 }, "price_step": { "title": "Price Difference", "type": "integer", "description": "This is the price difference that you want to e.g : 50,000 to 60,000 difference is 10,000", "default": 10000 }, "max_limit": { "title": "Max_limit", "type": "integer", "description": "The maximum number of items to scrape.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.", "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 } } } } } } } } } } ```