# Hotpads.com Property Scraper (`one-api/hotpads-scraper`) Actor

Scrape Hotpads.com (Zillow Group) rental listings. Get full listing details by id or URL, search apartments, houses, condos and rooms for rent by location, by coordinates + radius, or by a Hotpads URL with filters, and resolve locations via autocomplete.

- **URL**: https://apify.com/one-api/hotpads-scraper.md
- **Developed by:** [ONE API](https://apify.com/one-api) (community)
- **Categories:** Lead generation, Real estate
- **Stats:** 6 total users, 4 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.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 web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

## Hotpads.com Property Scraper

Scrape **Hotpads.com** (a **Zillow Group** rental marketplace) for **apartments, houses, condos, townhomes and rooms for rent** across the United States. Look up full listing details by id or URL, search by city / neighborhood / ZIP, by coordinates + radius, or by a hotpads.com results URL with filters, and resolve locations via autocomplete.

### What it does

- **🏠 Property Details** — auto-detects each input as a Hotpads listing id (`/details/byid`) or a `hotpads.com/...` URL (`/details/byurl`); returns the full rental record: rent, beds, baths, sqft, units & floorplans, amenities, pet policy, schools, photos, contact company + phone, lease terms and costs.
- **🔎 Search Listings** — auto-detects a free-text location (`/search/bylocation`) or a hotpads.com results URL (`/search/byurl`). Property type, monthly-rent, beds, baths, pets filters and sort all apply.
- **📍 Search by Coordinates** — radius search around a `latitude,longitude` point with an optional radius in **miles** (`/search/bycoordinates`).
- **🔍 Location Autocomplete** — resolve free text (city / neighborhood / ZIP) to the Hotpads area record used by search (`/autocomplete`).

### Output

- **One flat dataset row per listing or location suggestion** — sortable, filterable, CSV / Excel / JSON exportable.
- Columns: `Mode`, `Input Given`, `Listing ID`, `Building ID`, `Title`, `Property Type`, `Price`, `Price High`, `Beds`, `Baths`, `Sqft`, `Address`, `City`, `State`, `Zip`, `Latitude`, `Longitude`, `Company`, `Phone`, `Amenities`, `Photo Count`, `Cover Photo`, `Listing URL`.
- The complete upstream JSON for each row is kept in the `Raw` column for power users (units, floorplans, schools, pet policy, costs, contact details and more).

### Inputs

- Each section is independent — fill only the ones you need; multiple inputs per section, one per line.
- The Search filters (property type, rent / beds / baths ranges, pets, sort, pages, results-per-page) apply to every location, coordinate and URL search.
- **Range filters** use the format `min:1000,max:3000` (either half optional), e.g. monthly-rent `min:1500,max:3500`, beds `min:1,max:3`.
- **Coordinates** entries use the format `latitude,longitude` or `latitude,longitude,radiusMiles`, e.g. `40.7128,-74.006,1` (1 mile around lower Manhattan).

### Pricing

- Pay per result: **$3 per 1,000 dataset items** — the same rate on every Apify plan tier.
- Apify start fee: $0.00005 per run.

### Notes

- Hotpads is **rentals-only** (Zillow Group) — there is no for-sale or sold data.
- Prices are the **monthly rent in USD ($)**. Multi-unit buildings show a `Price` (lowest) and `Price High` (highest) range; `Beds` / `Baths` / `Sqft` are the low end of the building's range.
- Studios appear as `Beds = 0` — include them with a beds filter of `min:0`.
- Detail records carry far more in `Raw`: every unit / floorplan with its own rent, full amenities, pet policy, nearby schools, lease terms, costs and the listing contact.

### Errors

- Failures land in the dataset as rows with `Mode = "ERROR"` and the upstream message in `Title` — nothing is silently dropped.

# Actor input Schema

## `property_inputs` (type: `array`):

Auto-detects each entry and calls the right endpoint:
• A Hotpads listing id (e.g. `4y217cc1nzpm3`) → `/details/byid`
• A `https://hotpads.com/...` listing URL → `/details/byurl`

Each row = one full rental record (price, beds, baths, sqft, units & floorplans, amenities, pet policy, schools, photos, contact company + phone, lease terms, costs).

## `search_inputs` (type: `array`):

Auto-detects each entry and routes to the right `/search/*` endpoint:
• A hotpads.com results URL, e.g. `https://hotpads.com/new-york-ny/apartments-for-rent` → `/search/byurl`
• Anything else (city, neighborhood or ZIP, e.g. `New York, NY`, `Brooklyn`, `78758`) → `/search/bylocation`

The filters below apply to every search. Each hit returns one row per rental listing.

## `coordinate_inputs` (type: `array`):

Radius search around a point via `/search/bycoordinates`. One point per line as `latitude,longitude` or `latitude,longitude,radiusMiles` (radius in miles, default 1.5). Example: `40.7128,-74.006,1` searches 1 mile around lower Manhattan. The filters below also apply. One row per listing.

## `propertyType` (type: `string`):

Type of rental to search for. Leave as Any for all types. Applies to every Search and Coordinates query.

## `priceRange` (type: `string`):

Format: `min:1000,max:3000` — or just `min:1000` / `max:3000`. Filters the monthly rent.

## `bedsRange` (type: `string`):

Number of bedrooms, e.g. `min:1` or `min:1,max:3`. Use `min:0` to include studios.

## `bathsRange` (type: `string`):

Number of bathrooms, e.g. `min:1` or `min:1,max:2`.

## `petsAllowed` (type: `string`):

Filter for listings that allow pets.

## `sortOrder` (type: `string`):

Result ordering for `/search/bylocation`, `/search/bycoordinates` and `/search/byurl`.

## `pages` (type: `integer`):

How many result pages to fetch for each location / coordinate / URL search.

## `resultCount` (type: `integer`):

Listings per page for every search (1–100).

## `autocomplete_inputs` (type: `array`):

Resolve a city / neighborhood / ZIP to the Hotpads area record used by Search, via `/autocomplete`. Each suggestion = one row (id, type, name, city, state).

## Actor input object example

```json
{
  "property_inputs": [
    "4y217cc1nzpm3",
    "https://hotpads.com/111-worth-new-york-ny-10013-skg1ra/pad"
  ],
  "search_inputs": [
    "New York, NY"
  ],
  "coordinate_inputs": [
    "40.7128,-74.006,1"
  ],
  "propertyType": "",
  "priceRange": "",
  "bedsRange": "",
  "bathsRange": "",
  "petsAllowed": "",
  "sortOrder": "Newest",
  "pages": 1,
  "resultCount": 30,
  "autocomplete_inputs": [
    "Brooklyn"
  ]
}
```

# 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 = {
    "property_inputs": [
        "4y217cc1nzpm3",
        "https://hotpads.com/111-worth-new-york-ny-10013-skg1ra/pad"
    ],
    "search_inputs": [
        "New York, NY"
    ],
    "coordinate_inputs": [
        "40.7128,-74.006,1"
    ],
    "autocomplete_inputs": [
        "Brooklyn"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("one-api/hotpads-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 = {
    "property_inputs": [
        "4y217cc1nzpm3",
        "https://hotpads.com/111-worth-new-york-ny-10013-skg1ra/pad",
    ],
    "search_inputs": ["New York, NY"],
    "coordinate_inputs": ["40.7128,-74.006,1"],
    "autocomplete_inputs": ["Brooklyn"],
}

# Run the Actor and wait for it to finish
run = client.actor("one-api/hotpads-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 '{
  "property_inputs": [
    "4y217cc1nzpm3",
    "https://hotpads.com/111-worth-new-york-ny-10013-skg1ra/pad"
  ],
  "search_inputs": [
    "New York, NY"
  ],
  "coordinate_inputs": [
    "40.7128,-74.006,1"
  ],
  "autocomplete_inputs": [
    "Brooklyn"
  ]
}' |
apify call one-api/hotpads-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=one-api/hotpads-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/1aTqXdVKnkaY06m3N/builds/3rfbhkhjUYBGc5Mca/openapi.json