Zillow API Network
GetUpdatedPropertyDetails API
For a specified property, the GetUpdatedPropertyDetails API returns all of the home facts that have been edited by the home's owner or agent. The result set contains the following attributes:
- Property address
- Zillow property identifier
- Posting details such as the agent name, MLS number, price, and posting type (For Sale or Make Me Move ™)
- Up to five photos of the property
- Updated home facts such as beds, baths, square footage, home description, and neighborhood and school names
The GetUpdatedPropertyDetails API Web Service is located at: http://www.zillow.com/webservice/GetUpdatedPropertyDetails.htm
The parameters to the API are:
| Parameter | Description | Required |
|---|---|---|
| zws-id | The Zillow Web Service Identifier; each subscriber to Zillow Web Services is uniquely identified by an ID sequence and every request to Web services requires this ID | Yes |
| zpid | The Zillow Property ID for the property for which to obtain information; the parameter type is an integer | Yes |
The result set of the API:
| Parameter | Description |
|---|---|
| zpid | Zillow property ID for the property. |
| Full address | The complete address for the property:
|
| Posting Details |
|
| Links | URLs to specific Zillow pages for this property:
|
| Images |
|
| Edited Home Facts |
|
| Home description | The description of the home as entered by the owner or agent |
| Neighborhood | Name of the neighborhood |
| School district | Name of the school district |
| Elementary school | Name of the elementary school |
| Middle school | Name of the middle school |
| Limit-warning | If this field is set to "true", it means you are approaching your call limit. It appears under the 'message' element in the API result set: <message> <text>Request successfully processed</text> <code>0</code> <limit-warning>true</limit-warning> </message> This output field will not be returned if it is false. |
Messages and Codes
| Error code | Description | Resolution |
|---|---|---|
| 0 | Request successfully processed | |
| 1 | Service error-there was a server-side error while processing the request | Check to see if your url is properly formed: delimiters, character cases, etc. |
| 2 | The specified ZWSID parameter was invalid or not specified in the request | Check if you have provided a ZWSID in your API call. If yes, check if the ZWSID is keyed in correctly. If it still doesn't work, contact Zillow to get help on fixing your ZWSID. |
| 3 | Web services are currently unavailable | The Zillow Web Service is currently not available. Please come back later and try again. |
| 4 | The API call is currently unavailable | The Zillow Web Service is currently not available. Please come back later and try again. |
| 500 | The specified zpid parameter was not specified or invalid | The zpid parameter you have provided is not valid. Please check if your zpid is correct and try again. |
| 501 | Protected data is unavailable through API | The updated data for the property you are requesting is not available due to legal restrictions. |
| 502 | No updated data is available for this property | The zpid you provided does not have any updated property details. |
Sample Calls
Below is an example of calling the GetUpdatedPropertyDetails API for zpid 48749425:
http://www.zillow.com/webservice/GetUpdatedPropertyDetails.htm?zws-id=<ZWSID>;&zpid=48749425
Sample Output
<?xml version="1.0" encoding="utf-8" ?> - <UpdatedPropertyDetails:updatedPropertyDetails xsi:schemaLocation="http://www.zillow.com/static/xsd/UpdatedPropertyDetails.xsd /vstatic/e6e5f302965f32ad16114f7a97ba3d89/static/xsd/UpdatedPropertyDetails.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:UpdatedPropertyDetails="http://www.zillow.com/static/xsd/UpdatedPropertyDetails.xsd"> - <request> <zpid>48749425</zpid> </request> - <message> <text>Request successfully processed</text> <code>0</code> </message> - <response> <zpid>48749425</zpid> - <pageViewCount> <currentMonth>172</currentMonth> <total>4149</total> </pageViewCount> - <address> <street>2114 Bigelow Ave N</street> <zipcode>98109</zipcode> <city>Seattle</city> <state>WA</state> <latitude>47.637924</latitude> <longitude>-122.347929</longitude> </address> - <posting> <status>Active</status> <agentName>John Blacksmith</agentName> <agentProfileUrl>/profile/John.Blacksmith</agentProfileUrl> <brokerage>Lake and Company Real Estate</brokerage> <type>For sale by agent</type> <lastUpdatedDate>2008-06-05 10:28:00.0</lastUpdatedDate> <externalUrl>http://mls.lakere.com/srch_mls/detail.php?mode=ag&LN=28097669&t=listings&l=</externalUrl> <mls>28097669</mls> </posting> <price currency="USD">1290000</price> - <links> <homeDetails>http://www.zillow.com/HomeDetails.htm?zprop=48749425</homeDetails> <photoGallery>http://www.zillow.com/Gallery.htm?zpid=48749425</photoGallery> <homeInfo>http://www.zillow.com/HomeInfo.htm?zprop=48749425</homeInfo> </links> - <images> <count>17</count> - <image> <url>http://images3.zillow.com/is/image/i0/i0/i64/ISz23uixze1pr7.jpg?op_sharpen=1&qlt=90&size=400,400</url> <url>http://images1.zillow.com/is/image/i0/i0/i64/ISz23uj5vihxnn.jpg?op_sharpen=1&qlt=90&size=400,400</url> <url>http://images1.zillow.com/is/image/i0/i0/i64/ISz0l5yjj5pajn.jpg?op_sharpen=1&qlt=90&size=400,400</url> <url>http://images2.zillow.com/is/image/i0/i0/i64/ISz23ukda6z543.jpg?op_sharpen=1&qlt=90&size=400,400</url> <url>http://images1.zillow.com/is/image/i0/i0/i64/ISz0l5xk0loazn.jpg?op_sharpen=1&qlt=90&size=400,400</url> </image> </images> - <editedFacts> <useCode>Single family</useCode> <bedrooms>4</bedrooms> <bathrooms>3.0</bathrooms> <finishedSqFt>3470</finishedSqFt> <lotSizeSqFt>4680</lotSizeSqFt> <yearBuilt>1924</yearBuilt> <yearUpdated>2003</yearUpdated> <numFloors>2</numFloors> <basement>Finished</basement> <roof>Composition</roof> <view>Water, City, Mountain</view> <parkingType>Off-street</parkingType> <heatingSources>Gas</heatingSources> <heatingSystem>Forced air</heatingSystem> <appliances>Dishwasher, Dryer, Freezer, Garbage disposal, Microwave, Range / Oven, Refrigerator, Washer</appliances> <floorCovering>Hardwood, Carpet, Tile</floorCovering> <rooms>Laundry room, Walk-in closet, Master bath, Office, Dining room, Family room, Breakfast nook</rooms> </editedFacts> <homeDescription>Bright, spacious, 4 bedroom/3 bath Craftsman, with stunning, expansive views, on one of Queen Anne's finest streets. Views of Lk Union, Lk Washington,the Cascades from Mt. Baker to Mt. Rainier, and the city-from two levels and 2 view decks. Craftsman charm intact: hardwood floors, cove moldings, crystal doorknobs, Batchelder tile fireplace. Huge gourmet eat-in kitchen with slab granite countertops, deluxe master suite, theater-like media room, level rear yard with garden space and covered patio.</homeDescription> <neighborhood>Queen Anne</neighborhood> <schoolDistrict>Seattle</schoolDistrict> <elementarySchool>John Hay</elementarySchool> <middleSchool>McClure</middleSchool> </response> </UpdatedPropertyDetails:updatedPropertyDetails>
XML Schema Definition (XSD)
The XSD for the API can be found at: http://www.zillow.com/static/xsd/UpdatedPropertyDetails.xsd
<xsd:schema attributeFormDefault="unqualified" elementFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ZillowTypes="http://www.zillow.com/static/xsd/ZillowTypes.xsd" targetNamespace="http://www.zillow.com/static/xsd/UpdatedPropertyDetails.xsd"> <xsd:import namespace="http://www.zillow.com/static/xsd/ZillowTypes.xsd" schemaLocation="/vstatic/4/static/xsd/ZillowTypes.xsd" /> <xsd:element name="updatedPropertyDetails"> <xsd:complexType> <xsd:sequence> <xsd:element name="request"> <xsd:complexType> <xsd:sequence> <xsd:element name="zpid" type="xsd:unsignedInt"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="message" type="ZillowTypes:Message"/> <xsd:element minOccurs="0" name="response"> <xsd:complexType> <xsd:sequence> <xsd:element name="zpid" type="xsd:unsignedInt"/> <xsd:element name="pageViewCount"> <xsd:complexType> <xsd:sequence> <xsd:element name="currentMonth" type="xsd:unsignedInt"/> <xsd:element name="total" type="xsd:unsignedInt"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="address" type="ZillowTypes:Address"/> <xsd:element name="listing"> <xsd:complexType> <xsd:sequence> <xsd:element name="status" type="xsd:string"/> <xsd:element name="type" type="xsd:string"/> <xsd:element name="lastUpdatedDate" type="xsd:date"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="price" type="xsd:unsignedInt"/> <xsd:element name="links"> <xsd:complexType> <xsd:sequence> <xsd:element name="homeDetails" type="xsd:string"/> <xsd:element name="photoGallery" type="xsd:string"/> <xsd:element name="homeInfo" type="xsd:string"/> <xsd:element name="ownersEstimate" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="images"> <xsd:complexType> <xsd:sequence> <xsd:element name="count" type="xsd:unsignedInt"/> <xsd:element name="lings"> <xsd:complexType> <xsd:sequence> <xsd:element name="url" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="editedFacts"> <xsd:complexType> <xsd:sequence> <xsd:element minOccurs="0" name="useCode" type="xsd:string"/> <xsd:element minOccurs="0" name="bedrooms" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="bathrooms" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="finishedSqFt" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="lotSizeSqFt" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="yearBuilt" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="yearUpdated" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="numFloors" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="numRooms" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="basement" type="xsd:string"/> <xsd:element minOccurs="0" name="roof" type="xsd:string"/> <xsd:element minOccurs="0" name="view" type="xsd:string"/> <xsd:element minOccurs="0" name="parkingType" type="xsd:string"/> <xsd:element minOccurs="0" name="coveredParkingSpaces" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="heatingSources" type="xsd:string"/> <xsd:element minOccurs="0" name="heatingSystem" type="xsd:string"/> <xsd:element minOccurs="0" name="coolingSystem" type="xsd:string"/> <xsd:element minOccurs="0" name="appliances" type="xsd:string"/> <xsd:element minOccurs="0" name="floorCovering" type="xsd:string"/> <xsd:element minOccurs="0" name="rooms" type="xsd:string"/> <xsd:element minOccurs="0" name="architecture" type="xsd:string"/> <xsd:element minOccurs="0" name="floorNumber" type="xsd:unsignedInt"/> <xsd:element minOccurs="0" name="numUnits" type="xsd:unsignedInt"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="homeDescription" type="xsd:string"/> <xsd:element name="whatOwnerLoves" type="xsd:string"/> <xsd:element name="neighborhood" type="xsd:string"/> <xsd:element name="schoolDistrict" type="xsd:string"/> <xsd:element name="elementarySchool" type="xsd:string"/> <xsd:element name="middleSchool" type="xsd:string"/> <xsd:element name="highSchool" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:schema>
