Zillow search API

Search homes for sale, for rent or sold

curl --request POST \
  --url https://api.stophy.dev/v1/zillow/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": "Austin, TX",
  "daysOnZillow": "30Days",
  "hasPool": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({location: 'Austin, TX', daysOnZillow: '30Days', hasPool: true})
};

fetch('https://api.stophy.dev/v1/zillow/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/zillow/search"

payload = {
    "location": "Austin, TX",
    "daysOnZillow": "30Days",
    "hasPool": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "propertyUrl": "<string>",
        "status": "forSale",
        "propertyId": "<string>",
        "statusText": "<string>",
        "price": 1,
        "priceCurrency": "USD",
        "addressFull": "<string>",
        "addressStreet": "<string>",
        "addressCity": "<string>",
        "addressRegion": "<string>",
        "addressPostalCode": "<string>",
        "latitude": 0,
        "longitude": 0,
        "bedrooms": 123,
        "bathrooms": 123,
        "sqft": 123,
        "homeType": "<string>",
        "daysOnZillow": 0,
        "lastSoldAt": "2023-11-07T05:31:56Z",
        "zestimate": 123,
        "rentZestimate": 123,
        "brokerName": "<string>",
        "imageUrl": "<string>",
        "buildingName": "<string>",
        "buildingMinRent": 123,
        "buildingMaxRent": 123,
        "buildingAvailableUnits": 0,
        "units": [
          {
            "bedrooms": 123,
            "price": 1
          }
        ]
      }
    ],
    "page": 4503599627370496,
    "total": 0,
    "totalPages": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

zillow

Search homes for sale, for rent or sold

curl --request POST \
  --url https://api.stophy.dev/v1/zillow/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": "Austin, TX",
  "daysOnZillow": "30Days",
  "hasPool": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({location: 'Austin, TX', daysOnZillow: '30Days', hasPool: true})
};

fetch('https://api.stophy.dev/v1/zillow/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/zillow/search"

payload = {
    "location": "Austin, TX",
    "daysOnZillow": "30Days",
    "hasPool": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "propertyUrl": "<string>",
        "status": "forSale",
        "propertyId": "<string>",
        "statusText": "<string>",
        "price": 1,
        "priceCurrency": "USD",
        "addressFull": "<string>",
        "addressStreet": "<string>",
        "addressCity": "<string>",
        "addressRegion": "<string>",
        "addressPostalCode": "<string>",
        "latitude": 0,
        "longitude": 0,
        "bedrooms": 123,
        "bathrooms": 123,
        "sqft": 123,
        "homeType": "<string>",
        "daysOnZillow": 0,
        "lastSoldAt": "2023-11-07T05:31:56Z",
        "zestimate": 123,
        "rentZestimate": 123,
        "brokerName": "<string>",
        "imageUrl": "<string>",
        "buildingName": "<string>",
        "buildingMinRent": 123,
        "buildingMaxRent": 123,
        "buildingAvailableUnits": 0,
        "units": [
          {
            "bedrooms": 123,
            "price": 1
          }
        ]
      }
    ],
    "page": 4503599627370496,
    "total": 0,
    "totalPages": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Searches homes for sale, for rent or sold.

Request

location is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.zillow.search({ location: "Austin, TX", daysOnZillow: "30Days", hasPool: true });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.zillow.search(location="Austin, TX", days_on_zillow="30Days", has_pool=True)
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/zillow/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"location":"Austin, TX","daysOnZillow":"30Days","hasPool":true}'

stophy zillow search "Austin, TX" --daysOnZillow 30Days --hasPool

Response

If successful, the response body contains the standard envelope. data.results[] contains the homes, each with its price, address, size and status. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "propertyId": "29399286",
        "propertyUrl": "https://www.zillow.com/homedetails/106-W-32nd-St-Austin-TX-78705/29399286_zpid/",
        "status": "forSale",
        "statusText": "Active",
        "price": 2200000,
        "priceCurrency": "USD",
        "addressFull": "106 W 32nd St, Austin, TX 78705",
        "addressStreet": "106 W 32nd St",
        "addressCity": "Austin",
        "addressRegion": "TX",
        "addressPostalCode": "78705",
        "latitude": 30.297354,
        "longitude": -97.736565,
        "bedrooms": 4,
        "bathrooms": 3,
        "sqft": 2911,
        "homeType": "SINGLE_FAMILY",
        "daysOnZillow": 2,
        "brokerName": "Kuper Sotheby's Int'l Realty",
        "imageUrl": "https://photos.zillowstatic.com/fp/53de2e39052ef79395ed54f9e73dfded-p_e.jpg"
      }
    ],
    "total": 151,
    "page": 1,
    "totalPages": 4
  },
  "creditsUsed": 2,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`price`	number	Asking price, monthly rent, or the sale price of a sold home. Omitted when Zillow shows none, such as for sold homes in states that keep sale prices private.
`page`	integer	The page number of this response.
`totalPages`	integer	The number of pages that match the request.
`total`	integer	The total number of matching results, across all pages.
`statusText`	string	The listing status label as displayed by Zillow, such as `Active`.
`daysOnZillow`	integer	The number of days since the home was listed.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`status`	string	Homes for sale, for rent or sold. Acceptable values are `forSale`, `forRent` and `sold`. If unset, defaults to `forSale`.
`minPrice`	number	The minimum price.
`maxPrice`	number	The maximum price.
`minBedrooms`	integer	The minimum number of bedrooms. Must be between 0 and 20.
`maxBedrooms`	integer	The maximum number of bedrooms. Must be between 0 and 20.
`minBathrooms`	number	The minimum number of bathrooms. Must be between 0 and 20.
`minSqft`	integer	The minimum size, in square feet.
`maxSqft`	integer	The maximum size, in square feet.
`minLotSize`	integer	The minimum lot, in square feet.
`maxLotSize`	integer	The maximum lot, in square feet.
`minYearBuilt`	integer	Restricts results to homes built in or after this year. Must be between 1600 and 2100.
`maxYearBuilt`	integer	Restricts results to homes built in or before this year. Must be between 1600 and 2100.
`maxHoa`	number	The maximum monthly HOA fee, in USD. `0` means no HOA fee.
`minParkingSpots`	integer	Restricts results to homes with at least this many parking spots. Must be between 1 and 4.
`daysOnZillow`	string	Restricts results to homes 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 that time. Acceptable values are `1Day`, `7Days`, `14Days`, `30Days`, `90Days`, `6Months`, `12Months`, `24Months` and `36Months`.
`hasPool`	boolean	Restricts results to homes with a pool. If unset, defaults to `false`.
`hasGarage`	boolean	Restricts results to homes with a garage. If unset, defaults to `false`.
`hasAirConditioning`	boolean	Restricts results to homes with air conditioning. If unset, defaults to `false`.
`isWaterfront`	boolean	Restricts results to waterfront homes. If unset, defaults to `false`.
`singleStory`	boolean	Restricts results to single-story homes. If unset, defaults to `false`.
`openHouse`	boolean	Restricts results to homes with an open house. If unset, defaults to `false`.
`priceReduced`	boolean	Restricts results to homes with a price cut. If unset, defaults to `false`.
`has3dTour`	boolean	Restricts results to homes with a 3D tour. If unset, defaults to `false`.
`petsAllowed`	boolean	Restricts results to places that allow pets. Rentals only: set `status` to `forRent`. If unset, defaults to `false`.
`homeTypes`	string[]	Restricts results to these kinds of home. Acceptable values are `house`, `townhouse`, `multiFamily`, `condo`, `land`, `apartment` and `manufactured`.
`sort`	string	Specifies the order of the homes. Acceptable values are `relevance`, `newest`, `priceHigh`, `priceLow`, `bedrooms`, `bathrooms`, `squareFeet` and `lotSize`. If unset, defaults to `relevance`.
`keywords`	string	Words the listing must mention, such as “pool” or “fixer upper”.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 20. If unset, defaults to `1`.

Billing

Each successful request consumes 2 credits, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 20.

Zillow property: Accepts propertyUrl. Returns a home’s details, price and Zestimate.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

location

string

required

Required string length: 2 - 200

status

enum<string>

default:forSale

Available options:

forSale,

forRent,

sold

minPrice

number

Required range: x >= 0

maxPrice

number

Required range: x >= 0

minBedrooms

integer

Required range: 0 <= x <= 20

maxBedrooms

integer

Required range: 0 <= x <= 20

minBathrooms

number

Required range: 0 <= x <= 20

minSqft

integer

Required range: 0 <= x <= 9007199254740991

maxSqft

integer

Required range: 0 <= x <= 9007199254740991

minLotSize

integer

Zillow's own Lot size minimum, in square feet.

Required range: 0 <= x <= 9007199254740991

maxLotSize

integer

Zillow's own Lot size maximum, in square feet.

Required range: 0 <= x <= 9007199254740991

minYearBuilt

integer

Zillow's own Year built minimum.

Required range: 1600 <= x <= 2100

maxYearBuilt

integer

Zillow's own Year built maximum.

Required range: 1600 <= x <= 2100

maxHoa

number

Zillow's own Max HOA: the highest monthly HOA fee in USD. 0 means no HOA fee.

Required range: x >= 0

minParkingSpots

integer

Zillow's own Parking spots filter: at least this many (1 to 4).

Required range: 1 <= x <= 4

daysOnZillow

enum<string>

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.

Available options:

1Day,

7Days,

14Days,

30Days,

90Days,

6Months,

12Months,

24Months,

36Months

hasPool

boolean

default:false

Zillow's own "Must have pool" filter. Only matching homes when true.

hasGarage

boolean

default:false

Zillow's own "Must have garage" filter. Only matching homes when true.

hasAirConditioning

boolean

default:false

Zillow's own "Must have A/C" filter. Only matching homes when true.

isWaterfront

boolean

default:false

Zillow's own "Waterfront" filter. Only matching homes when true.

singleStory

boolean

default:false

Zillow's own "Single-story only" filter. Only matching homes when true.

openHouse

boolean

default:false

Zillow's own "Must have open house" filter. Only matching homes when true.

priceReduced

boolean

default:false

Zillow's own "Must have price reduction" filter. Only matching homes when true.

has3dTour

boolean

default:false

Zillow's own "Must have 3D Tour" filter. Only matching homes when true.

petsAllowed

boolean

default:false

Zillow's own "Pets Allowed" filter. Only matching homes when true. Rentals only: needs status forRent.

homeTypes

enum<string>[]

Minimum array length: 1

Available options:

house,

townhouse,

multiFamily,

condo,

land,

apartment,

manufactured

sort

enum<string>

default:relevance

Available options:

relevance,

newest,

priceHigh,

priceLow,

bedrooms,

bathrooms,

squareFeet,

lotSize

keywords

string

Words the listing must mention, like "pool" or "fixer upper".

Required string length: 1 - 200

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 20

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Zillow search API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods