Zillow Property

One Zillow home, or apartment building, answered as the document: `search_metadata`, `search_parameters`, `search_information`, `property`, `attribution`, `mortgage_rates` and `nearby_schools`.

GET

/v1/zillow/property

One Zillow home, or apartment building, answered as the document: search_metadata, search_parameters, search_information, property, attribution, mortgage_rates and nearby_schools. The answer is the page's first-screen query: the full price and tax history, schools, walk and transit scores of a home, comparables, nearby cities and page-view counts are not answered. An apartment building's floor_plans are complete. A page with neither a home nor a building is 404 profile_not_found after two sightings. Street View and static-map addresses (they carry Zillow's maps key) are never copied. zero_retention is not handled.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token?string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128

zpid*string

A Zillow property id (digits, a search result's zpid), or the https://www.zillow.com/... address of a page. An apartment building needs its link (its search-result zpid is lat--lng). Another host, http and look-alike hosts are a 400.

Response Body

The property, as the document. When the page could not be parsed, the usual envelope.

application/json

response

The Zillow Property document. A home has the first group of property keys, a building the second.

search_metadata*

search_parameters*

The request's own fields as sent, engine first, without cancel_token.

search_information*

The parser's own, e.g. yelp_search's; otherwise {}.

property?

attribution?

Agent, broker, MLS (mls_name, mls_id), dates.

mortgage_rates?

When the page has them.

nearby_schools?array<>

Only when the page carries schools (it did not on the pages seen).

[key: string]?any

Example Request

curl -X GET 'https://api.justserp.com/v1/zillow/property?zpid=69817587'

Example Request

curl -X GET 'https://api.justserp.com/v1/zillow/property?zpid=69817587'

Example ResponseSchema

{
  "search_metadata": {
    "id": "string",
    "status": "Success",
    "created_at": "string",
    "request_url": "string",
    "html_url": "string"
  },
  "search_parameters": {},
  "search_information": {},
  "property": {
    "zpid": "string",
    "link": "string",
    "home_status": "string",
    "home_type": "string",
    "listing_type": "string",
    "description": "string",
    "address": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "zipcode": "string",
    "county": "string",
    "neighborhood": "string",
    "latitude": 0,
    "longitude": 0,
    "price": 0,
    "currency": "string",
    "beds": 0,
    "baths": 0,
    "sqft": 0,
    "lot_size": 0,
    "lot_size_units": "string",
    "year_built": 0,
    "days_on_zillow": 0,
    "zestimate": 0,
    "rent_zestimate": 0,
    "monthly_hoa_fee": 0,
    "property_tax_rate": 0,
    "tax_assessed_value": 0,
    "last_sold_price": 0,
    "date_sold": "string",
    "mls_id": "string",
    "thumbnail": "string",
    "images": [
      "string"
    ],
    "facts_and_features": {},
    "price_history": [
      {
        "date": "string",
        "event": "string",
        "price": 0
      }
    ],
    "tax_history": [
      {}
    ],
    "listing_sub_type": {},
    "virtual_tour_url": "string",
    "brokerage_name": "string",
    "building_name": "string",
    "phone": "string",
    "amenities": [
      {}
    ],
    "unit_features": [
      {}
    ],
    "pets": [
      {}
    ],
    "walk_and_transit_scores": {},
    "available_unit_count": 0,
    "median_rent": 0,
    "floor_plans": [
      {
        "name": "string",
        "beds": 0,
        "baths": 0,
        "sqft": 0,
        "min_price": 0,
        "max_price": 0,
        "available_from": "string",
        "units": [
          {}
        ]
      }
    ]
  },
  "attribution": {},
  "mortgage_rates": {
    "thirty_year_fixed": {
      "rate": 0,
      "source": "string"
    },
    "fifteen_year_fixed": {
      "rate": 0,
      "source": "string"
    },
    "arm_5": {
      "rate": 0,
      "source": "string"
    }
  },
  "nearby_schools": [
    {}
  ]
}

{  "search_metadata": {    "id": "string",    "status": "Success",    "created_at": "string",    "request_url": "string",    "html_url": "string"  },  "search_parameters": {},  "search_information": {},  "property": {    "zpid": "string",    "link": "string",    "home_status": "string",    "home_type": "string",    "listing_type": "string",    "description": "string",    "address": "string",    "street": "string",    "city": "string",    "state": "string",    "zipcode": "string",    "county": "string",    "neighborhood": "string",    "latitude": 0,    "longitude": 0,    "price": 0,    "currency": "string",    "beds": 0,    "baths": 0,    "sqft": 0,    "lot_size": 0,    "lot_size_units": "string",    "year_built": 0,    "days_on_zillow": 0,    "zestimate": 0,    "rent_zestimate": 0,    "monthly_hoa_fee": 0,    "property_tax_rate": 0,    "tax_assessed_value": 0,    "last_sold_price": 0,    "date_sold": "string",    "mls_id": "string",    "thumbnail": "string",    "images": [      "string"    ],    "facts_and_features": {},    "price_history": [      {        "date": "string",        "event": "string",        "price": 0      }    ],    "tax_history": [      {}    ],    "listing_sub_type": {},    "virtual_tour_url": "string",    "brokerage_name": "string",    "building_name": "string",    "phone": "string",    "amenities": [      {}    ],    "unit_features": [      {}    ],    "pets": [      {}    ],    "walk_and_transit_scores": {},    "available_unit_count": 0,    "median_rent": 0,    "floor_plans": [      {        "name": "string",        "beds": 0,        "baths": 0,        "sqft": 0,        "min_price": 0,        "max_price": 0,        "available_from": "string",        "units": [          {}        ]      }    ]  },  "attribution": {},  "mortgage_rates": {    "thirty_year_fixed": {      "rate": 0,      "source": "string"    },    "fifteen_year_fixed": {      "rate": 0,      "source": "string"    },    "arm_5": {      "rate": 0,      "source": "string"    }  },  "nearby_schools": [    {}  ]}

Zillow Property

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body