# 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
- **Features:** Full permissions
- **Stats:** 16 total users, 0 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/actors/running/actors-in-store.md#pay-per-event

## 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

### 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# 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(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 '{
  "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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,getdataforme/homes-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 <APIFY_API_TOKEN>` 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/xuVdEMfij8CJLurLK/builds/1OlUcnNPmd3LTfg2c/openapi.json
