node-zillow

Node wrapper for the Zillow API

Getting Started

Install the module with: npm install node-zillow

var Zillow = require('node-zillow');

//Instantiate
var zillow = new Zillow('your zws-id');

var your-zws-id = process.env.ZWSID is the recommended way

Also be sure to follow the Zillow API terms of use and requirements Zillow API Docs

Documentation

Methods

callApi
- Convenience method for the entire zillow api
- takes the name of the api call (i.e. GetSearchResults) -- refer to the [Zillow API Docs](http://www.zillow.com/howto/api/APIOverview.htm), the `lib/api-list.js`, or see below
- Returns a promise with the result

getDeepSearchResults
- takes params hash
{
  address: 'address',
  city: 'city',
  state: 'state',
  zip: 'zip',
  rentzestimate: boolean //this is optional
}
- Returns a promise with the result

getUpdatedPropertyDetails
- takes zpid (Zillow property id) obtained from the getDeepSearchResults request
Pass in as a number or a string

- Returns a promise with the result

getDemographics
- takes params hash
{
  address: 'address',
  city: 'city',
  state: 'state',
  zip: 'zip'
}
- Returns a promise with the result

Following API Methods supported:

GetDeepSearchResults
GetUpdatedPropertyDetails
GetDeepComps
GetRateSummary
GetMonthlyPayments
GetDemographics
GetRegionChildren
GetRegionChart
GetSearchResults
GetZestimate
GetChart
GetComps

Examples

Zillow.getDeepSearchResults()

Needs to be resolved from a promise (recommend Q library):

var getResult = getDeepSearchResults({params});
getResult.then(function(result) {
  return result; //here's your result, so you can do something here
});

Zillow.getUpdatedPropertyDetails()

var Zillow  = require('node-zillow')

// To run: `ZWSID=<ZWSID> node example_updatedPropertyDetails.js`
var zwsid = process.env.ZWSID;

var zillow = new Zillow(zwsid)

var params = {
  address: "2512 Mapleton Ave.",
  city: 'Boulder',
  state: 'CO',
  zip: '80304'
}

// getDeepSearchResults() returns zpid, which is passed into getUpdatedPropertyDetails()
var deepResults = zillow.getDeepSearchResults(params)
    .then(function(result) {
      var zpid = result.response[0].results[0].result[0].zpid[0]
      return zillow.getUpdatedPropertyDetails(zpid)
    })
    .then(function(result) {
      if (result.message[0].code === '502') return {}
      return result.response[0]
    })

Zillow.getDemographics()

var Zillow  = require('node-zillow')

var zwsid = process.env.ZWSID
var zillow = new Zillow(zwsid)

zillow.getDemographics({zip: '80301'})
  .then(function(data) {
    var results = data.response[0].results[0].result[0]
    return results;
  })

Zillow.callApi()

var Zillow  = require('node-zillow')

var zwsid = process.env.ZWSID
var zillow = new Zillow(zwsid)

var parameters = {
  zpid: 1111111
};

zillow.callApi('GetZestimate', parameters)
  .then(function(data) {
    var results = data.response[0].results[0].result[0]
    return results;
  })

Contributing

This module uses promises via the Q library. Please continue to use promises. And in lieu of any further formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Contributors

Release History

v0.0.4 - Added error-checking and parameter checking
v0.0.3 - Includes the following methods: callApi, getUpdatedPropertyDetails, getDeepSearchResults, getDemographics

jefffriesen/node-zillow