Zillow

Zillow Search

Search Zillow listings using a city/neighborhood/postal query, a region ID, or map bounds. Filter sale, rental and sold inventory by property details, amenities and listing selections. Filter and location selections must be retained by the source; omitted optional listing details remain zero values. Query and region_id are mutually exclusive. Rental-only and sale-only filters require the corresponding status_type.

post/v1/zillow/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/zillow/search
  • Auth: API key in header x-api-key

Request body

querystring

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

pageinteger

One-based page number.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

region_idstring

Zillow region identifier; use it instead of query.

map_boundsstring

Search rectangle as north,east,south,west.

status_type'sale' | 'rent' | 'sold'

Listing market; defaults to sale.

pricestring

Sale price or monthly rental payment as min or min,max; omit the minimum for a maximum-only range.

bedsstring

Bedroom count as min or min,max; omit the minimum for a maximum-only range.

bathsstring

Bathroom count as min or min,max; omit the minimum for a maximum-only range.

sqftstring

Floor area in square feet as min or min,max; omit the minimum for a maximum-only range.

year_builtstring

Construction year as min or min,max; omit the minimum for a maximum-only range.

lot_sizestring

Lot area in square feet as min or min,max; omit the minimum for a maximum-only range.

has_garageboolean

Require a garage.

single_storyboolean

Require a single story.

price_reductionboolean

Require a price reduction.

hide_no_date_listingsboolean

Hide rentals with no availability date; requires move_in_date when true.

short_term_leaseboolean

Require a short-term rental lease.

home_typestring

Complete comma-separated selection of property types; rental choices differ.

amenitiesstring

Comma-separated required amenities; rental-only choices require status_type=rent.

viewstring

Comma-separated required views.

basementstring

Comma-separated basement types for sale or sold properties.

listing_typestring

Complete selection of sale listing types.

listing_statusstring

Complete selection of sale listing statuses.

toursstring

Required sale tour options.

petsstring

Required rental pet policies; no_pets is exclusive.

listing_featuresstring

Required rental listing features.

age_55_plus'include' | 'exclude' | 'only'

Include, exclude, or require age-restricted communities.

time_on_zillowstring

Maximum listing age in days, or 6m,12m,24m,36m.

keywordsstring

Comma-separated property keywords.

hoa_maxinteger

Maximum monthly HOA fee for sale or sold properties, including zero.

parking_spotsinteger

Minimum parking spaces for sale or sold properties.

space'any' | 'entire_place' | 'room'

Rental space selection.

move_in_datestring

Latest rental availability date in YYYY-MM-DD format.

sort_by'globalrelevanceex' | 'featured' | 'priced' | 'pricea' | 'paymentd' | 'paymenta' | 'days' | 'beds' | 'baths' | 'size' | 'lot' | 'priorityscore'

Native sorting; rentals use payment sorting and allow featured/priorityscore.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

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