-
Notifications
You must be signed in to change notification settings - Fork 27
/
index.html
289 lines (202 loc) · 9.02 KB
/
index.html
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Documentation Index</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Documentation</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Zillow.html">Zillow</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<section class="readme-section">
<article><h1>node-zillow <a href="http://travis-ci.org/ralucas/node-zillow"><img src="https://secure.travis-ci.org/ralucas/node-zillow.png?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/github/ralucas/node-zillow"><img src="https://coveralls.io/repos/github/ralucas/node-zillow/badge.svg" alt="Coverage Status"></a></h1><p>Node wrapper for the Zillow API</p>
<h2>Getting Started</h2><p>Install the module with: <code>npm install node-zillow</code></p>
<pre class="prettyprint source lang-js"><code>var Zillow = require('node-zillow');
//Instantiate
var zillow = new Zillow('your zws-id', options);</code></pre><p><code>var your-zws-id = process.env.ZWSID</code> is the recommended way</p>
<h4>Accepted options</h4><p>https - default is <code>false</code></p>
<p><strong>None of this will make sense without reading the <a href="http://www.zillow.com/howto/api/APIOverview.htm">Zillow API Docs</a></strong></p>
<p><strong>Also be sure to follow the Zillow API <a href="http://www.zillow.com/howto/api/APITerms.htm">terms of use</a> and <a href="http://www.zillow.com/howto/api/BrandingRequirements.htm">branding requirements</a></strong></p>
<h2>Documentation</h2><h3>Methods</h3><p><code>get</code></p>
<ul>
<li>Method for the entire zillow api</li>
<li>takes the name of the api call (i.e. GetSearchResults) -- refer to the <a href="http://www.zillow.com/howto/api/APIOverview.htm">Zillow API Docs</a>, the <code>lib/api-list.js</code>, or see below</li>
<li>Returns a promise with the result</li>
<li>The eventual returned result is an object with the following properties: <code>message</code>, <code>request</code>, and sometimes <code>response</code></li>
<li>Please Note: <code>response</code> property is NOT always included in the zillow api response</li>
</ul>
<h4>Following API Methods supported:</h4><ul>
<li>GetDeepSearchResults</li>
<li>GetUpdatedPropertyDetails</li>
<li>GetDeepComps</li>
<li>GetRateSummary</li>
<li>GetMonthlyPayments</li>
<li>GetDemographics</li>
<li>GetRegionChildren</li>
<li>GetRegionChart</li>
<li>GetSearchResults</li>
<li>GetZestimate</li>
<li>GetChart</li>
<li>GetComps</li>
</ul>
<h2>Examples</h2><p>Example of all API calls through the <code>get()</code> method can be found in <a href="https://github.com/ralucas/node-zillow/blob/master/examples/examples.js">examples</a></p>
<pre class="prettyprint source lang-js"><code>var Zillow = require('node-zillow')
var zwsid = process.env.ZWSID
var zillow = new Zillow(zwsid)
var parameters = {
zpid: 1111111
};
zillow.get('GetZestimate', parameters)
.then(function(results) {
return results;
// results here is an object { message: {}, request: {}, response: {}}
})</code></pre><p>The following API calls are deprecated and will be removed in the 1.0.0 release. Using <code>get()</code> is the recommended approach and should be able to do everthing that the legacy functions do. If you see problems with <code>get()</code>, PR's and issues are welcome.</p>
<pre class="prettyprint source lang-js"><code>Zillow.callApi()
Zillow.getDeepSearchResults()
Zillow.getUpdatedPropertyDetails()
Zillow.getDemographics()</code></pre><h2>Contributing</h2><p>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 npm scripts in the <code>package.json</code>.</p>
<h2>Contributors</h2><ul>
<li><a href="https://github.com/jefffriesen">Jeff Friesen</a></li>
<li><a href="https://github.com/ralucas">Richard Lucas</a></li>
</ul>
<h2>Release History</h2><ul>
<li>v2.0.0 - Updated all dependencies. Remove support for Node.js v0.10.x.</li>
<li>v1.1.0 - Updated all dependencies, removed grunt, moved to istanbul, added coveralls, more ci environments</li>
<li>v1.0.1 - Added protocol option</li>
<li>v1.0.0 - Created single method (get), updated response handling, removed all deprecated methods, updated tests</li>
<li>v0.0.5 - updates</li>
<li>v0.0.4 - Added error-checking and parameter checking</li>
<li>v0.0.3 - Includes the following methods: callApi, getUpdatedPropertyDetails, getDeepSearchResults, getDemographics</li>
</ul>
<h2>License</h2><p>Copyright (c) 2014-2018 Richard Lucas. Licensed under the MIT license.</p></article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on 2018-10-16T22:34:15-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : false,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>