---
title: "GET /hotpads/search"
method: GET
path: "/hotpads/search"
tags: ["Hotpads"]
---

# GET /hotpads/search

`GET /hotpads/search`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/hotpads/search`
- Auth: API key in header `X-API-KEY`

## Query parameters

- `area` string, required
- `type` 'apartments' | 'houses' | 'condos' | 'townhomes'
- `beds` integer
- `min_price` integer
- `max_price` integer
- `page` integer

## Response `200`

- union
  - string
  - object
    - `success` boolean, required
    - `data` string, required
    - `meta` object, required
      - `endpoint_family` string, required
      - `billable` boolean, required

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `404`: The requested HotPads area does not exist. This response is not billable.
- `422`: A required query parameter is missing or invalid. This response is not billable.
- `503`: HotPads blocked the request on every exit, could not be reached, or answered with a page that no longer matches the documented contract (code UPSTREAM_BLOCKED, UPSTREAM_UNAVAILABLE or PARSER_DRIFT). This response is not billable.

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/1e1aa78ff103?raw)