Metadata-Version: 1.1
Name: pyzillow
Version: 0.0.3
Summary: Python interface for Zillow's API. Currently supporting GetDeepSearchResults and GetUpdatedPropertyDetails API.
Home-page: https://github.com/hanneshapke/pyzillow
Author: Hannes Hapke
Author-email: hannes@renooble.com
License: MIT
Download-URL: https://github.com/hanneshapke/pyzillow/archive/master.zip
Description: ==================
        pyzillow 0.3
        ==================
        Hannes Hapke
        Miguel Paolino
        20/01/2014
        
        
        README
        ------
        This is a Python wrapper for Zillow's API.
        
        Currrently it is supporting the GetDeepSearchResults and GetUpdatedPropertyDetails API. 
        
        It allows you to directly convert an address/zipcode (GetDeepSearchResults API) or zillow id (GetUpdatedPropertyDetails API) into
        real estate data based on the Zillow database.
        
        License
        ------
        BSD
        
        Dependencies
        ------------
        It has dependency on the xml.etree module, included with Python versions 2.7 and later.
        requests library is also needed and will be installed by setuptools.
        
        It is developed on Python 2.7 but should work on earlier versions. Not tested if it is also compatible 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 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 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.3 > pip created and code refactured
        
        Version 0.2 > API Wrapper for the GetDeepSearchResults and GetUpdatedPropertyDetails API. test.py and setup.py created.
        
        Version 0.1 > Project created
        
        
        
        
Keywords: zillow real estate rental xml api address zipcode
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Requires: requests
Provides: pyzillow
