Zillow

get/zillow/search

Request

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

Query parameters

latitudenumber nullable

Centre latitude of the search area.

longitudenumber nullable

Centre longitude of the search area.

radius_minumber nullable

Search radius around the centre point, up to 100 miles. Required with a latitude and longitude centre point unless a complete bounding box is given instead.

north_latitudenumber nullable

Northern bound of an explicit bounding box.

south_latitudenumber nullable

Southern bound of an explicit bounding box.

east_longitudenumber nullable

Eastern bound of an explicit bounding box.

west_longitudenumber nullable

Western bound of an explicit bounding box.

region_ids[]integer[]

Region ids from the autocomplete endpoint, up to 20.

region_id_typeinteger nullable

How the region ids are interpreted: 0 state, 1 county, 2 city, 3 ZIP code, 5 neighborhood. The autocomplete endpoint returns the matching value as region_id_type.

polygonstring nullable

Custom search boundary as lat,lon|lat,lon|:lat,lon|lat,lon: points separated by |, polygons separated by |:.

listing_category'all' | 'category1' | 'category2' | 'null' nullable

category1 for sale (default), category2 for rent, or all.

sort_order'baths' | 'yearBuilt' | 'price' | 'relevance' | 'beds' | 'daysOn' | 'featured' | 'livingArea' | 'lotArea' | 'nearby' | 'recentlyChanged' | 'rentalDays' | 'rentalPriorityScore' | 'null' nullable

One of relevance, price, beds, baths, yearBuilt, daysOn, featured, livingArea, lotArea, nearby, recentlyChanged, rentalDays, rentalPriorityScore.

sort_ascendingboolean nullable

Sort lowest first instead of highest first.

min_priceinteger nullable

Lowest list price to include.

max_priceinteger nullable

Highest list price to include.

min_bedsinteger nullable

Fewest bedrooms to include.

max_bedsinteger nullable

Most bedrooms to include.

min_bathsinteger nullable

Fewest bathrooms to include.

max_bathsinteger nullable

Most bathrooms to include.

living_area_mininteger nullable

Smallest living area in square feet.

lot_size_mininteger nullable

Smallest lot size in square feet.

year_built_mininteger nullable

Earliest construction year.

home_statuses[]string[]

Statuses from one listing type only: for-sale statuses (fsba, fsbo, newConstruction, comingSoon, auction, foreclosure, foreclosed, preforeclosure), forRent, or recentlySold. Defaults to every for-sale status, or forRent when listing_category is category2.

keywordsstring nullable

Free-text filter applied to listings.

zoom_levelinteger nullable

Map zoom level, 6 to 25.

include_off_marketboolean nullable

Supplement the results with off-market listings. The totals reported then cover a larger population.

allow_emptyboolean nullable

Return an empty result set for an area with no matches instead of raising.

pageinteger nullable

Page number, 1-based.

page_sizeinteger nullable

Rows per page. page * page_size must not exceed 1000.

Response

Changes

No recorded changes to this operation across all 3 revisions of this API.