Properties

Look up a property by Zillow URL

Fetch the full property record for a Zillow URL (homedetails, /b/, /community/, or /apartments/). When extract_units is not disabled and the URL is a multi-unit building, data is returned as an array of unit records. Costs 1 credit per record returned; failed calls are free.

get/v1/properties/by-url

Request

  • Base URL: https://api.zillapi.com
  • URL: https://api.zillapi.com/v1/properties/by-url
  • Auth: HTTP bearer

Query parameters

urlstring uri required

Full Zillow URL: homedetails, /b/, /community/, or /apartments/.

status'FOR_SALE' | 'RECENTLY_SOLD' | 'FOR_RENT'

Listing status to resolve.

extract_units'disabled' | 'all' | 'for_sale' | 'recently_sold' | 'for_rent' | 'off_market'

For building URLs, which units to extract. disabled returns the parent record only; any other value returns an array of unit records.

fieldsstring

Comma-separated dotted-path field projection, e.g. zpid,address.streetAddress,priceHistory[0].price.

Response

Single property (an array of Property when extract_units is set and the URL is a multi-unit building)

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.