PyZillow Documentation Release 0.5.5 Hannes Hapke Jul 10, 2017
Contents 1 Installation 3 2 Usage of the GetDeepSearchResults API 5 3 Usage of the GetUpdatedPropertyDetails API 7 4 Contact Information 9 5 Changelog 11 5.1 Contents:................................................. 11 5.2 Feedback................................................. 15 i
ii
By Hannes Hapke & Miguel Paolino 10/09/2015.. image:: https://travis-ci.org/hanneshapke/pyzillow.png?branch=master target https://travis-ci.org/hanneshapke/pyzillow This is a Python wrapper for [Zillow s API](http://www.zillow.com/howto/api/APIOverview.htm). Currrently it supports the GetDeepSearchResults and GetUpdatedPropertyDetails APIs. It allows you to directly convert an address/zipcode (GetDeepSearchResults API) or zillow id (GetUpdatedProperty- Details API) into real estate data from the Zillow database. Documentation available here: http://pyzillow.readthedocs.org/en/latest/.. image:: https://readthedocs.org/projects/ pyzillow/badge/?version=latest target https://readthedocs.org/projects/pyzillow It requires the xml.etree module, included with Python versions 2.7 and later. The [requests](http://docs. python-requests.org/en/latest/index.html) 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. Currently it is supporting the GetDeepSearchResults and GetUpdatedPropertyDetails API. It allows you to directly convert an address/zipcode (GetDeepSearchResults API) or zillow id (GetUpdatedProperty- Details API) into real estate data based on the Zillow database. Contents 1
2 Contents
CHAPTER 1 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 3
4 Chapter 1. Installation
CHAPTER 2 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 = Get- DeepSearchResults(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 (as GEOS point) tax_year tax_value year_built property_size home_size bathrooms bedrooms last_sold_date last_sold_price_currency 5
last_sold_price zestimate_amount zestimate_last_updated zestimate_value_change zestimate_valuation_range_high zestimate_valuationrange_low zestimate_percentile 6 Chapter 2. Usage of the GetDeepSearchResults API
CHAPTER 3 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 (as GEOS point) year_built property_size home_size bathrooms bedrooms home_info year_updated floor_material num_floors basement 7
roof view parking_type heating_sources heating_system rooms home_description 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 8 Chapter 3. Usage of the GetUpdatedPropertyDetails API
CHAPTER 4 Contact Information Author: Hannes Hapke (renooble) Twitter: @hanneshapke Internet: https://github.com/hanneshapke/ For comments, issues, requests, please contact via Github at the above website 9
10 Chapter 4. Contact Information
CHAPTER 5 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 Contents: Installation At the command line either via easy_install or pip: $ easy_install pyzillow $ pip install pyzillow Or, if you have virtualenvwrapper installed: $ mkvirtualenv pyzillow $ pip install pyzillow 11
Usage To use PyZillow in a project: import pyzillow Contributing Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways: Types of Contributions Report Bugs Report bugs at https://github.com/hanneshapke/pyzillow/issues. If you are reporting a bug, please include: Your operating system name and version. Any details about your local setup that might be helpful in troubleshooting. Detailed steps to reproduce the bug. Fix Bugs Look through the GitHub issues for bugs. Anything tagged with bug is open to whoever wants to implement it. Implement Features Look through the GitHub issues for features. Anything tagged with feature is open to whoever wants to implement it. Write Documentation PyZillow could always use more documentation, whether as part of the official PyZillow docs, in docstrings, or even on the web in blog posts, articles, and such. Submit Feedback The best way to send feedback is to file an issue at https://github.com/hanneshapke/pyzillow/issues. If you are proposing a feature: Explain in detail how it would work. Keep the scope as narrow as possible, to make it easier to implement. Remember that this is a volunteer-driven project, and that contributions are welcome :) 12 Chapter 5. Changelog
Get Started! Ready to contribute? Here s how to set up pyzillow for local development. 1. Fork the pyzillow repo on GitHub. 2. Clone your fork locally: $ git clone git@github.com:hanneshapke/pyzillow.git 3. Create a branch for local development: $ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. 4. When you re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox: $ tox To get tox, just pip install it. 5. Commit your changes and push your branch to GitHub: $ git add. $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature 6. Submit a pull request through the GitHub website. Pull Request Guidelines Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests. 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst. 3. The pull request should work for Python 2.6 and 2.7. Check https://travis-ci.org/hanneshapke/pyzillow under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions. Tips To run a subset of tests: $ py.test test/test_pyzillow.py Credits Contributors Alvaro Feito <alvaro@renooble.com> Bryce Boe <bbzbryce@gmail.com> Hannes Hapke <hannes@renooble.com> Miguel paolino <miguel@renooble.com> 5.1. Contents: 13
History 0.5.0 (2015-09-12) Removed Django depemdemcy, mocked tests, Python 3.4 support 0.4.0 (2014-12-20) Zestimate extracted from Zillow s GetDeepSearchResults API. 0.3.1 (2014-12-20) Added test cases and increased test coverage setup. 0.3.0 (2014-12-19) Refactored structure, travis CI compliance, coverage setup. 0.2.7 Bug fix: Missing ParseError, numrooms now read from UpdatedProperty 0.2.6 Bug fix 0.2.5 Using markdown as README file for setup.py 0.2.4 Coordinates provides as GEOS point 0.2.3 New attributes added: home_description, num_floors, floor_material, parking_type 0.2.2 Licence changed to MIT 0.2.1 pip created and code refactured 14 Chapter 5. Changelog
0.2 API Wrapper for the GetDeepSearchResults and GetUpdatedPropertyDetails API. test.py and setup.py created. 0.1 Project created Feedback If you have any suggestions or questions about PyZillow feel free to email me at hannes.hapke@gmail.com. If you encounter any errors or problems with PyZillow, please let me know! Open an Issue at the GitHub http: //github.com/hanneshapke/pyzillow main repository. 5.2. Feedback 15