Listings API

How to use the Listings API

You can use the listings API to get a list of your Zillow Group listings.  Each Zillow Group listing has a unique zgListingId which can be required by other APIs when pulling data for reviews or scheduling tours.  You will probably start your integration by pulling from the Listings API.

 

Matching Using the Listings API

If you are integrating Zillow Group data with data from your internal systems, you will need to tie your Zillow Group listings to your properties internally.  The Listings API can help you do this. You can use the response from the Listings API to create an internal mapping between the zgListingId and your internal unique identifiers that you use to catalog properties.  If you want to use other Zillow Group API calls, you will need to leverage this mapping accordingly.

 

Get Listings Call    

Get all your ZG listings with a HTTP GET call to the Listings API.  Use the returned listings to map to your internal list of properties.  You will need the zgListingId for your listings when using other APIs from Zillow Group.

 

GET https://rentalsapi.zillowgroup.com/listings/v1/listingsForUser
Parameter Validation Type Description
accessToken Required String Used to authenticate the request. Please see this page for more details about authentication.
clientId Required String Used to authenticate the request. Please see this page for more details about authentication.
apiKey Required String Used to authenticate the request. Please see this page for more details about authentication.
startZgListingId Optional String The starting point for your listings. Used for paging purposes. 
limit Optional Integer The number of records in your response.  Max is 100.

 

Sample response:

{
  "status": "success",
  "errors": [],
  "payload": [
    {
      "zgListingId": "5163x5rhuybug",
      "listingAddress": {
        "state": "IN",
        "city": "Santa Claus",
        "zip": "47579",
        "street": "931 W Rudolph Ln",
        "unit": ""
      },
      "listingEmail": "email@example.com",
      "listingName": "",
      "listingPhone": "1234567890",
      "listingStartDate": "2018-12-15T00:04:49.891Z",
      "zillowUrl": "",
      "hotpadsUrl": "",
      "truliaUrl": ""
    }
  ]
}