zillow-rapidapi-client 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,10 +3,10 @@
3
3
  import importlib.metadata
4
4
 
5
5
  __title__: str = "zillow-rapidapi-client"
6
- __version__: str = "0.1.3"
6
+ __version__: str = "0.1.4"
7
7
  __openapi_doc_version__: str = "1.0.0"
8
- __gen_version__: str = "2.522.1"
9
- __user_agent__: str = "speakeasy-sdk/python 0.1.3 2.522.1 1.0.0 zillow-rapidapi-client"
8
+ __gen_version__: str = "2.522.5"
9
+ __user_agent__: str = "speakeasy-sdk/python 0.1.4 2.522.5 1.0.0 zillow-rapidapi-client"
10
10
 
11
11
  try:
12
12
  if __package__ is not None:
@@ -10,9 +10,13 @@ from .property import (
10
10
  PropertyTypedDict,
11
11
  )
12
12
  from .propertyextendedsearchop import (
13
+ DaysOn,
13
14
  HomeType,
15
+ LotSizeMax,
16
+ LotSizeMin,
14
17
  PropertyExtendedSearchRequest,
15
18
  PropertyExtendedSearchRequestTypedDict,
19
+ SoldInLast,
16
20
  Sort,
17
21
  StatusType,
18
22
  )
@@ -24,10 +28,13 @@ from .propertysearchresponse import (
24
28
 
25
29
  __all__ = [
26
30
  "APIError",
31
+ "DaysOn",
27
32
  "HomeType",
28
33
  "ListingStatus",
29
34
  "ListingSubType",
30
35
  "ListingSubTypeTypedDict",
36
+ "LotSizeMax",
37
+ "LotSizeMin",
31
38
  "Property",
32
39
  "PropertyExtendedSearchRequest",
33
40
  "PropertyExtendedSearchRequestTypedDict",
@@ -35,6 +42,7 @@ __all__ = [
35
42
  "PropertySearchResponseTypedDict",
36
43
  "PropertyType",
37
44
  "PropertyTypedDict",
45
+ "SoldInLast",
38
46
  "Sort",
39
47
  "StatusType",
40
48
  ]
@@ -1,6 +1,7 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from datetime import date
4
5
  from enum import Enum
5
6
  import pydantic
6
7
  from typing import Optional
@@ -43,9 +44,74 @@ class Sort(str, Enum):
43
44
  LOT_SIZE = "Lot_Size"
44
45
 
45
46
 
47
+ class DaysOn(str, Enum):
48
+ r"""Days on Z. Use with status_type='ForSale' or status_type='ForRent'."""
49
+
50
+ ONE = "1"
51
+ SEVEN = "7"
52
+ FOURTEEN = "14"
53
+ THIRTY = "30"
54
+ NINETY = "90"
55
+ SIXM = "6m"
56
+ TWELVEM = "12m"
57
+ TWENTY_FOURM = "24m"
58
+ THIRTY_SIXM = "36m"
59
+
60
+
61
+ class SoldInLast(str, Enum):
62
+ r"""Sold in the last. Use with status_type='RecentlySold'."""
63
+
64
+ ONE = "1"
65
+ SEVEN = "7"
66
+ FOURTEEN = "14"
67
+ THIRTY = "30"
68
+ NINETY = "90"
69
+ SIXM = "6m"
70
+ TWELVEM = "12m"
71
+ TWENTY_FOURM = "24m"
72
+ THIRTY_SIXM = "36m"
73
+
74
+
75
+ class LotSizeMin(str, Enum):
76
+ r"""Minimum lot size."""
77
+
78
+ ONE_000_SQFT = "1,000 sqft"
79
+ TWO_000_SQFT = "2,000 sqft"
80
+ THREE_000_SQFT = "3,000 sqft"
81
+ FOUR_000_SQFT = "4,000 sqft"
82
+ FIVE_000_SQFT = "5,000 sqft"
83
+ SEVEN_500_SQFT = "7,500 sqft"
84
+ ONE_4_ACRE_10_890_SQFT = "1/4 acre/10,890 sqft"
85
+ ONE_2_ACRE_21_780_SQFT = "1/2 acre/21,780 sqft"
86
+ ONE_ACRE_43_560_SQFT = "1 acre/43,560 sqft"
87
+
88
+
89
+ class LotSizeMax(str, Enum):
90
+ r"""Maximum lot size."""
91
+
92
+ ONE_000_SQFT = "1,000 sqft"
93
+ TWO_000_SQFT = "2,000 sqft"
94
+ THREE_000_SQFT = "3,000 sqft"
95
+ FOUR_000_SQFT = "4,000 sqft"
96
+ FIVE_000_SQFT = "5,000 sqft"
97
+ SEVEN_500_SQFT = "7,500 sqft"
98
+ ONE_4_ACRE_10_890_SQFT = "1/4 acre/10,890 sqft"
99
+ ONE_2_ACRE_21_780_SQFT = "1/2 acre/21,780 sqft"
100
+ ONE_ACRE_43_560_SQFT = "1 acre/43,560 sqft"
101
+ TWO_ACRES_87_120_SQFT = "2 acres/87,120 sqft"
102
+ FIVE_ACRES_217_800_SQFT = "5 acres/217,800 sqft"
103
+ TEN_ACRES_435_600_SQFT = "10 acres/435,600 sqft"
104
+ TWENTY_ACRES_871_200_SQFT = "20 acres/871,200 sqft"
105
+ FIFTY_ACRES_2_178_000_SQFT = "50 acres/2,178,000 sqft"
106
+ ONE_HUNDRED_ACRES_4_356_000_SQFT = "100 acres/4,356,000 sqft"
107
+
108
+
46
109
  class PropertyExtendedSearchRequestTypedDict(TypedDict):
47
110
  location: NotRequired[str]
48
- r"""Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty."""
111
+ r"""Location details (address, county, neighborhood, or Zip code). Required if
112
+ polygon or coordinates are empty.
113
+
114
+ """
49
115
  page: NotRequired[int]
50
116
  r"""Page number for paginated results. Max value is 20."""
51
117
  status_type: NotRequired[StatusType]
@@ -54,10 +120,170 @@ class PropertyExtendedSearchRequestTypedDict(TypedDict):
54
120
  r"""Property type. Comma-separated list."""
55
121
  sort: NotRequired[Sort]
56
122
  r"""Sorting order."""
123
+ polygon: NotRequired[str]
124
+ r"""Polygon coordinates in the format: lon lat,lon1 lat1,lon2 lat2. It is
125
+ required if the location or coordinates are empty. The last pair must be the
126
+ same as the first pair.
127
+
128
+ """
57
129
  min_price: NotRequired[float]
58
130
  r"""Minimum price filter."""
59
131
  max_price: NotRequired[float]
60
132
  r"""Maximum price filter."""
133
+ rent_min_price: NotRequired[float]
134
+ r"""Minimum rent price filter (if status_type = ForRent)."""
135
+ rent_max_price: NotRequired[float]
136
+ r"""Maximum rent price filter (if status_type = ForRent)."""
137
+ baths_min: NotRequired[float]
138
+ r"""Bathrooms min count."""
139
+ baths_max: NotRequired[float]
140
+ r"""Bathrooms max count."""
141
+ beds_min: NotRequired[float]
142
+ r"""Bedrooms min count."""
143
+ beds_max: NotRequired[float]
144
+ r"""Bedrooms max count."""
145
+ sqft_min: NotRequired[float]
146
+ r"""Square Feet min value."""
147
+ sqft_max: NotRequired[float]
148
+ r"""Square Feet max value."""
149
+ build_year_min: NotRequired[float]
150
+ r"""Year Built min value."""
151
+ build_year_max: NotRequired[float]
152
+ r"""Year Built max value."""
153
+ days_on: NotRequired[DaysOn]
154
+ r"""Days on Z. Use with status_type='ForSale' or status_type='ForRent'.
155
+
156
+ """
157
+ sold_in_last: NotRequired[SoldInLast]
158
+ r"""Sold in the last. Use with status_type='RecentlySold'.
159
+
160
+ """
161
+ is_basement_finished: NotRequired[float]
162
+ r"""Basement filter. Set it to 1 if needed."""
163
+ is_basement_unfinished: NotRequired[float]
164
+ r"""Basement filter. Set it to 1 if needed."""
165
+ is_pending_under_contract: NotRequired[float]
166
+ r"""Pending & Under Contract filter. Set it to 1 if needed."""
167
+ is_accepting_backup_offers: NotRequired[float]
168
+ r"""Accepting Backup Offers filter. Set it to 1 if needed."""
169
+ is_coming_soon: NotRequired[bool]
170
+ r"""Coming Soon listings are homes that will soon be on the market. Set it to 1
171
+ if needed.
172
+
173
+ """
174
+ other_listings: NotRequired[bool]
175
+ r"""If set to 1, the results will only include data from the Other Listings tab.
176
+
177
+ """
178
+ is_new_construction: NotRequired[bool]
179
+ r"""New Construction filter. Set it to 1 or true if you only need properties
180
+ with New Construction status.
181
+
182
+ """
183
+ keywords: NotRequired[str]
184
+ r"""Keywords filter for property search."""
185
+ lot_size_min: NotRequired[LotSizeMin]
186
+ r"""Minimum lot size."""
187
+ lot_size_max: NotRequired[LotSizeMax]
188
+ r"""Maximum lot size."""
189
+ sale_by_agent: NotRequired[str]
190
+ r"""Default - true. To get FSBO set
191
+ saleByAgent=false&saleByOwner=true&otherListings=true.
192
+
193
+ """
194
+ sale_by_owner: NotRequired[str]
195
+ r"""Default - true. To get only FSBO set
196
+ saleByAgent=false&saleByOwner=true&otherListings=true.
197
+
198
+ """
199
+ is_for_sale_foreclosure: NotRequired[bool]
200
+ r"""If you only need to get ForSaleForeclosure set to true or 1."""
201
+ is_waterfront: NotRequired[bool]
202
+ has_pool: NotRequired[bool]
203
+ has_air_conditioning: NotRequired[bool]
204
+ is_city_view: NotRequired[bool]
205
+ is_mountain_view: NotRequired[bool]
206
+ is_water_view: NotRequired[bool]
207
+ is_park_view: NotRequired[bool]
208
+ is_open_houses_only: NotRequired[bool]
209
+ r"""Must have open house."""
210
+ is3d_home: NotRequired[bool]
211
+ r"""Must have 3D Tour."""
212
+ coordinates: NotRequired[str]
213
+ r"""It is required if the location or polygon is empty.
214
+ Format: lon lat,diameter. Diameter in miles from 1 to 99 -118.51750373840332
215
+ 34.007063913440916,20
216
+
217
+ """
218
+ hoa: NotRequired[float]
219
+ r"""Max HOA."""
220
+ include_homes_with_no_hoa_data: NotRequired[bool]
221
+ r"""Default - true."""
222
+ is_auction: NotRequired[bool]
223
+ r"""Auctions. Default true."""
224
+ schools: NotRequired[str]
225
+ r"""Available values: elementary, public, private, middle, charter, high
226
+ For multiple selection, separate with comma: middle,high
227
+
228
+ """
229
+ schools_rating: NotRequired[str]
230
+ r"""Min school ratings. From 1 to 10."""
231
+ include_unrated_schools: NotRequired[bool]
232
+ r"""Include schools with no rating."""
233
+ has_garage: NotRequired[bool]
234
+ r"""Must have a garage. Default value false."""
235
+ parking_spots: NotRequired[float]
236
+ r"""Parking Spots. Max value - 4."""
237
+ is_foreclosed: NotRequired[bool]
238
+ is_pre_foreclosure: NotRequired[bool]
239
+ is_entire_place: NotRequired[bool]
240
+ r"""Default - true. Apply when status_type = 'ForRent'. Set it to false if you
241
+ need only a room.
242
+
243
+ """
244
+ is_room: NotRequired[bool]
245
+ r"""Default - false. Apply when status_type = 'ForRent'. Set it true and
246
+ isEntirePlace to false if you need only a room.
247
+
248
+ """
249
+ large_dogs_allowed: NotRequired[bool]
250
+ r"""Allows large dogs. Only For Rent."""
251
+ small_dogs_allowed: NotRequired[bool]
252
+ r"""Allows small dogs. Only For Rent."""
253
+ cats_allowed: NotRequired[bool]
254
+ r"""Allows cats. Only For Rent."""
255
+ no_pets: NotRequired[bool]
256
+ r"""No pets. Only For Rent."""
257
+ move_in_date: NotRequired[date]
258
+ r"""Move-in Date. Only For Rent."""
259
+ parking_available: NotRequired[bool]
260
+ r"""On-site Parking. Only For Rent."""
261
+ in_unit_laundry: NotRequired[bool]
262
+ r"""In-unit Laundry. Only For Rent."""
263
+ accepts_applications: NotRequired[bool]
264
+ r"""Accepts Zillow Applications. Only For Rent."""
265
+ income_restricted: NotRequired[bool]
266
+ r"""Income restricted. Only For Rent."""
267
+ hardwood_floor: NotRequired[bool]
268
+ r"""Hardwood Floors. Only For Rent."""
269
+ disabled_access: NotRequired[bool]
270
+ r"""Disabled Access. Only For Rent."""
271
+ utilities_included: NotRequired[bool]
272
+ r"""Utilities Included. Only For Rent."""
273
+ short_term_lease: NotRequired[bool]
274
+ r"""Short term lease available. Only For Rent."""
275
+ furnished: NotRequired[bool]
276
+ r"""Furnished. Only For Rent."""
277
+ outdoor_space: NotRequired[bool]
278
+ r"""Outdoor space. Only For Rent."""
279
+ controlled_access: NotRequired[bool]
280
+ r"""Controlled access. Only For Rent."""
281
+ high_speed_internet: NotRequired[bool]
282
+ r"""High speed internet. Only For Rent."""
283
+ elevator: NotRequired[bool]
284
+ r"""Elevator. Only For Rent."""
285
+ multi_family_building: NotRequired[bool]
286
+ r"""Apartment Community. Only For Rent."""
61
287
 
62
288
 
63
289
  class PropertyExtendedSearchRequest(BaseModel):
@@ -65,7 +291,10 @@ class PropertyExtendedSearchRequest(BaseModel):
65
291
  Optional[str],
66
292
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
67
293
  ] = None
68
- r"""Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty."""
294
+ r"""Location details (address, county, neighborhood, or Zip code). Required if
295
+ polygon or coordinates are empty.
296
+
297
+ """
69
298
 
70
299
  page: Annotated[
71
300
  Optional[int],
@@ -91,6 +320,16 @@ class PropertyExtendedSearchRequest(BaseModel):
91
320
  ] = None
92
321
  r"""Sorting order."""
93
322
 
323
+ polygon: Annotated[
324
+ Optional[str],
325
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
326
+ ] = None
327
+ r"""Polygon coordinates in the format: lon lat,lon1 lat1,lon2 lat2. It is
328
+ required if the location or coordinates are empty. The last pair must be the
329
+ same as the first pair.
330
+
331
+ """
332
+
94
333
  min_price: Annotated[
95
334
  Optional[float],
96
335
  pydantic.Field(alias="minPrice"),
@@ -104,3 +343,481 @@ class PropertyExtendedSearchRequest(BaseModel):
104
343
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
105
344
  ] = None
106
345
  r"""Maximum price filter."""
346
+
347
+ rent_min_price: Annotated[
348
+ Optional[float],
349
+ pydantic.Field(alias="rentMinPrice"),
350
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
351
+ ] = None
352
+ r"""Minimum rent price filter (if status_type = ForRent)."""
353
+
354
+ rent_max_price: Annotated[
355
+ Optional[float],
356
+ pydantic.Field(alias="rentMaxPrice"),
357
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
358
+ ] = None
359
+ r"""Maximum rent price filter (if status_type = ForRent)."""
360
+
361
+ baths_min: Annotated[
362
+ Optional[float],
363
+ pydantic.Field(alias="bathsMin"),
364
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
365
+ ] = None
366
+ r"""Bathrooms min count."""
367
+
368
+ baths_max: Annotated[
369
+ Optional[float],
370
+ pydantic.Field(alias="bathsMax"),
371
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
372
+ ] = None
373
+ r"""Bathrooms max count."""
374
+
375
+ beds_min: Annotated[
376
+ Optional[float],
377
+ pydantic.Field(alias="bedsMin"),
378
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
379
+ ] = None
380
+ r"""Bedrooms min count."""
381
+
382
+ beds_max: Annotated[
383
+ Optional[float],
384
+ pydantic.Field(alias="bedsMax"),
385
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
386
+ ] = None
387
+ r"""Bedrooms max count."""
388
+
389
+ sqft_min: Annotated[
390
+ Optional[float],
391
+ pydantic.Field(alias="sqftMin"),
392
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
393
+ ] = None
394
+ r"""Square Feet min value."""
395
+
396
+ sqft_max: Annotated[
397
+ Optional[float],
398
+ pydantic.Field(alias="sqftMax"),
399
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
400
+ ] = None
401
+ r"""Square Feet max value."""
402
+
403
+ build_year_min: Annotated[
404
+ Optional[float],
405
+ pydantic.Field(alias="buildYearMin"),
406
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
407
+ ] = None
408
+ r"""Year Built min value."""
409
+
410
+ build_year_max: Annotated[
411
+ Optional[float],
412
+ pydantic.Field(alias="buildYearMax"),
413
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
414
+ ] = None
415
+ r"""Year Built max value."""
416
+
417
+ days_on: Annotated[
418
+ Optional[DaysOn],
419
+ pydantic.Field(alias="daysOn"),
420
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
421
+ ] = None
422
+ r"""Days on Z. Use with status_type='ForSale' or status_type='ForRent'.
423
+
424
+ """
425
+
426
+ sold_in_last: Annotated[
427
+ Optional[SoldInLast],
428
+ pydantic.Field(alias="soldInLast"),
429
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
430
+ ] = None
431
+ r"""Sold in the last. Use with status_type='RecentlySold'.
432
+
433
+ """
434
+
435
+ is_basement_finished: Annotated[
436
+ Optional[float],
437
+ pydantic.Field(alias="isBasementFinished"),
438
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
439
+ ] = None
440
+ r"""Basement filter. Set it to 1 if needed."""
441
+
442
+ is_basement_unfinished: Annotated[
443
+ Optional[float],
444
+ pydantic.Field(alias="isBasementUnfinished"),
445
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
446
+ ] = None
447
+ r"""Basement filter. Set it to 1 if needed."""
448
+
449
+ is_pending_under_contract: Annotated[
450
+ Optional[float],
451
+ pydantic.Field(alias="isPendingUnderContract"),
452
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
453
+ ] = None
454
+ r"""Pending & Under Contract filter. Set it to 1 if needed."""
455
+
456
+ is_accepting_backup_offers: Annotated[
457
+ Optional[float],
458
+ pydantic.Field(alias="isAcceptingBackupOffers"),
459
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
460
+ ] = None
461
+ r"""Accepting Backup Offers filter. Set it to 1 if needed."""
462
+
463
+ is_coming_soon: Annotated[
464
+ Optional[bool],
465
+ pydantic.Field(alias="isComingSoon"),
466
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
467
+ ] = None
468
+ r"""Coming Soon listings are homes that will soon be on the market. Set it to 1
469
+ if needed.
470
+
471
+ """
472
+
473
+ other_listings: Annotated[
474
+ Optional[bool],
475
+ pydantic.Field(alias="otherListings"),
476
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
477
+ ] = None
478
+ r"""If set to 1, the results will only include data from the Other Listings tab.
479
+
480
+ """
481
+
482
+ is_new_construction: Annotated[
483
+ Optional[bool],
484
+ pydantic.Field(alias="isNewConstruction"),
485
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
486
+ ] = None
487
+ r"""New Construction filter. Set it to 1 or true if you only need properties
488
+ with New Construction status.
489
+
490
+ """
491
+
492
+ keywords: Annotated[
493
+ Optional[str],
494
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
495
+ ] = None
496
+ r"""Keywords filter for property search."""
497
+
498
+ lot_size_min: Annotated[
499
+ Optional[LotSizeMin],
500
+ pydantic.Field(alias="lotSizeMin"),
501
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
502
+ ] = None
503
+ r"""Minimum lot size."""
504
+
505
+ lot_size_max: Annotated[
506
+ Optional[LotSizeMax],
507
+ pydantic.Field(alias="lotSizeMax"),
508
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
509
+ ] = None
510
+ r"""Maximum lot size."""
511
+
512
+ sale_by_agent: Annotated[
513
+ Optional[str],
514
+ pydantic.Field(alias="saleByAgent"),
515
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
516
+ ] = None
517
+ r"""Default - true. To get FSBO set
518
+ saleByAgent=false&saleByOwner=true&otherListings=true.
519
+
520
+ """
521
+
522
+ sale_by_owner: Annotated[
523
+ Optional[str],
524
+ pydantic.Field(alias="saleByOwner"),
525
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
526
+ ] = None
527
+ r"""Default - true. To get only FSBO set
528
+ saleByAgent=false&saleByOwner=true&otherListings=true.
529
+
530
+ """
531
+
532
+ is_for_sale_foreclosure: Annotated[
533
+ Optional[bool],
534
+ pydantic.Field(alias="isForSaleForeclosure"),
535
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
536
+ ] = None
537
+ r"""If you only need to get ForSaleForeclosure set to true or 1."""
538
+
539
+ is_waterfront: Annotated[
540
+ Optional[bool],
541
+ pydantic.Field(alias="isWaterfront"),
542
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
543
+ ] = None
544
+
545
+ has_pool: Annotated[
546
+ Optional[bool],
547
+ pydantic.Field(alias="hasPool"),
548
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
549
+ ] = None
550
+
551
+ has_air_conditioning: Annotated[
552
+ Optional[bool],
553
+ pydantic.Field(alias="hasAirConditioning"),
554
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
555
+ ] = None
556
+
557
+ is_city_view: Annotated[
558
+ Optional[bool],
559
+ pydantic.Field(alias="isCityView"),
560
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
561
+ ] = None
562
+
563
+ is_mountain_view: Annotated[
564
+ Optional[bool],
565
+ pydantic.Field(alias="isMountainView"),
566
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
567
+ ] = None
568
+
569
+ is_water_view: Annotated[
570
+ Optional[bool],
571
+ pydantic.Field(alias="isWaterView"),
572
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
573
+ ] = None
574
+
575
+ is_park_view: Annotated[
576
+ Optional[bool],
577
+ pydantic.Field(alias="isParkView"),
578
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
579
+ ] = None
580
+
581
+ is_open_houses_only: Annotated[
582
+ Optional[bool],
583
+ pydantic.Field(alias="isOpenHousesOnly"),
584
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
585
+ ] = None
586
+ r"""Must have open house."""
587
+
588
+ is3d_home: Annotated[
589
+ Optional[bool],
590
+ pydantic.Field(alias="is3dHome"),
591
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
592
+ ] = None
593
+ r"""Must have 3D Tour."""
594
+
595
+ coordinates: Annotated[
596
+ Optional[str],
597
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
598
+ ] = None
599
+ r"""It is required if the location or polygon is empty.
600
+ Format: lon lat,diameter. Diameter in miles from 1 to 99 -118.51750373840332
601
+ 34.007063913440916,20
602
+
603
+ """
604
+
605
+ hoa: Annotated[
606
+ Optional[float],
607
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
608
+ ] = None
609
+ r"""Max HOA."""
610
+
611
+ include_homes_with_no_hoa_data: Annotated[
612
+ Optional[bool],
613
+ pydantic.Field(alias="includeHomesWithNoHoaData"),
614
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
615
+ ] = None
616
+ r"""Default - true."""
617
+
618
+ is_auction: Annotated[
619
+ Optional[bool],
620
+ pydantic.Field(alias="isAuction"),
621
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
622
+ ] = None
623
+ r"""Auctions. Default true."""
624
+
625
+ schools: Annotated[
626
+ Optional[str],
627
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
628
+ ] = None
629
+ r"""Available values: elementary, public, private, middle, charter, high
630
+ For multiple selection, separate with comma: middle,high
631
+
632
+ """
633
+
634
+ schools_rating: Annotated[
635
+ Optional[str],
636
+ pydantic.Field(alias="schoolsRating"),
637
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
638
+ ] = None
639
+ r"""Min school ratings. From 1 to 10."""
640
+
641
+ include_unrated_schools: Annotated[
642
+ Optional[bool],
643
+ pydantic.Field(alias="includeUnratedSchools"),
644
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
645
+ ] = None
646
+ r"""Include schools with no rating."""
647
+
648
+ has_garage: Annotated[
649
+ Optional[bool],
650
+ pydantic.Field(alias="hasGarage"),
651
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
652
+ ] = None
653
+ r"""Must have a garage. Default value false."""
654
+
655
+ parking_spots: Annotated[
656
+ Optional[float],
657
+ pydantic.Field(alias="parkingSpots"),
658
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
659
+ ] = None
660
+ r"""Parking Spots. Max value - 4."""
661
+
662
+ is_foreclosed: Annotated[
663
+ Optional[bool],
664
+ pydantic.Field(alias="isForeclosed"),
665
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
666
+ ] = None
667
+
668
+ is_pre_foreclosure: Annotated[
669
+ Optional[bool],
670
+ pydantic.Field(alias="isPreForeclosure"),
671
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
672
+ ] = None
673
+
674
+ is_entire_place: Annotated[
675
+ Optional[bool],
676
+ pydantic.Field(alias="isEntirePlace"),
677
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
678
+ ] = None
679
+ r"""Default - true. Apply when status_type = 'ForRent'. Set it to false if you
680
+ need only a room.
681
+
682
+ """
683
+
684
+ is_room: Annotated[
685
+ Optional[bool],
686
+ pydantic.Field(alias="isRoom"),
687
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
688
+ ] = None
689
+ r"""Default - false. Apply when status_type = 'ForRent'. Set it true and
690
+ isEntirePlace to false if you need only a room.
691
+
692
+ """
693
+
694
+ large_dogs_allowed: Annotated[
695
+ Optional[bool],
696
+ pydantic.Field(alias="largeDogsAllowed"),
697
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
698
+ ] = None
699
+ r"""Allows large dogs. Only For Rent."""
700
+
701
+ small_dogs_allowed: Annotated[
702
+ Optional[bool],
703
+ pydantic.Field(alias="smallDogsAllowed"),
704
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
705
+ ] = None
706
+ r"""Allows small dogs. Only For Rent."""
707
+
708
+ cats_allowed: Annotated[
709
+ Optional[bool],
710
+ pydantic.Field(alias="catsAllowed"),
711
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
712
+ ] = None
713
+ r"""Allows cats. Only For Rent."""
714
+
715
+ no_pets: Annotated[
716
+ Optional[bool],
717
+ pydantic.Field(alias="noPets"),
718
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
719
+ ] = None
720
+ r"""No pets. Only For Rent."""
721
+
722
+ move_in_date: Annotated[
723
+ Optional[date],
724
+ pydantic.Field(alias="moveInDate"),
725
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
726
+ ] = None
727
+ r"""Move-in Date. Only For Rent."""
728
+
729
+ parking_available: Annotated[
730
+ Optional[bool],
731
+ pydantic.Field(alias="parkingAvailable"),
732
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
733
+ ] = None
734
+ r"""On-site Parking. Only For Rent."""
735
+
736
+ in_unit_laundry: Annotated[
737
+ Optional[bool],
738
+ pydantic.Field(alias="inUnitLaundry"),
739
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
740
+ ] = None
741
+ r"""In-unit Laundry. Only For Rent."""
742
+
743
+ accepts_applications: Annotated[
744
+ Optional[bool],
745
+ pydantic.Field(alias="acceptsApplications"),
746
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
747
+ ] = None
748
+ r"""Accepts Zillow Applications. Only For Rent."""
749
+
750
+ income_restricted: Annotated[
751
+ Optional[bool],
752
+ pydantic.Field(alias="incomeRestricted"),
753
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
754
+ ] = None
755
+ r"""Income restricted. Only For Rent."""
756
+
757
+ hardwood_floor: Annotated[
758
+ Optional[bool],
759
+ pydantic.Field(alias="hardwoodFloor"),
760
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
761
+ ] = None
762
+ r"""Hardwood Floors. Only For Rent."""
763
+
764
+ disabled_access: Annotated[
765
+ Optional[bool],
766
+ pydantic.Field(alias="disabledAccess"),
767
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
768
+ ] = None
769
+ r"""Disabled Access. Only For Rent."""
770
+
771
+ utilities_included: Annotated[
772
+ Optional[bool],
773
+ pydantic.Field(alias="utilitiesIncluded"),
774
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
775
+ ] = None
776
+ r"""Utilities Included. Only For Rent."""
777
+
778
+ short_term_lease: Annotated[
779
+ Optional[bool],
780
+ pydantic.Field(alias="shortTermLease"),
781
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
782
+ ] = None
783
+ r"""Short term lease available. Only For Rent."""
784
+
785
+ furnished: Annotated[
786
+ Optional[bool],
787
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
788
+ ] = None
789
+ r"""Furnished. Only For Rent."""
790
+
791
+ outdoor_space: Annotated[
792
+ Optional[bool],
793
+ pydantic.Field(alias="outdoorSpace"),
794
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
795
+ ] = None
796
+ r"""Outdoor space. Only For Rent."""
797
+
798
+ controlled_access: Annotated[
799
+ Optional[bool],
800
+ pydantic.Field(alias="controlledAccess"),
801
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
802
+ ] = None
803
+ r"""Controlled access. Only For Rent."""
804
+
805
+ high_speed_internet: Annotated[
806
+ Optional[bool],
807
+ pydantic.Field(alias="highSpeedInternet"),
808
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
809
+ ] = None
810
+ r"""High speed internet. Only For Rent."""
811
+
812
+ elevator: Annotated[
813
+ Optional[bool],
814
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
815
+ ] = None
816
+ r"""Elevator. Only For Rent."""
817
+
818
+ multi_family_building: Annotated[
819
+ Optional[bool],
820
+ pydantic.Field(alias="multiFamilyBuilding"),
821
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
822
+ ] = None
823
+ r"""Apartment Community. Only For Rent."""
@@ -1,6 +1,7 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from .basesdk import BaseSDK
4
+ from datetime import date
4
5
  from typing import Mapping, Optional
5
6
  from zillow_rapidapi_client import models, utils
6
7
  from zillow_rapidapi_client._hooks import HookContext
@@ -16,8 +17,75 @@ class Properties(BaseSDK):
16
17
  status_type: Optional[models.StatusType] = None,
17
18
  home_type: Optional[models.HomeType] = None,
18
19
  sort: Optional[models.Sort] = None,
20
+ polygon: Optional[str] = None,
19
21
  min_price: Optional[float] = None,
20
22
  max_price: Optional[float] = None,
23
+ rent_min_price: Optional[float] = None,
24
+ rent_max_price: Optional[float] = None,
25
+ baths_min: Optional[float] = None,
26
+ baths_max: Optional[float] = None,
27
+ beds_min: Optional[float] = None,
28
+ beds_max: Optional[float] = None,
29
+ sqft_min: Optional[float] = None,
30
+ sqft_max: Optional[float] = None,
31
+ build_year_min: Optional[float] = None,
32
+ build_year_max: Optional[float] = None,
33
+ days_on: Optional[models.DaysOn] = None,
34
+ sold_in_last: Optional[models.SoldInLast] = None,
35
+ is_basement_finished: Optional[float] = None,
36
+ is_basement_unfinished: Optional[float] = None,
37
+ is_pending_under_contract: Optional[float] = None,
38
+ is_accepting_backup_offers: Optional[float] = None,
39
+ is_coming_soon: Optional[bool] = None,
40
+ other_listings: Optional[bool] = None,
41
+ is_new_construction: Optional[bool] = None,
42
+ keywords: Optional[str] = None,
43
+ lot_size_min: Optional[models.LotSizeMin] = None,
44
+ lot_size_max: Optional[models.LotSizeMax] = None,
45
+ sale_by_agent: Optional[str] = None,
46
+ sale_by_owner: Optional[str] = None,
47
+ is_for_sale_foreclosure: Optional[bool] = None,
48
+ is_waterfront: Optional[bool] = None,
49
+ has_pool: Optional[bool] = None,
50
+ has_air_conditioning: Optional[bool] = None,
51
+ is_city_view: Optional[bool] = None,
52
+ is_mountain_view: Optional[bool] = None,
53
+ is_water_view: Optional[bool] = None,
54
+ is_park_view: Optional[bool] = None,
55
+ is_open_houses_only: Optional[bool] = None,
56
+ is3d_home: Optional[bool] = None,
57
+ coordinates: Optional[str] = None,
58
+ hoa: Optional[float] = None,
59
+ include_homes_with_no_hoa_data: Optional[bool] = None,
60
+ is_auction: Optional[bool] = None,
61
+ schools: Optional[str] = None,
62
+ schools_rating: Optional[str] = None,
63
+ include_unrated_schools: Optional[bool] = None,
64
+ has_garage: Optional[bool] = None,
65
+ parking_spots: Optional[float] = None,
66
+ is_foreclosed: Optional[bool] = None,
67
+ is_pre_foreclosure: Optional[bool] = None,
68
+ is_entire_place: Optional[bool] = None,
69
+ is_room: Optional[bool] = None,
70
+ large_dogs_allowed: Optional[bool] = None,
71
+ small_dogs_allowed: Optional[bool] = None,
72
+ cats_allowed: Optional[bool] = None,
73
+ no_pets: Optional[bool] = None,
74
+ move_in_date: Optional[date] = None,
75
+ parking_available: Optional[bool] = None,
76
+ in_unit_laundry: Optional[bool] = None,
77
+ accepts_applications: Optional[bool] = None,
78
+ income_restricted: Optional[bool] = None,
79
+ hardwood_floor: Optional[bool] = None,
80
+ disabled_access: Optional[bool] = None,
81
+ utilities_included: Optional[bool] = None,
82
+ short_term_lease: Optional[bool] = None,
83
+ furnished: Optional[bool] = None,
84
+ outdoor_space: Optional[bool] = None,
85
+ controlled_access: Optional[bool] = None,
86
+ high_speed_internet: Optional[bool] = None,
87
+ elevator: Optional[bool] = None,
88
+ multi_family_building: Optional[bool] = None,
21
89
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
22
90
  server_url: Optional[str] = None,
23
91
  timeout_ms: Optional[int] = None,
@@ -25,13 +93,80 @@ class Properties(BaseSDK):
25
93
  ) -> models.PropertySearchResponse:
26
94
  r"""Search for properties
27
95
 
28
- :param location: Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty.
96
+ :param location: Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty.
29
97
  :param page: Page number for paginated results. Max value is 20.
30
98
  :param status_type: Property status type.
31
99
  :param home_type: Property type. Comma-separated list.
32
100
  :param sort: Sorting order.
101
+ :param polygon: Polygon coordinates in the format: lon lat,lon1 lat1,lon2 lat2. It is required if the location or coordinates are empty. The last pair must be the same as the first pair.
33
102
  :param min_price: Minimum price filter.
34
103
  :param max_price: Maximum price filter.
104
+ :param rent_min_price: Minimum rent price filter (if status_type = ForRent).
105
+ :param rent_max_price: Maximum rent price filter (if status_type = ForRent).
106
+ :param baths_min: Bathrooms min count.
107
+ :param baths_max: Bathrooms max count.
108
+ :param beds_min: Bedrooms min count.
109
+ :param beds_max: Bedrooms max count.
110
+ :param sqft_min: Square Feet min value.
111
+ :param sqft_max: Square Feet max value.
112
+ :param build_year_min: Year Built min value.
113
+ :param build_year_max: Year Built max value.
114
+ :param days_on: Days on Z. Use with status_type='ForSale' or status_type='ForRent'.
115
+ :param sold_in_last: Sold in the last. Use with status_type='RecentlySold'.
116
+ :param is_basement_finished: Basement filter. Set it to 1 if needed.
117
+ :param is_basement_unfinished: Basement filter. Set it to 1 if needed.
118
+ :param is_pending_under_contract: Pending & Under Contract filter. Set it to 1 if needed.
119
+ :param is_accepting_backup_offers: Accepting Backup Offers filter. Set it to 1 if needed.
120
+ :param is_coming_soon: Coming Soon listings are homes that will soon be on the market. Set it to 1 if needed.
121
+ :param other_listings: If set to 1, the results will only include data from the Other Listings tab.
122
+ :param is_new_construction: New Construction filter. Set it to 1 or true if you only need properties with New Construction status.
123
+ :param keywords: Keywords filter for property search.
124
+ :param lot_size_min: Minimum lot size.
125
+ :param lot_size_max: Maximum lot size.
126
+ :param sale_by_agent: Default - true. To get FSBO set saleByAgent=false&saleByOwner=true&otherListings=true.
127
+ :param sale_by_owner: Default - true. To get only FSBO set saleByAgent=false&saleByOwner=true&otherListings=true.
128
+ :param is_for_sale_foreclosure: If you only need to get ForSaleForeclosure set to true or 1.
129
+ :param is_waterfront:
130
+ :param has_pool:
131
+ :param has_air_conditioning:
132
+ :param is_city_view:
133
+ :param is_mountain_view:
134
+ :param is_water_view:
135
+ :param is_park_view:
136
+ :param is_open_houses_only: Must have open house.
137
+ :param is3d_home: Must have 3D Tour.
138
+ :param coordinates: It is required if the location or polygon is empty. Format: lon lat,diameter. Diameter in miles from 1 to 99 -118.51750373840332 34.007063913440916,20
139
+ :param hoa: Max HOA.
140
+ :param include_homes_with_no_hoa_data: Default - true.
141
+ :param is_auction: Auctions. Default true.
142
+ :param schools: Available values: elementary, public, private, middle, charter, high For multiple selection, separate with comma: middle,high
143
+ :param schools_rating: Min school ratings. From 1 to 10.
144
+ :param include_unrated_schools: Include schools with no rating.
145
+ :param has_garage: Must have a garage. Default value false.
146
+ :param parking_spots: Parking Spots. Max value - 4.
147
+ :param is_foreclosed:
148
+ :param is_pre_foreclosure:
149
+ :param is_entire_place: Default - true. Apply when status_type = 'ForRent'. Set it to false if you need only a room.
150
+ :param is_room: Default - false. Apply when status_type = 'ForRent'. Set it true and isEntirePlace to false if you need only a room.
151
+ :param large_dogs_allowed: Allows large dogs. Only For Rent.
152
+ :param small_dogs_allowed: Allows small dogs. Only For Rent.
153
+ :param cats_allowed: Allows cats. Only For Rent.
154
+ :param no_pets: No pets. Only For Rent.
155
+ :param move_in_date: Move-in Date. Only For Rent.
156
+ :param parking_available: On-site Parking. Only For Rent.
157
+ :param in_unit_laundry: In-unit Laundry. Only For Rent.
158
+ :param accepts_applications: Accepts Zillow Applications. Only For Rent.
159
+ :param income_restricted: Income restricted. Only For Rent.
160
+ :param hardwood_floor: Hardwood Floors. Only For Rent.
161
+ :param disabled_access: Disabled Access. Only For Rent.
162
+ :param utilities_included: Utilities Included. Only For Rent.
163
+ :param short_term_lease: Short term lease available. Only For Rent.
164
+ :param furnished: Furnished. Only For Rent.
165
+ :param outdoor_space: Outdoor space. Only For Rent.
166
+ :param controlled_access: Controlled access. Only For Rent.
167
+ :param high_speed_internet: High speed internet. Only For Rent.
168
+ :param elevator: Elevator. Only For Rent.
169
+ :param multi_family_building: Apartment Community. Only For Rent.
35
170
  :param retries: Override the default retry configuration for this method
36
171
  :param server_url: Override the default server URL for this method
37
172
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -53,8 +188,75 @@ class Properties(BaseSDK):
53
188
  status_type=status_type,
54
189
  home_type=home_type,
55
190
  sort=sort,
191
+ polygon=polygon,
56
192
  min_price=min_price,
57
193
  max_price=max_price,
194
+ rent_min_price=rent_min_price,
195
+ rent_max_price=rent_max_price,
196
+ baths_min=baths_min,
197
+ baths_max=baths_max,
198
+ beds_min=beds_min,
199
+ beds_max=beds_max,
200
+ sqft_min=sqft_min,
201
+ sqft_max=sqft_max,
202
+ build_year_min=build_year_min,
203
+ build_year_max=build_year_max,
204
+ days_on=days_on,
205
+ sold_in_last=sold_in_last,
206
+ is_basement_finished=is_basement_finished,
207
+ is_basement_unfinished=is_basement_unfinished,
208
+ is_pending_under_contract=is_pending_under_contract,
209
+ is_accepting_backup_offers=is_accepting_backup_offers,
210
+ is_coming_soon=is_coming_soon,
211
+ other_listings=other_listings,
212
+ is_new_construction=is_new_construction,
213
+ keywords=keywords,
214
+ lot_size_min=lot_size_min,
215
+ lot_size_max=lot_size_max,
216
+ sale_by_agent=sale_by_agent,
217
+ sale_by_owner=sale_by_owner,
218
+ is_for_sale_foreclosure=is_for_sale_foreclosure,
219
+ is_waterfront=is_waterfront,
220
+ has_pool=has_pool,
221
+ has_air_conditioning=has_air_conditioning,
222
+ is_city_view=is_city_view,
223
+ is_mountain_view=is_mountain_view,
224
+ is_water_view=is_water_view,
225
+ is_park_view=is_park_view,
226
+ is_open_houses_only=is_open_houses_only,
227
+ is3d_home=is3d_home,
228
+ coordinates=coordinates,
229
+ hoa=hoa,
230
+ include_homes_with_no_hoa_data=include_homes_with_no_hoa_data,
231
+ is_auction=is_auction,
232
+ schools=schools,
233
+ schools_rating=schools_rating,
234
+ include_unrated_schools=include_unrated_schools,
235
+ has_garage=has_garage,
236
+ parking_spots=parking_spots,
237
+ is_foreclosed=is_foreclosed,
238
+ is_pre_foreclosure=is_pre_foreclosure,
239
+ is_entire_place=is_entire_place,
240
+ is_room=is_room,
241
+ large_dogs_allowed=large_dogs_allowed,
242
+ small_dogs_allowed=small_dogs_allowed,
243
+ cats_allowed=cats_allowed,
244
+ no_pets=no_pets,
245
+ move_in_date=move_in_date,
246
+ parking_available=parking_available,
247
+ in_unit_laundry=in_unit_laundry,
248
+ accepts_applications=accepts_applications,
249
+ income_restricted=income_restricted,
250
+ hardwood_floor=hardwood_floor,
251
+ disabled_access=disabled_access,
252
+ utilities_included=utilities_included,
253
+ short_term_lease=short_term_lease,
254
+ furnished=furnished,
255
+ outdoor_space=outdoor_space,
256
+ controlled_access=controlled_access,
257
+ high_speed_internet=high_speed_internet,
258
+ elevator=elevator,
259
+ multi_family_building=multi_family_building,
58
260
  )
59
261
 
60
262
  req = self._build_request(
@@ -122,8 +324,75 @@ class Properties(BaseSDK):
122
324
  status_type: Optional[models.StatusType] = None,
123
325
  home_type: Optional[models.HomeType] = None,
124
326
  sort: Optional[models.Sort] = None,
327
+ polygon: Optional[str] = None,
125
328
  min_price: Optional[float] = None,
126
329
  max_price: Optional[float] = None,
330
+ rent_min_price: Optional[float] = None,
331
+ rent_max_price: Optional[float] = None,
332
+ baths_min: Optional[float] = None,
333
+ baths_max: Optional[float] = None,
334
+ beds_min: Optional[float] = None,
335
+ beds_max: Optional[float] = None,
336
+ sqft_min: Optional[float] = None,
337
+ sqft_max: Optional[float] = None,
338
+ build_year_min: Optional[float] = None,
339
+ build_year_max: Optional[float] = None,
340
+ days_on: Optional[models.DaysOn] = None,
341
+ sold_in_last: Optional[models.SoldInLast] = None,
342
+ is_basement_finished: Optional[float] = None,
343
+ is_basement_unfinished: Optional[float] = None,
344
+ is_pending_under_contract: Optional[float] = None,
345
+ is_accepting_backup_offers: Optional[float] = None,
346
+ is_coming_soon: Optional[bool] = None,
347
+ other_listings: Optional[bool] = None,
348
+ is_new_construction: Optional[bool] = None,
349
+ keywords: Optional[str] = None,
350
+ lot_size_min: Optional[models.LotSizeMin] = None,
351
+ lot_size_max: Optional[models.LotSizeMax] = None,
352
+ sale_by_agent: Optional[str] = None,
353
+ sale_by_owner: Optional[str] = None,
354
+ is_for_sale_foreclosure: Optional[bool] = None,
355
+ is_waterfront: Optional[bool] = None,
356
+ has_pool: Optional[bool] = None,
357
+ has_air_conditioning: Optional[bool] = None,
358
+ is_city_view: Optional[bool] = None,
359
+ is_mountain_view: Optional[bool] = None,
360
+ is_water_view: Optional[bool] = None,
361
+ is_park_view: Optional[bool] = None,
362
+ is_open_houses_only: Optional[bool] = None,
363
+ is3d_home: Optional[bool] = None,
364
+ coordinates: Optional[str] = None,
365
+ hoa: Optional[float] = None,
366
+ include_homes_with_no_hoa_data: Optional[bool] = None,
367
+ is_auction: Optional[bool] = None,
368
+ schools: Optional[str] = None,
369
+ schools_rating: Optional[str] = None,
370
+ include_unrated_schools: Optional[bool] = None,
371
+ has_garage: Optional[bool] = None,
372
+ parking_spots: Optional[float] = None,
373
+ is_foreclosed: Optional[bool] = None,
374
+ is_pre_foreclosure: Optional[bool] = None,
375
+ is_entire_place: Optional[bool] = None,
376
+ is_room: Optional[bool] = None,
377
+ large_dogs_allowed: Optional[bool] = None,
378
+ small_dogs_allowed: Optional[bool] = None,
379
+ cats_allowed: Optional[bool] = None,
380
+ no_pets: Optional[bool] = None,
381
+ move_in_date: Optional[date] = None,
382
+ parking_available: Optional[bool] = None,
383
+ in_unit_laundry: Optional[bool] = None,
384
+ accepts_applications: Optional[bool] = None,
385
+ income_restricted: Optional[bool] = None,
386
+ hardwood_floor: Optional[bool] = None,
387
+ disabled_access: Optional[bool] = None,
388
+ utilities_included: Optional[bool] = None,
389
+ short_term_lease: Optional[bool] = None,
390
+ furnished: Optional[bool] = None,
391
+ outdoor_space: Optional[bool] = None,
392
+ controlled_access: Optional[bool] = None,
393
+ high_speed_internet: Optional[bool] = None,
394
+ elevator: Optional[bool] = None,
395
+ multi_family_building: Optional[bool] = None,
127
396
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
128
397
  server_url: Optional[str] = None,
129
398
  timeout_ms: Optional[int] = None,
@@ -131,13 +400,80 @@ class Properties(BaseSDK):
131
400
  ) -> models.PropertySearchResponse:
132
401
  r"""Search for properties
133
402
 
134
- :param location: Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty.
403
+ :param location: Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty.
135
404
  :param page: Page number for paginated results. Max value is 20.
136
405
  :param status_type: Property status type.
137
406
  :param home_type: Property type. Comma-separated list.
138
407
  :param sort: Sorting order.
408
+ :param polygon: Polygon coordinates in the format: lon lat,lon1 lat1,lon2 lat2. It is required if the location or coordinates are empty. The last pair must be the same as the first pair.
139
409
  :param min_price: Minimum price filter.
140
410
  :param max_price: Maximum price filter.
411
+ :param rent_min_price: Minimum rent price filter (if status_type = ForRent).
412
+ :param rent_max_price: Maximum rent price filter (if status_type = ForRent).
413
+ :param baths_min: Bathrooms min count.
414
+ :param baths_max: Bathrooms max count.
415
+ :param beds_min: Bedrooms min count.
416
+ :param beds_max: Bedrooms max count.
417
+ :param sqft_min: Square Feet min value.
418
+ :param sqft_max: Square Feet max value.
419
+ :param build_year_min: Year Built min value.
420
+ :param build_year_max: Year Built max value.
421
+ :param days_on: Days on Z. Use with status_type='ForSale' or status_type='ForRent'.
422
+ :param sold_in_last: Sold in the last. Use with status_type='RecentlySold'.
423
+ :param is_basement_finished: Basement filter. Set it to 1 if needed.
424
+ :param is_basement_unfinished: Basement filter. Set it to 1 if needed.
425
+ :param is_pending_under_contract: Pending & Under Contract filter. Set it to 1 if needed.
426
+ :param is_accepting_backup_offers: Accepting Backup Offers filter. Set it to 1 if needed.
427
+ :param is_coming_soon: Coming Soon listings are homes that will soon be on the market. Set it to 1 if needed.
428
+ :param other_listings: If set to 1, the results will only include data from the Other Listings tab.
429
+ :param is_new_construction: New Construction filter. Set it to 1 or true if you only need properties with New Construction status.
430
+ :param keywords: Keywords filter for property search.
431
+ :param lot_size_min: Minimum lot size.
432
+ :param lot_size_max: Maximum lot size.
433
+ :param sale_by_agent: Default - true. To get FSBO set saleByAgent=false&saleByOwner=true&otherListings=true.
434
+ :param sale_by_owner: Default - true. To get only FSBO set saleByAgent=false&saleByOwner=true&otherListings=true.
435
+ :param is_for_sale_foreclosure: If you only need to get ForSaleForeclosure set to true or 1.
436
+ :param is_waterfront:
437
+ :param has_pool:
438
+ :param has_air_conditioning:
439
+ :param is_city_view:
440
+ :param is_mountain_view:
441
+ :param is_water_view:
442
+ :param is_park_view:
443
+ :param is_open_houses_only: Must have open house.
444
+ :param is3d_home: Must have 3D Tour.
445
+ :param coordinates: It is required if the location or polygon is empty. Format: lon lat,diameter. Diameter in miles from 1 to 99 -118.51750373840332 34.007063913440916,20
446
+ :param hoa: Max HOA.
447
+ :param include_homes_with_no_hoa_data: Default - true.
448
+ :param is_auction: Auctions. Default true.
449
+ :param schools: Available values: elementary, public, private, middle, charter, high For multiple selection, separate with comma: middle,high
450
+ :param schools_rating: Min school ratings. From 1 to 10.
451
+ :param include_unrated_schools: Include schools with no rating.
452
+ :param has_garage: Must have a garage. Default value false.
453
+ :param parking_spots: Parking Spots. Max value - 4.
454
+ :param is_foreclosed:
455
+ :param is_pre_foreclosure:
456
+ :param is_entire_place: Default - true. Apply when status_type = 'ForRent'. Set it to false if you need only a room.
457
+ :param is_room: Default - false. Apply when status_type = 'ForRent'. Set it true and isEntirePlace to false if you need only a room.
458
+ :param large_dogs_allowed: Allows large dogs. Only For Rent.
459
+ :param small_dogs_allowed: Allows small dogs. Only For Rent.
460
+ :param cats_allowed: Allows cats. Only For Rent.
461
+ :param no_pets: No pets. Only For Rent.
462
+ :param move_in_date: Move-in Date. Only For Rent.
463
+ :param parking_available: On-site Parking. Only For Rent.
464
+ :param in_unit_laundry: In-unit Laundry. Only For Rent.
465
+ :param accepts_applications: Accepts Zillow Applications. Only For Rent.
466
+ :param income_restricted: Income restricted. Only For Rent.
467
+ :param hardwood_floor: Hardwood Floors. Only For Rent.
468
+ :param disabled_access: Disabled Access. Only For Rent.
469
+ :param utilities_included: Utilities Included. Only For Rent.
470
+ :param short_term_lease: Short term lease available. Only For Rent.
471
+ :param furnished: Furnished. Only For Rent.
472
+ :param outdoor_space: Outdoor space. Only For Rent.
473
+ :param controlled_access: Controlled access. Only For Rent.
474
+ :param high_speed_internet: High speed internet. Only For Rent.
475
+ :param elevator: Elevator. Only For Rent.
476
+ :param multi_family_building: Apartment Community. Only For Rent.
141
477
  :param retries: Override the default retry configuration for this method
142
478
  :param server_url: Override the default server URL for this method
143
479
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -159,8 +495,75 @@ class Properties(BaseSDK):
159
495
  status_type=status_type,
160
496
  home_type=home_type,
161
497
  sort=sort,
498
+ polygon=polygon,
162
499
  min_price=min_price,
163
500
  max_price=max_price,
501
+ rent_min_price=rent_min_price,
502
+ rent_max_price=rent_max_price,
503
+ baths_min=baths_min,
504
+ baths_max=baths_max,
505
+ beds_min=beds_min,
506
+ beds_max=beds_max,
507
+ sqft_min=sqft_min,
508
+ sqft_max=sqft_max,
509
+ build_year_min=build_year_min,
510
+ build_year_max=build_year_max,
511
+ days_on=days_on,
512
+ sold_in_last=sold_in_last,
513
+ is_basement_finished=is_basement_finished,
514
+ is_basement_unfinished=is_basement_unfinished,
515
+ is_pending_under_contract=is_pending_under_contract,
516
+ is_accepting_backup_offers=is_accepting_backup_offers,
517
+ is_coming_soon=is_coming_soon,
518
+ other_listings=other_listings,
519
+ is_new_construction=is_new_construction,
520
+ keywords=keywords,
521
+ lot_size_min=lot_size_min,
522
+ lot_size_max=lot_size_max,
523
+ sale_by_agent=sale_by_agent,
524
+ sale_by_owner=sale_by_owner,
525
+ is_for_sale_foreclosure=is_for_sale_foreclosure,
526
+ is_waterfront=is_waterfront,
527
+ has_pool=has_pool,
528
+ has_air_conditioning=has_air_conditioning,
529
+ is_city_view=is_city_view,
530
+ is_mountain_view=is_mountain_view,
531
+ is_water_view=is_water_view,
532
+ is_park_view=is_park_view,
533
+ is_open_houses_only=is_open_houses_only,
534
+ is3d_home=is3d_home,
535
+ coordinates=coordinates,
536
+ hoa=hoa,
537
+ include_homes_with_no_hoa_data=include_homes_with_no_hoa_data,
538
+ is_auction=is_auction,
539
+ schools=schools,
540
+ schools_rating=schools_rating,
541
+ include_unrated_schools=include_unrated_schools,
542
+ has_garage=has_garage,
543
+ parking_spots=parking_spots,
544
+ is_foreclosed=is_foreclosed,
545
+ is_pre_foreclosure=is_pre_foreclosure,
546
+ is_entire_place=is_entire_place,
547
+ is_room=is_room,
548
+ large_dogs_allowed=large_dogs_allowed,
549
+ small_dogs_allowed=small_dogs_allowed,
550
+ cats_allowed=cats_allowed,
551
+ no_pets=no_pets,
552
+ move_in_date=move_in_date,
553
+ parking_available=parking_available,
554
+ in_unit_laundry=in_unit_laundry,
555
+ accepts_applications=accepts_applications,
556
+ income_restricted=income_restricted,
557
+ hardwood_floor=hardwood_floor,
558
+ disabled_access=disabled_access,
559
+ utilities_included=utilities_included,
560
+ short_term_lease=short_term_lease,
561
+ furnished=furnished,
562
+ outdoor_space=outdoor_space,
563
+ controlled_access=controlled_access,
564
+ high_speed_internet=high_speed_internet,
565
+ elevator=elevator,
566
+ multi_family_building=multi_family_building,
164
567
  )
165
568
 
166
569
  req = self._build_request_async(
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: zillow-rapidapi-client
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Python Client SDK Generated by Speakeasy.
5
5
  Author: Speakeasy
6
6
  Requires-Python: >=3.9
@@ -29,11 +29,6 @@ Developer-friendly & type-safe Python SDK specifically catered to leverage *zill
29
29
  </a>
30
30
  </div>
31
31
 
32
-
33
- <br /><br />
34
- > [!IMPORTANT]
35
- > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/adityaprakash-work/client-packages). Delete this section before > publishing to a package manager.
36
-
37
32
  <!-- Start Summary [summary] -->
38
33
  ## Summary
39
34
 
@@ -63,10 +58,6 @@ Zillow Property Extended Search API: API for searching properties using various
63
58
  <!-- Start SDK Installation [installation] -->
64
59
  ## SDK Installation
65
60
 
66
- > [!TIP]
67
- > To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
68
-
69
-
70
61
  > [!NOTE]
71
62
  > **Python version upgrade policy**
72
63
  >
@@ -79,7 +70,7 @@ The SDK can be installed with either *pip* or *poetry* package managers.
79
70
  *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
80
71
 
81
72
  ```bash
82
- pip install git+https://github.com/adityaprakash-work/zillow-rapidapi-client.git
73
+ pip install zillow-rapidapi-client
83
74
  ```
84
75
 
85
76
  ### Poetry
@@ -87,7 +78,7 @@ pip install git+https://github.com/adityaprakash-work/zillow-rapidapi-client.git
87
78
  *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
88
79
 
89
80
  ```bash
90
- poetry add git+https://github.com/adityaprakash-work/zillow-rapidapi-client.git
81
+ poetry add zillow-rapidapi-client
91
82
  ```
92
83
 
93
84
  ### Shell and script usage with `uv`
@@ -3,15 +3,15 @@ zillow_rapidapi_client/_hooks/__init__.py,sha256=9_7W5jAYw8rcO8Kfc-Ty-lB82BHfksA
3
3
  zillow_rapidapi_client/_hooks/registration.py,sha256=1QZB41w6If7I9dXiOSQx6dhSc6BPWrnI5Q5bMOr4iVA,624
4
4
  zillow_rapidapi_client/_hooks/sdkhooks.py,sha256=cPBP_m5wLepOkyBFAhCDJfapHqFnU7HTzRXA44OID20,2572
5
5
  zillow_rapidapi_client/_hooks/types.py,sha256=9ZlabHM4TJ_326am9Fpzq7PHZhN4n9f1YbZYqnHobkY,2825
6
- zillow_rapidapi_client/_version.py,sha256=jGtqqPX7QguAFYXhsnxAQt6qD7KtuD-9Urh44H8aSQY,486
6
+ zillow_rapidapi_client/_version.py,sha256=wqddKwAhqRSVUOBTtI8WWbg5kfxEDtxp-aLOrsKs2Wg,486
7
7
  zillow_rapidapi_client/basesdk.py,sha256=zWFzgOk1V0gPcpfRwmqvLwCmyOp7S-EO-F4NIVRKcd4,11982
8
8
  zillow_rapidapi_client/httpclient.py,sha256=N-D-srtDBykpfyVKacTY4upDGvNLqdWlEYqhJvta99E,4194
9
- zillow_rapidapi_client/models/__init__.py,sha256=tSr-Ms5NJiIQ9N_SDL1GI3kE4Wv_yVuZe2Ur85gIulo,884
9
+ zillow_rapidapi_client/models/__init__.py,sha256=-P3qzlpTTrVAJhqBovHMPQyMCwUHK5YIsWVhU1uEMZ0,1012
10
10
  zillow_rapidapi_client/models/apierror.py,sha256=9mTyJSyvUAOnSfW_1HWt9dGl8IDlpQ68DebwYsDNdug,528
11
11
  zillow_rapidapi_client/models/property.py,sha256=joe1dVimYCzU5r2MgwI-hpootvN6t4YzoQiRXxAS-Tk,4390
12
- zillow_rapidapi_client/models/propertyextendedsearchop.py,sha256=hKfjEzNlsrSwj9qfs0rFoLJ6fmWuIJkktt_zJYhfW_Q,3269
12
+ zillow_rapidapi_client/models/propertyextendedsearchop.py,sha256=SGUqUejQQ2i6zO36Z0QWayQ73XjKLZJApZXReTF3JCA,27089
13
13
  zillow_rapidapi_client/models/propertysearchresponse.py,sha256=b-jUJ0STUGajx4e6EM-8F4VRZV-k_4KQvaQy0NIABr4,1054
14
- zillow_rapidapi_client/properties.py,sha256=O9W7T45GaRfRhkigulX0z2LWslSgGrRODHOuVke2DM0,8891
14
+ zillow_rapidapi_client/properties.py,sha256=0S4SJJqnSNs2iZXcP37Zu9o7UfMzGULEYpdJhEBW8Kw,30599
15
15
  zillow_rapidapi_client/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
16
16
  zillow_rapidapi_client/sdk.py,sha256=dqRAk2DWMenTvqT5CpL-9BNTWAP5y4oUazf-VWu3U_s,4139
17
17
  zillow_rapidapi_client/sdkconfiguration.py,sha256=MRJK9grgdrsNxkr-UxYJgsgLg3JXkYFjC3L6xhuRLvI,1562
@@ -32,6 +32,6 @@ zillow_rapidapi_client/utils/security.py,sha256=ktep3HKwbFs-MLxUYTM8Jd4v-ZBum5_Z
32
32
  zillow_rapidapi_client/utils/serializers.py,sha256=BSJT7kBOkNBFyP7KREyMoe14JGbgijD1M6AXFMbdmco,4924
33
33
  zillow_rapidapi_client/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
34
34
  zillow_rapidapi_client/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
35
- zillow_rapidapi_client-0.1.3.dist-info/METADATA,sha256=cTuyrdXGseBq5_LUr5dG7CSYYTlywrAgr4CTHGVY4-I,16215
36
- zillow_rapidapi_client-0.1.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
37
- zillow_rapidapi_client-0.1.3.dist-info/RECORD,,
35
+ zillow_rapidapi_client-0.1.4.dist-info/METADATA,sha256=HWy-frcW6v9aTT_9rJA42wMK6kNuMb8B2PhLgFPV9fo,15685
36
+ zillow_rapidapi_client-0.1.4.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
37
+ zillow_rapidapi_client-0.1.4.dist-info/RECORD,,