forked from hanneshapke/pyzillow
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.rst
178 lines (142 loc) · 5.16 KB
/
README.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
==================
pyzillow 0.3
==================
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
.. image:: https://pypip.in/d/pyzillow/badge.png
:target: https://pypi.python.org/pypi/pyzillow
.. image:: https://coveralls.io/repos/hanneshapke/pyzillow/badge.png
:target: https://coveralls.io/r/hanneshapke/pyzillow
=======
README
------
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 (GetUpdatedPropertyDetails 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
=======
Dependencies
------------
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 (GetUpdatedPropertyDetails API) into
real estate data based on the Zillow database.
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, rentzestimate)
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 (as GEOS point)
- tax_year
- tax_value
- year_built
- property_size
- home_size
- bathrooms
- bedrooms
- last_sold_date
- last_sold_price_currency
- last_sold_price
- zestimate_amount
- zestimate_last_updated
- zestimate_value_change
- zestimate_valuation_range_high
- zestimate_valuation_range_low
- zestimate_percentile
If rentzestimate=True the following additional attributes are supported:
- rentzestimate_amount
- rentzestimate_last_updated
- rentzestimate_value_change
- rentzestimate_valuation_range_high
- rentzestimate_valuation_range_low
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
- 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
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
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