---
title: "Zillow Search"
method: POST
path: "/v1/zillow/search"
tags: ["Zillow"]
---

# Zillow Search

`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`

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.

## Request body

- CatalogZillowRequest: 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.
  - `query` string: Text to search for on the selected service. At most 8,192 UTF-8 bytes.
  - `page` integer: One-based page number.
  - `device` 'desktop' | 'mobile' | 'tablet': Device presentation for the source request.
  - `html` boolean: Return the encoded original response rather than parsed JSON.
  - `zero_trace` boolean: Do not archive source or parsed response artifacts.
  - `region_id` string: Zillow region identifier; use it instead of query.
  - `map_bounds` string: Search rectangle as north,east,south,west.
  - `status_type` 'sale' | 'rent' | 'sold': Listing market; defaults to sale.
  - `price` string: Sale price or monthly rental payment as min or min,max; omit the minimum for a maximum-only range.
  - `beds` string: Bedroom count as min or min,max; omit the minimum for a maximum-only range.
  - `baths` string: Bathroom count as min or min,max; omit the minimum for a maximum-only range.
  - `sqft` string: Floor area in square feet as min or min,max; omit the minimum for a maximum-only range.
  - `year_built` string: Construction year as min or min,max; omit the minimum for a maximum-only range.
  - `lot_size` string: Lot area in square feet as min or min,max; omit the minimum for a maximum-only range.
  - `has_garage` boolean: Require a garage.
  - `single_story` boolean: Require a single story.
  - `price_reduction` boolean: Require a price reduction.
  - `hide_no_date_listings` boolean: Hide rentals with no availability date; requires move_in_date when true.
  - `short_term_lease` boolean: Require a short-term rental lease.
  - `home_type` string: Complete comma-separated selection of property types; rental choices differ.
  - `amenities` string: Comma-separated required amenities; rental-only choices require status_type=rent.
  - `view` string: Comma-separated required views.
  - `basement` string: Comma-separated basement types for sale or sold properties.
  - `listing_type` string: Complete selection of sale listing types.
  - `listing_status` string: Complete selection of sale listing statuses.
  - `tours` string: Required sale tour options.
  - `pets` string: Required rental pet policies; no_pets is exclusive.
  - `listing_features` string: Required rental listing features.
  - `age_55_plus` 'include' | 'exclude' | 'only': Include, exclude, or require age-restricted communities.
  - `time_on_zillow` string: Maximum listing age in days, or 6m,12m,24m,36m.
  - `keywords` string: Comma-separated property keywords.
  - `hoa_max` integer: Maximum monthly HOA fee for sale or sold properties, including zero.
  - `parking_spots` integer: Minimum parking spaces for sale or sold properties.
  - `space` 'any' | 'entire_place' | 'room': Rental space selection.
  - `move_in_date` string: 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_restrictor` string, 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_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

## Response `200`

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.

- CatalogZillowResponse
  - `success` true, required
  - `request_id` string, uuid, required
  - `data` union, required
    - MarkdownSearchData
      - `format` union, required
        - ''
        - 'md'
      - `content` string, required: Markdown derived from the parsed result, after any json_restrictor selection.
    - ProjectedSearchData
      - `format` union, required
        - ''
        - 'json'
      - `content` object, required: Only fields selected by json_restrictor. Selected fields retain their declared types and zero defaults.
    - object
      - `format` 'json', required
      - `content` object, required
        - `has_next_page` boolean, required
        - `next_page_token` string, required: Opaque continuation token valid for one hour and the same account. Retain search parameters, device, and result limit. Restart pagination if the token is expired or rejected; tokens from before the authenticated-token rollout cannot be reused.
        - `results` object[], required
          - `address` union, required
            - string
            - object
            - string[]
          - `area_sqft` number, required
          - `bathrooms` number, required
          - `bedrooms` number, required
          - `broker` string, required
          - `category` string, required
          - `coordinates` object, required
            - `latitude` number, required
            - `longitude` number, required
          - `description` string, required
          - `id` string, required
          - `latitude` number, required
          - `listing_type` string, required
          - `longitude` number, required
          - `name` string, required
          - `phone` string, required
          - `position` integer, required
          - `price` union, required
            - string
            - number
          - `price_value` number, required
          - `rank` integer, required
          - `rating` union, required
            - number
            - string
          - `rating_max` number, required
          - `rating_source` string, required
          - `review_count` union, required
            - number
            - string
          - `snippet` string, required
          - `status` string, required
          - `thumbnail` string, required
          - `title` string, required
          - `type` string, required
          - `url` string, required
          - `website` string, required
        - `search_parameters` object, required
          - `age_55_plus` string, required
          - `amenities` string, required
          - `basement` string, required
          - `baths` string, required
          - `beds` string, required
          - `device` string, required
          - `engine` string, required
          - `has_garage` boolean, required
          - `hide_no_date_listings` boolean, required
          - `hoa_max` number, required
          - `home_type` string, required
          - `keywords` string, required
          - `listing_features` string, required
          - `listing_status` string, required
          - `listing_type` string, required
          - `lot_size` string, required
          - `map_bounds` string, required
          - `move_in_date` string, required
          - `operation` string, required
          - `page` integer, required
          - `pagination_limited` boolean, required: True when further pagination is unavailable. A completed source-stale request can contain verified results or an empty array; next_page_token is an empty string.
          - `pagination_reason` string, required: stale_cursor means a valid continuation was fetched but its source inventory changed. The HTTP 200 response is billable; keep any verified results and restart pagination.
          - `parking_spots` number, required
          - `pets` string, required
          - `price` string, required
          - `price_reduction` boolean, required
          - `query` string, required
          - `region_id` string, required
          - `short_term_lease` boolean, required
          - `single_story` boolean, required
          - `sort_by` string, required
          - `space` string, required
          - `sqft` string, required
          - `status_type` string, required
          - `time_on_zillow` string, required
          - `tours` string, required
          - `type` string, required
          - `view` string, required
          - `year_built` string, required
        - `serp_features` object[], required
          - `confidence` number, required
          - `engine` string, required
          - `extracted_at` string, required
          - `id` string, required
          - `items` object[], required
            - `link` string, required
            - `product_id` string, required
            - `text` string, required
            - `thumbnail` string, required
            - `title` string, required
          - `links` object[], required
            - `title` string, required
            - `url` string, required
          - `position` object, required
            - `absolute` integer, required
          - `source_result_ids` string[], required
          - `text` string, required
          - `title` string, required
          - `type` string, required
    - GoogleHtmlSearchData
      - `format` union, required
        - ''
        - 'html+br+base64'
      - `content` string, byte, required: Base64-encoded bytes. Decode Base64 first, then decompress the result with Brotli. Available deferred or lazy-loaded thumbnail sources are placed in image src attributes, within size limits; image and video files are not downloaded. When rewrite_links is true, already-resolved opaque Google anchor links use their destination URLs. Unresolved links are preserved.

## Other responses

- `400`: The JSON body, source selection, or continuation is invalid. Locally malformed, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. A source may also reject an otherwise well-formed selector after acquisition. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
- `401`: The API token is missing, invalid, expired, or revoked.
- `402`: No credits remain.
- `429`: Account rate limit exceeded.
- `500`: The request could not be completed.

---

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