Performance Reporting
The Zillow Reporting API provides access to listing performance data collected from ZillowGroup sites, including Zillow and Trulia. Data available via the API includes:
- Counts of listings displayed
- Listings search result impressions
- Listings page views
- Contacts generated to listing agents
The data can be accessed at the feed, office, agent and individual listing levels, and on a day by day basis or rolled up over time. Data available through the API is updated on a nightly basis.
Zillow Group Performance Reporting API – Commonly Asked Questions
WHAT DATA IS INCLUDED IN OUR REPORTING API? |
The default data source is “Zillow Group” which includes Zillow, Trulia, Hotpads and StreetEasy metrics. If you would like to look at just Zillow or just Trulia data, you will need to specify the dataSource in your API call.
|
DOES ZILLOW GROUP HELP WITH API IMPLEMENTATION? |
Zillow Group does not offer developer services to help with coding or the implementation of our Reporting API. We recommend using our spec as a guide, and researching third-party API development platforms.
|
WHAT IS THE EXPECTED LAG TIME FOR DATA TO BE AVAILABLE IN THE API? |
Data in the Reporting API is usually 2 days behind (this is expected because of different system processes). It is possible to have more of a lag when there are service delays or major updates, but the expected behavior is no more than 2 days behind.
|
WHAT FEEDS CAN I EXPECT TO SEE IN MY ACCESS LIST? |
Zillow Group will configure your access list upon receiving your request. Your access list may include MLS feeds, or broker direct feeds and we recommend periodically calling your access list for up-to-date information. If you need to add or remove office IDs and feeds from your access list, please email us at BrokerOperations@ZillowGroup.com.
|
WHAT DO I USE FOR ‘CONSUMER KEY’ AND ‘CONSUMER SECRET’? | Please use the following values for the Consumer Key, and Consumer Secret:
· Consumer Key – use any non-empty value |
DO I NEED TO USE THE “MINIMAL” PARAMETER, AS FOUND IN YOUR SPEC? |
The Zillow Group Reporting API is connected to our MLS data system, and was originally made for stats on listings that are sourced directly from the MLS on our site. If your data is not MLS sourced, you may need to use the “minimal” parameter in order to return the correct results. Using “&mimimal” may also improve general performance, however it will not return the full address of the listing (only the MLS ID will be returned). Please email us at BrokerOperations@ZillowGroup.com for more information.
|
WHY AM I ONLY SEEING 1,000 LISTINGS RETURNED? I’M EXPECTING TO SEE MORE. |
A feed listings summary call will only return the first 1,000 listings. To continue to view listings, use the “from” parameter to request the next group (i.e. “from=0” will return listings 0-1,000; “from=1000” will return listings 1,000-2,000 etc.).
|
WHAT DO YOU NEED TO SET UP MY API ACCOUNT? |
After you have submitted an official request via our form, we will ask you to send a list of MLSs and the associated office IDs you need data for. We prefer an Excel doc/CSV file with the following columns: – MLS Name If you are a large Broker or Vendor with numerous MLSs and/or office IDs, we may request you provide us with a list of affiliations that adheres to our standardized format and naming conventions. This helps to expedite the process, so you can get to your data more quickly!
|
I CAN’T FIND A SPECIFIC LISTING WHEN CALLING YOUR API. WHERE IS IT? |
First, we recommend checking to see if you have access to the right feed and/or office ID using your credentials. If you do, then we suggest adjusting the “from” parameter, or adding the “minimal” parameter to your call as this typically pulls in the data. We also suggest checking the individual listing endpoint, as this will allow you to call our API for a specific listing, rather than searching at the office or feed level. Should you need further help or need to make changes to your Access List, please email us at BrokerOperations@ZillowGroup.com.
|
WHY AM I GETTING AN “UNAUTHORIZED” ERROR MESSAGE? |
We highly recommend using the program Postman for API calls, however, at times your calls may return an “unauthorized” error. This is a known Postman-specific issue, and usually if you send the call again, it will work (may have to resend a few times). If you continue to test in Postman and still aren’t able to grab any results after 4 tries, there may be an issue with your account such as missing MLSs or OfficeIds from the Access List. Please email us at BrokerOperations@ZillowGroup.com for help.
|
Documentation URL | https://reporting-api.zillowgroup.com/ |
Authentication Model | OAuth 1.0 |
Architectural Style | Read-only RESTful |
Supported Request Formats | Query String |
Supported Response Formats | JSON |
Agreement Type | Zillow Certified Technology Partner Program Reporting Terms of Use |