pyzillow is a python library to access the Zillow APIs
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
docs refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
pyzillow Updated version number after latest fix, CI passed for 2.6, 2.7 and 3.4 Sep 13, 2015
requirements Move/updated requirements.txt, Django dependency removed Sep 13, 2015
test Updated tests Sep 13, 2015
.gitignore refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
.travis.yml Python 3.4 support Sep 13, 2015
AUTHORS.rst refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
CONTRIBUTING.rst Removal of PyPy support, for now, sorry Dec 20, 2014
HISTORY.rst Updated history and version number in the setup.py Sep 13, 2015
LICENSE refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
MANIFEST.in refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
Makefile refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
README.md Updated version number after latest fix, CI passed for 2.6, 2.7 and 3.4 Sep 13, 2015
README.rst Updated version number after latest fix, CI passed for 2.6, 2.7 and 3.4 Sep 13, 2015
__init__.py Fixed __init__.py, increased version numbering for pip Sep 13, 2015
setup.cfg refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014
setup.py Updated version number after latest fix, CI passed for 2.6, 2.7 and 3.4 Sep 13, 2015
tox.ini refactored version of PyZillow, travis CI setup, md to rst, tests con… Dec 20, 2014

README.md

================== pyzillow 0.3

By Hannes Hapke & Miguel Paolino for renooble.com

20/01/2014

README

This is a Python wrapper for Zillow's API.

Currrently it supports the GetDeepSearchResults and GetUpdatedPropertyDetails APIs.

It allows you to directly convert an address/zipcode (GetDeepSearchResults API) or zillow id (GetUpdatedPropertyDetails API) into real estate data from the Zillow database.

License

MIT

Dependencies

It requires the xml.etree module, included with Python versions 2.7 and later. The requests library is also needed and will be installed by setuptools.

It is developed on Python 2.7 but should work on earlier versions. We have not tested it with Python 3. Sorry.

Installation

You can install this package using pip:

pip install pyzillow

or download the source from https://github.com/hanneshapke/pyzillow and install

python setup.py install

Usage of the GetDeepSearchResults API

from pyzillow.pyzillow import ZillowWrapper, GetDeepSearchResults
...
address = 'YOUR ADDRESS'
zipcode = 'YOUR ZIPCODE'
...
zillow_data = ZillowWrapper(YOUR_ZILLOW_API_KEY)
deep_search_response = zillow_data.get_deep_search_results(address, zipcode)
result = GetDeepSearchResults(deep_search_response)
...
result.zillow_id # zillow id, needed for the GetUpdatedPropertyDetails

The following attributes are currently supported:

- zillow_id
- home_type
- home_detail_link
- graph_data_link
- map_this_home_link
- latitude
- latitude
- coordinates
- tax_year
- tax_value
- year_built
- property_size
- home_size
- bathrooms
- bedrooms
- last_sold_date
- last_sold_price_currency
- last_sold_price

Usage of the GetUpdatedPropertyDetails API

from pyzillow.pyzillow import ZillowWrapper, GetUpdatedPropertyDetails
...
zillow_id = 'YOUR ZILLOW ID'
...
zillow_data = ZillowWrapper(YOUR_ZILLOW_API_KEY)
updated_property_details_response = zillow_data.get_updated_property_details(zillow_id)
result = GetUpdatedPropertyDetails(updated_property_details_response)
...
result.rooms # number of rooms of the home

The following attributes are currently supported:

- zillow_id
- home_type
- home_detail_link
- photo_gallery
- latitude
- latitude
- coordinates
- year_built
- property_size
- home_size
- bathrooms
- bedrooms
- home_info
- year_updated
- floors
- basement
- roof
- view
- heating_sources
- heating_system
- rooms
- neighborhood
- school_district

The following attributes are not provided by the API:

- graph_data_link
- map_this_home_link
- tax_year
- tax_value
- last_sold_date
- last_sold_price_currency
- last_sold_price

Contact Information

Author: Hannes Hapke Twitter: @hanneshapke Internet: https://github.com/hanneshapke/

For comments, issues, requests, please contact via Github at the above website

Changelog

  • Version 0.5.3/4/5 > Updated init.py
  • Version 0.5.2 > Updated setup.py
  • Version 0.5.1 > Python 3.4 support
  • Version 0.5 > Removed django.contrib.gis.geos dependency, remove Django from the pip requirements, moved requirements to separate folder, updated tests, mocked tests
  • Version 0.4 > DepreciationWarning: def coordinates(self) will not be supported in version 0.5
  • Version 0.3.1 > Merged PR
  • Version 0.3 > pip created and code refactored
  • Version 0.2 > API Wrapper for the GetDeepSearchResults and GetUpdatedPropertyDetails API. test.py and setup.py created.
  • Version 0.1 > Project created