> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Zillow search

> Read a Zillow search page for a place as JSON with the zillow-search parser. $4 per 1,000 calls. Send the page to scrape.

Reads a Zillow search page for a place, like zillow\.com/homes/San-Francisco,-CA\_rb/, and returns a list of listings as JSON.

## Make a request

Send the page's URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with a `json` format that names the parser. Get an API key in the [Quickstart](https://docs.stophy.dev/quickstart).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.zillow.com/homes/San-Francisco,-CA_rb/","formats":[{"type":"json","parser":"zillow-search"}]}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.zillow.com/homes/San-Francisco,-CA_rb/",
    formats: [{ type: "json", parser: "zillow-search" }],
  }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/scrape",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "url": "https://www.zillow.com/homes/San-Francisco,-CA_rb/",
        "formats": [{"type": "json", "parser": "zillow-search"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `results`, `cursor`, `page` and `total`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "results": [
        {
          "id": "15088840",
          "url": "https://www.zillow.com/homedetails/157-28th-Ave-San-Francisco-CA-94121/15088840_zpid/",
          "title": "157 28th Ave, San Francisco, CA 94121",
          "description": null,
          "price": {
            "amount": 10000000,
            "currency": "USD"
          },
          "pricePeriod": "sale",
          "status": "forSale",
          "address": "157 28th Ave, San Francisco, CA 94121",
          "location": {
            "latitude": 37.785973,
            "longitude": -122.48865
          },
          "bedrooms": 5,
          "bathrooms": 7,
          "area": {
            "amount": 6844,
            "unit": "sqft"
          },
          "propertyType": "SINGLE_FAMILY",
          "rating": null,
          "reviewCount": null,
          "images": [
            "https://photos.zillowstatic.com/fp/562cd6643e9850b83ae5166c89acb7f6-p_e.jpg"
          ],
          "host": null,
          "statusText": "House for sale",
          "addressStreet": "157 28th Ave",
          "addressCity": "San Francisco",
          "addressRegion": "CA",
          "addressPostalCode": "94121",
          "daysOnZillow": 5,
          "lastSoldAt": null,
          "zestimate": 10400300,
          "rentZestimate": null,
          "brokerName": "Golden Gate Sotheby's Internat",
          "buildingName": null,
          "buildingMinRent": null,
          "buildingMaxRent": null,
          "buildingAvailableUnits": null,
          "units": []
        }
      ],
      "cursor": null,
      "page": 1,
      "total": 981,
      "totalPages": 20
    }
  }
}
```

## Options

Send options in the `options` object of the `json` format.

| Option | What it does |
| - | - |
| `minLotSize` | Zillow's own Lot size minimum, in square feet. |
| `maxLotSize` | Zillow's own Lot size maximum, in square feet. |
| `minYearBuilt` | Zillow's own Year built minimum. |
| `maxYearBuilt` | Zillow's own Year built maximum. |
| `maxHoa` | Zillow's own Max HOA: the highest monthly HOA fee in USD. 0 means no HOA fee. |
| `minParkingSpots` | Zillow's own Parking spots filter: at least this many (1 to 4). |
| `daysOnZillow` | Zillow's own Days on Zillow filter: listed in the last 1, 7, 14, 30 or 90 days, or 6, 12, 24 or 36 months. For sold homes it means sold in the last N. |
| `hasPool` | Zillow's own "Must have pool" filter. Only matching homes when true. |
| `hasGarage` | Zillow's own "Must have garage" filter. Only matching homes when true. |
| `hasAirConditioning` | Zillow's own "Must have A/C" filter. Only matching homes when true. |
| `isWaterfront` | Zillow's own "Waterfront" filter. Only matching homes when true. |
| `singleStory` | Zillow's own "Single-story only" filter. Only matching homes when true. |
| `openHouse` | Zillow's own "Must have open house" filter. Only matching homes when true. |
| `priceReduced` | Zillow's own "Must have price reduction" filter. Only matching homes when true. |
| `has3dTour` | Zillow's own "Must have 3D Tour" filter. Only matching homes when true. |
| `petsAllowed` | Zillow's own "Pets Allowed" filter. Only matching homes when true. Rentals only: needs status forRent. |
| `homeTypes` | Zillow's own Home type filter. On rentals, apartment and condo are one Zillow category (apartments, condos and co-ops), so either one returns both. |
| `sort` | Zillow's own sort. priceHigh, bedrooms, bathrooms, squareFeet and lotSize put the largest first, and priceLow the smallest. A rental building sits where its highest unit rent falls. |
| `keywords` | Words the listing must mention, like "pool" or "fixer upper". |
| `page` | Page number, starting at 1. |

It also takes `status`, `minPrice`, `maxPrice`, `minBedrooms`, `maxBedrooms`, `minBathrooms`, `minSqft` and `maxSqft`.

## Price

\$4 per 1,000 calls. See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Limits and errors

* The URL must be a Zillow search page for a place, like zillow\.com/homes/San-Francisco,-CA\_rb/. Any other URL fails with `invalidRequest`.
* The answer comes back in `data.json`. If the page cannot be read, the call fails with an error code from [Errors](https://docs.stophy.dev/api-reference/errors.md).

## Related

* [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers) lists every parser.
* [Scrape](https://docs.stophy.dev/scrape/overview) has the options every scrape takes.
* [Zillow property](https://docs.stophy.dev/scrape/prebuilt-parsers/real-estate/zillow-property.md)
* [Realtor.com search](https://docs.stophy.dev/scrape/prebuilt-parsers/real-estate/realtor-search.md)
* [Realtor.com property](https://docs.stophy.dev/scrape/prebuilt-parsers/real-estate/realtor-property.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.