# 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:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 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 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

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

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Hotpads.com Property Scraper",
        "description": "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.",
        "version": "1.0",
        "x-build-id": "3rfbhkhjUYBGc5Mca"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/one-api~hotpads-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-one-api-hotpads-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/one-api~hotpads-scraper/runs": {
            "post": {
                "operationId": "runs-sync-one-api-hotpads-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/one-api~hotpads-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-one-api-hotpads-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": {
                    "property_inputs": {
                        "title": "Listing id or hotpads.com URL (one per line)",
                        "type": "array",
                        "description": "Auto-detects each entry and calls the right endpoint:\n• A Hotpads listing id (e.g. `4y217cc1nzpm3`) → `/details/byid`\n• A `https://hotpads.com/...` listing URL → `/details/byurl`\n\nEach row = one full rental record (price, beds, baths, sqft, units & floorplans, amenities, pet policy, schools, photos, contact company + phone, lease terms, costs).",
                        "items": {
                            "type": "string"
                        }
                    },
                    "search_inputs": {
                        "title": "Location or hotpads.com search URL (one per line)",
                        "type": "array",
                        "description": "Auto-detects each entry and routes to the right `/search/*` endpoint:\n• A hotpads.com results URL, e.g. `https://hotpads.com/new-york-ny/apartments-for-rent` → `/search/byurl`\n• Anything else (city, neighborhood or ZIP, e.g. `New York, NY`, `Brooklyn`, `78758`) → `/search/bylocation`\n\nThe filters below apply to every search. Each hit returns one row per rental listing.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "coordinate_inputs": {
                        "title": "Coordinates: lat,lon or lat,lon,radiusMiles (one per line)",
                        "type": "array",
                        "description": "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.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "propertyType": {
                        "title": "Property type",
                        "enum": [
                            "",
                            "apartment",
                            "house",
                            "condo",
                            "townhome",
                            "room",
                            "multifamily"
                        ],
                        "type": "string",
                        "description": "Type of rental to search for. Leave as Any for all types. Applies to every Search and Coordinates query.",
                        "default": ""
                    },
                    "priceRange": {
                        "title": "Monthly rent range ($)",
                        "type": "string",
                        "description": "Format: `min:1000,max:3000` — or just `min:1000` / `max:3000`. Filters the monthly rent.",
                        "default": ""
                    },
                    "bedsRange": {
                        "title": "Bedrooms",
                        "type": "string",
                        "description": "Number of bedrooms, e.g. `min:1` or `min:1,max:3`. Use `min:0` to include studios.",
                        "default": ""
                    },
                    "bathsRange": {
                        "title": "Bathrooms",
                        "type": "string",
                        "description": "Number of bathrooms, e.g. `min:1` or `min:1,max:2`.",
                        "default": ""
                    },
                    "petsAllowed": {
                        "title": "Pets allowed",
                        "enum": [
                            "",
                            "dog",
                            "cat",
                            "dog,cat"
                        ],
                        "type": "string",
                        "description": "Filter for listings that allow pets.",
                        "default": ""
                    },
                    "sortOrder": {
                        "title": "Sort order",
                        "enum": [
                            "Newest",
                            "Price_Low_to_High",
                            "Price_High_to_Low",
                            "Distance"
                        ],
                        "type": "string",
                        "description": "Result ordering for `/search/bylocation`, `/search/bycoordinates` and `/search/byurl`.",
                        "default": "Newest"
                    },
                    "pages": {
                        "title": "Pages per search",
                        "minimum": 1,
                        "maximum": 20,
                        "type": "integer",
                        "description": "How many result pages to fetch for each location / coordinate / URL search.",
                        "default": 1
                    },
                    "resultCount": {
                        "title": "Results per page",
                        "minimum": 1,
                        "maximum": 100,
                        "type": "integer",
                        "description": "Listings per page for every search (1–100).",
                        "default": 30
                    },
                    "autocomplete_inputs": {
                        "title": "Location text to resolve (one per line)",
                        "type": "array",
                        "description": "Resolve a city / neighborhood / ZIP to the Hotpads area record used by Search, via `/autocomplete`. Each suggestion = one row (id, type, name, city, state).",
                        "items": {
                            "type": "string"
                        }
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```