
Zillow API Network
GetSearchResults API
The GetSearchResults API finds a property for a specified address. The content returned contains the address for the property or properties as well as the Zillow Property ID (ZPID) and current Zestimate®. It also includes the date the Zestimate was computed, a valuation range and the Zestimate ranking for the property within its ZIP code.
The GetSearchResults API Web Service is located at: http://www.zillow.com/webservice/GetSearchResults.htm
The parameters of 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. Click here to get yours. | Yes |
| address | The address of the property to search. This string should be URL encoded. | Yes |
| citystatezip | The city+state combination and/or ZIP code for which to search. This string should be URL encoded. Note that giving both city and state is required. Using just one will not work. | Yes |
| rentzestimate | Return Rent Zestimate information if available (boolean true/false, default: false) | No |
The API result set:
| Parameter | Description |
|---|---|
| zpid | The Zillow Property ID. Other API calls use this ZPID to identify properties, and to retrieve property-specific data. |
| Links | URLs to specific Zillow pages for this property:
|
| Full address | The complete address for the property:
|
| Zestimate data | Zestimate related data:
|
| Rent Zestimate data | Rent Zestimate related data:
|
| Local real estate | Real estate data for neighborhood, city, and State
|
| 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> This output field will not be returned if it is false. |
Messages and Codes
The following table summarizes possible return codes from the API:
| 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 | Invalid or missing address parameter | Check if the input address matches the format specified in the input parameters table. When inputting a city name, include the state too. A city name alone will not result in a valid address. |
| 501 | Invalid or missing citystatezip parameter | Same as error 500. |
| 502 | No results found | Sorry, the address you provided is not found in Zillow's property database. |
| 503 | Failed to resolve city, state or ZIP code | Please check to see if the city/state you entered is valid. If you provided a ZIP code, check to see if it is valid. |
| 504 | No coverage for specified area | The specified area is not covered by the Zillow property database. To see our property coverage tables, click here. |
| 505 | Timeout | Your request timed out. The server could be busy or unavailable. Try again later. |
| 506 | Address string too long | If address is valid, try using abbreviations. |
| 507 | No exact match found. | Verify that the given address is correct. |
Sample API Call
Below is an example of calling the API for the address for the exact address match "2114 Bigelow Ave", "Seattle, WA":
http://www.zillow.com/webservice/GetSearchResults.htm?zws-id=<ZWSID>&address=2114+Bigelow+Ave&citystatezip=Seattle%2C+WA
Sample API Output
<SearchResults:searchresults xsi:schemaLocation="http://www.zillow.com/static/xsd/SearchResults.xsd /vstatic/ae1bf8a790b67ef2e902d2bc04046f02/static/xsd/SearchResults.xsd"> <request> <address>2114 Bigelow Ave</address> <citystatezip>Seattle, WA</citystatezip> </request> <message> <text>Request successfully processed</text> <code>0</code> </message> <response> <results> <result> <zpid>48749425</zpid> <links> <homedetails> http://www.zillow.com/homedetails/2114-Bigelow-Ave-N-Seattle-WA-98109/48749425_zpid/ </homedetails> <graphsanddata> http://www.zillow.com/homedetails/charts/48749425_zpid,1year_chartDuration/?cbt=7522682882544325802%7E9%7EY2EzX18jtvYTCel5PgJtPY1pmDDLxGDZXzsfRy49lJvCnZ4bh7Fi9w** </graphsanddata> <mapthishome>http://www.zillow.com/homes/map/48749425_zpid/</mapthishome> <comparables>http://www.zillow.com/homes/comps/48749425_zpid/</comparables> </links> <address> <street>2114 Bigelow Ave N</street> <zipcode>98109</zipcode> <city>Seattle</city> <state>WA</state> <latitude>47.63793</latitude> <longitude>-122.347936</longitude> </address> <zestimate> <amount currency="USD">1219500</amount> <last-updated>11/03/2009</last-updated> <oneWeekChange deprecated="true"/> <valueChange duration="30" currency="USD">-41500</valueChange> <valuationRange> <low currency="USD">1024380</low> <high currency="USD">1378035</high> </valuationRange> <percentile>0</percentile> </zestimate> <localRealEstate> <region id="271856" type="neighborhood" name="East Queen Anne"> <zindexValue>525,397</zindexValue> <zindexOneYearChange>-0.144</zindexOneYearChange> <links> <overview> http://www.zillow.com/local-info/WA-Seattle/East-Queen-Anne/r_271856/ </overview> <forSaleByOwner> http://www.zillow.com/homes/fsbo/East-Queen-Anne-Seattle-WA/ </forSaleByOwner> <forSale> http://www.zillow.com/east-queen-anne-seattle-wa/ </forSale> </links> </region> <region id="16037" type="city" name="Seattle"> <zindexValue>381,764</zindexValue> <zindexOneYearChange>-0.074</zindexOneYearChange> <links> <overview> http://www.zillow.com/local-info/WA-Seattle/r_16037/ </overview> <forSaleByOwner>http://www.zillow.com/homes/fsbo/Seattle-WA/</forSaleByOwner> <forSale>http://www.zillow.com/seattle-wa/</forSale> </links> </region> <region id="59" type="state" name="Washington"> <zindexValue>263,278</zindexValue> <zindexOneYearChange>-0.066</zindexOneYearChange> <links> <overview> http://www.zillow.com/local-info/WA-home-value/r_59/ </overview> <forSaleByOwner>http://www.zillow.com/homes/fsbo/WA/</forSaleByOwner> <forSale>http://www.zillow.com/wa/</forSale> </links> </region> </localRealEstate> </result> </results> </response> </SearchResults:searchresults>
XML Schema Definition (XSD)
The XSD for the API is located at: http://www.zillow.com/static/xsd/SearchResults.xsd
<?xml version="1.0" encoding="utf-8" ?> <xsd:schema attributeFormDefault="unqualified" elementFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ZillowTypes="http://www.zillow.com/vstatic/3/static/xsd/ZillowTypes.xsd" targetNamespace="http://www.zillow.com/vstatic/3/static/xsd/SearchResults.xsd"> <xsd:import namespace="http://www.zillow.com/vstatic/3/static/xsd/ZillowTypes.xsd" /> <xsd:element name="searchresults"> <xsd:complexType> <xsd:sequence> <xsd:element name="request"> <xsd:complexType> <xsd:sequence> <xsd:element name="address" type="xsd:string" /> <xsd:element name="citystatezip" type="xsd:string" /> </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="results"> <xsd:complexType> <xsd:sequence> <xsd:element minOccurs="1" maxOccurs="unbounded" name="result" type="ZillowTypes:SimpleProperty" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:schema>