# Housing Property Scraper (`scrapeai/housing-property-scraper`) Actor

Housing Property Scraper is a web scraping tool that extracts property listings from housing websites. It collects key details like title, price, location, amenities, images, and contact info. Ideal for real estate analysis, market research, and generating structured datasets for further processing.

- **URL**: https://apify.com/scrapeai/housing-property-scraper.md
- **Developed by:** [ScrapeAI](https://apify.com/scrapeai) (community)
- **Categories:** Real estate, Developer tools, Automation
- **Features:** Limited permissions
- **Stats:** 8 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: 5.00 out of 5 stars

## Pricing

from $2.49 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## Housing Search Scraper 🏘️

A powerful web scraper built to extract property listings from Housing.com search result pages. It collects detailed information such as property title, price, location, configuration (BHK), area, amenities, and listing URLs. Ideal for real estate data analysis, market research, and lead generation.

### Features

- Collects property data by intercepting API responses from Housing.com.
- Handles infinite scroll and dropdown interactions automatically.
- Supports configurable search URLs and per-search limits.
- Includes single entry points (`src/main.js`) demonstrating different variable naming schemes with identical logic.

### Getting Started

1. **Install dependencies**
   ```bash
   npm install
   ```

2. **Configure input**
   - Edit `INPUT.json` or provide actor input through the Apify platform.
   - Example `INPUT.json`:
     ```json
     {
       "searchUrls": [
         "https://www.housing.com/in/buy/search?..."
       ],
       "headless": true
     }
     ```

3. **Run locally**
   ```bash
   node src/main.js
   ```

4. **Docker / Actor**
   - The `Dockerfile` in the repository can be used to build an image.
   - The `.actor/actor.json` file defines the actor specification for deployment on Apify.

### File Overview

- `src/main.js` – primary script with standard variable names.
- `src/scraper.js` – shared scraping logic used by the entry point.

#### Input & Output Schemas

The actor uses JSON Schema definitions to validate inputs and dataset records:

- **Input schema:** `.actor/input_schema.json` – specifies required `searchUrls` array and optional `maxCrawlPerSearch` integer.
- **Dataset schema:** `.actor/dataset_schema.json` – very detailed schema describing the structure of scraped property objects.\
  Certain fields such as `hasAutoVideo` and `coverImage.videoUrl` are optional, so that older records without video metadata still validate.

These files are referenced in `.actor/actor.json` and are used by the Apify platform when running the actor.

### Logs & Storage

- API requests/responses are saved under `storage/logs`.
- Collected dataset entries are stored via Apify's dataset storage (schema defined in `.actor/dataset_schema.json`).

### License

This project is provided as-is. Feel free to adapt and extend for your own use.

# Actor input Schema

## `searchUrls` (type: `array`):

Add the search page URLs of Housing.com to fetch property details

## `maxCrawlPerSearch` (type: `integer`):

Maximum number of properties to crawl per search URL

## Actor input object example

```json
{
  "searchUrls": [
    "https://housing.com/in/buy/mumbai/mumbai"
  ],
  "maxCrawlPerSearch": 100
}
```

# 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 = {
    "searchUrls": [
        "https://housing.com/in/buy/mumbai/mumbai"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("scrapeai/housing-property-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 = { "searchUrls": ["https://housing.com/in/buy/mumbai/mumbai"] }

# Run the Actor and wait for it to finish
run = client.actor("scrapeai/housing-property-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 '{
  "searchUrls": [
    "https://housing.com/in/buy/mumbai/mumbai"
  ]
}' |
apify call scrapeai/housing-property-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,scrapeai/housing-property-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/qvM0XZC5fvLRKNxQW/builds/RNbWWRt6T9ftydSgA/openapi.json