@tapline/client 0.2.13 → 0.2.15

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.
Files changed (278) hide show
  1. package/README.md +12 -2
  2. package/dist/cjs/client.d.ts +8 -0
  3. package/dist/cjs/client.d.ts.map +1 -1
  4. package/dist/cjs/client.js +32 -20
  5. package/dist/cjs/client.js.map +1 -1
  6. package/dist/cjs/index.d.ts +8 -0
  7. package/dist/cjs/index.d.ts.map +1 -1
  8. package/dist/cjs/index.js +33 -21
  9. package/dist/cjs/index.js.map +1 -1
  10. package/dist/cjs/services/airbnb/client.d.ts +6 -6
  11. package/dist/cjs/services/airbnb/client.d.ts.map +1 -1
  12. package/dist/cjs/services/airbnb/client.js +6 -6
  13. package/dist/cjs/services/airbnb/client.js.map +1 -1
  14. package/dist/cjs/services/birdeye/client.d.ts +10 -10
  15. package/dist/cjs/services/birdeye/client.d.ts.map +1 -1
  16. package/dist/cjs/services/birdeye/client.js +10 -10
  17. package/dist/cjs/services/birdeye/client.js.map +1 -1
  18. package/dist/cjs/services/brave_search/client.d.ts +1 -1
  19. package/dist/cjs/services/brave_search/client.d.ts.map +1 -1
  20. package/dist/cjs/services/brave_search/client.js +1 -1
  21. package/dist/cjs/services/brave_search/client.js.map +1 -1
  22. package/dist/cjs/services/brave_search/types.d.ts +1211 -1273
  23. package/dist/cjs/services/brave_search/types.d.ts.map +1 -1
  24. package/dist/cjs/services/facebook/client.d.ts +65 -0
  25. package/dist/cjs/services/facebook/client.d.ts.map +1 -0
  26. package/dist/cjs/services/facebook/client.js +151 -0
  27. package/dist/cjs/services/facebook/client.js.map +1 -0
  28. package/dist/cjs/services/facebook/index.d.ts +3 -0
  29. package/dist/cjs/services/facebook/index.d.ts.map +1 -0
  30. package/dist/cjs/services/facebook/index.js +22 -0
  31. package/dist/cjs/services/facebook/index.js.map +1 -0
  32. package/dist/cjs/services/facebook/types.d.ts +1021 -0
  33. package/dist/cjs/services/facebook/types.d.ts.map +1 -0
  34. package/dist/cjs/services/facebook/types.js +4 -0
  35. package/dist/cjs/services/facebook/types.js.map +1 -0
  36. package/dist/cjs/services/facebook_ad_library/client.d.ts +25 -0
  37. package/dist/cjs/services/facebook_ad_library/client.d.ts.map +1 -0
  38. package/dist/cjs/services/facebook_ad_library/client.js +53 -0
  39. package/dist/cjs/services/facebook_ad_library/client.js.map +1 -0
  40. package/dist/cjs/services/facebook_ad_library/index.d.ts +3 -0
  41. package/dist/cjs/services/facebook_ad_library/index.d.ts.map +1 -0
  42. package/dist/cjs/services/facebook_ad_library/index.js +22 -0
  43. package/dist/cjs/services/facebook_ad_library/index.js.map +1 -0
  44. package/dist/cjs/services/facebook_ad_library/types.d.ts +606 -0
  45. package/dist/cjs/services/facebook_ad_library/types.d.ts.map +1 -0
  46. package/dist/cjs/services/facebook_ad_library/types.js +4 -0
  47. package/dist/cjs/services/facebook_ad_library/types.js.map +1 -0
  48. package/dist/cjs/services/facebook_marketplace/client.d.ts +23 -0
  49. package/dist/cjs/services/facebook_marketplace/client.d.ts.map +1 -0
  50. package/dist/cjs/services/facebook_marketplace/client.js +47 -0
  51. package/dist/cjs/services/facebook_marketplace/client.js.map +1 -0
  52. package/dist/cjs/services/facebook_marketplace/index.d.ts +3 -0
  53. package/dist/cjs/services/facebook_marketplace/index.d.ts.map +1 -0
  54. package/dist/cjs/services/facebook_marketplace/index.js +22 -0
  55. package/dist/cjs/services/facebook_marketplace/index.js.map +1 -0
  56. package/dist/cjs/services/facebook_marketplace/types.d.ts +400 -0
  57. package/dist/cjs/services/facebook_marketplace/types.d.ts.map +1 -0
  58. package/dist/cjs/services/facebook_marketplace/types.js +4 -0
  59. package/dist/cjs/services/facebook_marketplace/types.js.map +1 -0
  60. package/dist/cjs/services/geckoterminal/client.d.ts +2 -2
  61. package/dist/cjs/services/geckoterminal/client.d.ts.map +1 -1
  62. package/dist/cjs/services/geckoterminal/client.js +2 -2
  63. package/dist/cjs/services/geckoterminal/client.js.map +1 -1
  64. package/dist/cjs/services/geckoterminal/types.d.ts +15 -4
  65. package/dist/cjs/services/geckoterminal/types.d.ts.map +1 -1
  66. package/dist/cjs/services/gmgn/client.d.ts +18 -18
  67. package/dist/cjs/services/gmgn/client.d.ts.map +1 -1
  68. package/dist/cjs/services/gmgn/client.js +18 -18
  69. package/dist/cjs/services/gmgn/client.js.map +1 -1
  70. package/dist/cjs/services/gmgn/types.d.ts +2 -2
  71. package/dist/cjs/services/gmgn/types.d.ts.map +1 -1
  72. package/dist/cjs/services/goplus/client.d.ts +3 -3
  73. package/dist/cjs/services/goplus/client.d.ts.map +1 -1
  74. package/dist/cjs/services/goplus/client.js +3 -3
  75. package/dist/cjs/services/goplus/client.js.map +1 -1
  76. package/dist/cjs/services/imovelweb/client.d.ts +6 -6
  77. package/dist/cjs/services/imovelweb/client.d.ts.map +1 -1
  78. package/dist/cjs/services/imovelweb/client.js +6 -6
  79. package/dist/cjs/services/imovelweb/client.js.map +1 -1
  80. package/dist/cjs/services/indeed/types.d.ts +233 -187
  81. package/dist/cjs/services/indeed/types.d.ts.map +1 -1
  82. package/dist/cjs/services/instagram/client.d.ts +12 -12
  83. package/dist/cjs/services/instagram/client.d.ts.map +1 -1
  84. package/dist/cjs/services/instagram/client.js +12 -12
  85. package/dist/cjs/services/instagram/client.js.map +1 -1
  86. package/dist/cjs/services/instagram/types.d.ts +399 -2284
  87. package/dist/cjs/services/instagram/types.d.ts.map +1 -1
  88. package/dist/cjs/services/linkedin/client.d.ts +7 -7
  89. package/dist/cjs/services/linkedin/client.d.ts.map +1 -1
  90. package/dist/cjs/services/linkedin/client.js +7 -7
  91. package/dist/cjs/services/linkedin/client.js.map +1 -1
  92. package/dist/cjs/services/pinterest/client.d.ts +4 -4
  93. package/dist/cjs/services/pinterest/client.d.ts.map +1 -1
  94. package/dist/cjs/services/pinterest/client.js +4 -4
  95. package/dist/cjs/services/pinterest/client.js.map +1 -1
  96. package/dist/cjs/services/pinterest/types.d.ts +740 -711
  97. package/dist/cjs/services/pinterest/types.d.ts.map +1 -1
  98. package/dist/cjs/services/pinterest_v2/client.d.ts +15 -0
  99. package/dist/cjs/services/pinterest_v2/client.d.ts.map +1 -0
  100. package/dist/cjs/services/pinterest_v2/client.js +28 -0
  101. package/dist/cjs/services/pinterest_v2/client.js.map +1 -0
  102. package/dist/cjs/services/pinterest_v2/index.d.ts +3 -0
  103. package/dist/cjs/services/pinterest_v2/index.d.ts.map +1 -0
  104. package/dist/cjs/services/pinterest_v2/index.js +22 -0
  105. package/dist/cjs/services/pinterest_v2/index.js.map +1 -0
  106. package/dist/cjs/services/pinterest_v2/types.d.ts +558 -0
  107. package/dist/cjs/services/pinterest_v2/types.d.ts.map +1 -0
  108. package/dist/cjs/services/pinterest_v2/types.js +4 -0
  109. package/dist/cjs/services/pinterest_v2/types.js.map +1 -0
  110. package/dist/cjs/services/ponsfamily/client.d.ts +8 -8
  111. package/dist/cjs/services/ponsfamily/client.d.ts.map +1 -1
  112. package/dist/cjs/services/ponsfamily/client.js +8 -8
  113. package/dist/cjs/services/ponsfamily/client.js.map +1 -1
  114. package/dist/cjs/services/ponsfamily/types.d.ts +83 -14
  115. package/dist/cjs/services/ponsfamily/types.d.ts.map +1 -1
  116. package/dist/cjs/services/pumpfun/client.d.ts +56 -56
  117. package/dist/cjs/services/pumpfun/client.d.ts.map +1 -1
  118. package/dist/cjs/services/pumpfun/client.js +56 -56
  119. package/dist/cjs/services/pumpfun/client.js.map +1 -1
  120. package/dist/cjs/services/pumpfun/types.d.ts +280 -101
  121. package/dist/cjs/services/pumpfun/types.d.ts.map +1 -1
  122. package/dist/cjs/services/twitter/client.d.ts +5 -5
  123. package/dist/cjs/services/twitter/client.d.ts.map +1 -1
  124. package/dist/cjs/services/twitter/client.js +5 -5
  125. package/dist/cjs/services/twitter/client.js.map +1 -1
  126. package/dist/cjs/services/twitter/types.d.ts +294 -403
  127. package/dist/cjs/services/twitter/types.d.ts.map +1 -1
  128. package/dist/cjs/services/youtube/client.d.ts +11 -11
  129. package/dist/cjs/services/youtube/client.d.ts.map +1 -1
  130. package/dist/cjs/services/youtube/client.js +11 -11
  131. package/dist/cjs/services/youtube/client.js.map +1 -1
  132. package/dist/cjs/services/youtube/types.d.ts +164 -158
  133. package/dist/cjs/services/youtube/types.d.ts.map +1 -1
  134. package/dist/cjs/services/zillow/client.d.ts +8 -6
  135. package/dist/cjs/services/zillow/client.d.ts.map +1 -1
  136. package/dist/cjs/services/zillow/client.js +10 -5
  137. package/dist/cjs/services/zillow/client.js.map +1 -1
  138. package/dist/cjs/services/zillow/types.d.ts +720 -886
  139. package/dist/cjs/services/zillow/types.d.ts.map +1 -1
  140. package/dist/client.d.ts +8 -0
  141. package/dist/client.d.ts.map +1 -1
  142. package/dist/client.js +12 -0
  143. package/dist/client.js.map +1 -1
  144. package/dist/index.d.ts +8 -0
  145. package/dist/index.d.ts.map +1 -1
  146. package/dist/index.js +8 -0
  147. package/dist/index.js.map +1 -1
  148. package/dist/services/airbnb/client.d.ts +6 -6
  149. package/dist/services/airbnb/client.d.ts.map +1 -1
  150. package/dist/services/airbnb/client.js +6 -6
  151. package/dist/services/airbnb/client.js.map +1 -1
  152. package/dist/services/birdeye/client.d.ts +10 -10
  153. package/dist/services/birdeye/client.d.ts.map +1 -1
  154. package/dist/services/birdeye/client.js +10 -10
  155. package/dist/services/birdeye/client.js.map +1 -1
  156. package/dist/services/brave_search/client.d.ts +1 -1
  157. package/dist/services/brave_search/client.d.ts.map +1 -1
  158. package/dist/services/brave_search/client.js +1 -1
  159. package/dist/services/brave_search/client.js.map +1 -1
  160. package/dist/services/brave_search/types.d.ts +1211 -1273
  161. package/dist/services/brave_search/types.d.ts.map +1 -1
  162. package/dist/services/facebook/client.d.ts +65 -0
  163. package/dist/services/facebook/client.d.ts.map +1 -0
  164. package/dist/services/facebook/client.js +147 -0
  165. package/dist/services/facebook/client.js.map +1 -0
  166. package/dist/services/facebook/index.d.ts +3 -0
  167. package/dist/services/facebook/index.d.ts.map +1 -0
  168. package/dist/services/facebook/index.js +4 -0
  169. package/dist/services/facebook/index.js.map +1 -0
  170. package/dist/services/facebook/types.d.ts +1021 -0
  171. package/dist/services/facebook/types.d.ts.map +1 -0
  172. package/dist/services/facebook/types.js +3 -0
  173. package/dist/services/facebook/types.js.map +1 -0
  174. package/dist/services/facebook_ad_library/client.d.ts +25 -0
  175. package/dist/services/facebook_ad_library/client.d.ts.map +1 -0
  176. package/dist/services/facebook_ad_library/client.js +49 -0
  177. package/dist/services/facebook_ad_library/client.js.map +1 -0
  178. package/dist/services/facebook_ad_library/index.d.ts +3 -0
  179. package/dist/services/facebook_ad_library/index.d.ts.map +1 -0
  180. package/dist/services/facebook_ad_library/index.js +4 -0
  181. package/dist/services/facebook_ad_library/index.js.map +1 -0
  182. package/dist/services/facebook_ad_library/types.d.ts +606 -0
  183. package/dist/services/facebook_ad_library/types.d.ts.map +1 -0
  184. package/dist/services/facebook_ad_library/types.js +3 -0
  185. package/dist/services/facebook_ad_library/types.js.map +1 -0
  186. package/dist/services/facebook_marketplace/client.d.ts +23 -0
  187. package/dist/services/facebook_marketplace/client.d.ts.map +1 -0
  188. package/dist/services/facebook_marketplace/client.js +43 -0
  189. package/dist/services/facebook_marketplace/client.js.map +1 -0
  190. package/dist/services/facebook_marketplace/index.d.ts +3 -0
  191. package/dist/services/facebook_marketplace/index.d.ts.map +1 -0
  192. package/dist/services/facebook_marketplace/index.js +4 -0
  193. package/dist/services/facebook_marketplace/index.js.map +1 -0
  194. package/dist/services/facebook_marketplace/types.d.ts +400 -0
  195. package/dist/services/facebook_marketplace/types.d.ts.map +1 -0
  196. package/dist/services/facebook_marketplace/types.js +3 -0
  197. package/dist/services/facebook_marketplace/types.js.map +1 -0
  198. package/dist/services/geckoterminal/client.d.ts +2 -2
  199. package/dist/services/geckoterminal/client.d.ts.map +1 -1
  200. package/dist/services/geckoterminal/client.js +2 -2
  201. package/dist/services/geckoterminal/client.js.map +1 -1
  202. package/dist/services/geckoterminal/types.d.ts +15 -4
  203. package/dist/services/geckoterminal/types.d.ts.map +1 -1
  204. package/dist/services/gmgn/client.d.ts +18 -18
  205. package/dist/services/gmgn/client.d.ts.map +1 -1
  206. package/dist/services/gmgn/client.js +18 -18
  207. package/dist/services/gmgn/client.js.map +1 -1
  208. package/dist/services/gmgn/types.d.ts +2 -2
  209. package/dist/services/gmgn/types.d.ts.map +1 -1
  210. package/dist/services/goplus/client.d.ts +3 -3
  211. package/dist/services/goplus/client.d.ts.map +1 -1
  212. package/dist/services/goplus/client.js +3 -3
  213. package/dist/services/goplus/client.js.map +1 -1
  214. package/dist/services/imovelweb/client.d.ts +6 -6
  215. package/dist/services/imovelweb/client.d.ts.map +1 -1
  216. package/dist/services/imovelweb/client.js +6 -6
  217. package/dist/services/imovelweb/client.js.map +1 -1
  218. package/dist/services/indeed/types.d.ts +233 -187
  219. package/dist/services/indeed/types.d.ts.map +1 -1
  220. package/dist/services/instagram/client.d.ts +12 -12
  221. package/dist/services/instagram/client.d.ts.map +1 -1
  222. package/dist/services/instagram/client.js +12 -12
  223. package/dist/services/instagram/client.js.map +1 -1
  224. package/dist/services/instagram/types.d.ts +399 -2284
  225. package/dist/services/instagram/types.d.ts.map +1 -1
  226. package/dist/services/linkedin/client.d.ts +7 -7
  227. package/dist/services/linkedin/client.d.ts.map +1 -1
  228. package/dist/services/linkedin/client.js +7 -7
  229. package/dist/services/linkedin/client.js.map +1 -1
  230. package/dist/services/pinterest/client.d.ts +4 -4
  231. package/dist/services/pinterest/client.d.ts.map +1 -1
  232. package/dist/services/pinterest/client.js +4 -4
  233. package/dist/services/pinterest/client.js.map +1 -1
  234. package/dist/services/pinterest/types.d.ts +740 -711
  235. package/dist/services/pinterest/types.d.ts.map +1 -1
  236. package/dist/services/pinterest_v2/client.d.ts +15 -0
  237. package/dist/services/pinterest_v2/client.d.ts.map +1 -0
  238. package/dist/services/pinterest_v2/client.js +24 -0
  239. package/dist/services/pinterest_v2/client.js.map +1 -0
  240. package/dist/services/pinterest_v2/index.d.ts +3 -0
  241. package/dist/services/pinterest_v2/index.d.ts.map +1 -0
  242. package/dist/services/pinterest_v2/index.js +4 -0
  243. package/dist/services/pinterest_v2/index.js.map +1 -0
  244. package/dist/services/pinterest_v2/types.d.ts +558 -0
  245. package/dist/services/pinterest_v2/types.d.ts.map +1 -0
  246. package/dist/services/pinterest_v2/types.js +3 -0
  247. package/dist/services/pinterest_v2/types.js.map +1 -0
  248. package/dist/services/ponsfamily/client.d.ts +8 -8
  249. package/dist/services/ponsfamily/client.d.ts.map +1 -1
  250. package/dist/services/ponsfamily/client.js +8 -8
  251. package/dist/services/ponsfamily/client.js.map +1 -1
  252. package/dist/services/ponsfamily/types.d.ts +83 -14
  253. package/dist/services/ponsfamily/types.d.ts.map +1 -1
  254. package/dist/services/pumpfun/client.d.ts +56 -56
  255. package/dist/services/pumpfun/client.d.ts.map +1 -1
  256. package/dist/services/pumpfun/client.js +56 -56
  257. package/dist/services/pumpfun/client.js.map +1 -1
  258. package/dist/services/pumpfun/types.d.ts +280 -101
  259. package/dist/services/pumpfun/types.d.ts.map +1 -1
  260. package/dist/services/twitter/client.d.ts +5 -5
  261. package/dist/services/twitter/client.d.ts.map +1 -1
  262. package/dist/services/twitter/client.js +5 -5
  263. package/dist/services/twitter/client.js.map +1 -1
  264. package/dist/services/twitter/types.d.ts +294 -403
  265. package/dist/services/twitter/types.d.ts.map +1 -1
  266. package/dist/services/youtube/client.d.ts +11 -11
  267. package/dist/services/youtube/client.d.ts.map +1 -1
  268. package/dist/services/youtube/client.js +11 -11
  269. package/dist/services/youtube/client.js.map +1 -1
  270. package/dist/services/youtube/types.d.ts +164 -158
  271. package/dist/services/youtube/types.d.ts.map +1 -1
  272. package/dist/services/zillow/client.d.ts +8 -6
  273. package/dist/services/zillow/client.d.ts.map +1 -1
  274. package/dist/services/zillow/client.js +10 -5
  275. package/dist/services/zillow/client.js.map +1 -1
  276. package/dist/services/zillow/types.d.ts +720 -886
  277. package/dist/services/zillow/types.d.ts.map +1 -1
  278. package/package.json +6 -2
@@ -1,27 +1,31 @@
1
1
  export interface ErrorDetail {
2
- ctx?: Record<string, unknown> | null;
3
- input?: unknown | null;
2
+ type?: string | null;
4
3
  loc?: (string | number)[] | null;
5
4
  msg?: string | null;
6
- type?: string | null;
5
+ input?: unknown | null;
6
+ ctx?: Record<string, unknown> | null;
7
7
  }
8
8
  export interface ErrorResponse {
9
9
  code: PublicError;
10
- details?: ErrorDetail[] | null;
11
- domain?: string | null;
12
10
  message: string;
13
11
  request_id: string;
12
+ domain?: string | null;
13
+ details?: ErrorDetail[] | null;
14
14
  upgrade_url?: string | null;
15
15
  }
16
16
  export interface GetPropertyHistoryParams {
17
+ /** Zillow property id: the digits before `_zpid` in a home's Zillow URL, or the `zpid` of a property, comparable or address suggestion. Search listings carry it as a string. */
18
+ zpid: number;
17
19
  /** Which series: `zestimate` (monthly Zestimate), `rent_zestimate` (monthly Rent Zestimate), `zestimate_change` (monthly year-over-year change as a fraction), `tax_paid` (yearly property tax) or `tax_assessment` (yearly assessed value, as `Land` and `Structure` series). */
18
20
  metric?: ZillowHistoryMetric;
19
21
  /** How far back the series goes. */
20
22
  period?: ZillowHistoryPeriod;
23
+ }
24
+ export interface GetPropertyParams {
21
25
  /** Zillow property id: the digits before `_zpid` in a home's Zillow URL, or the `zpid` of a property, comparable or address suggestion. Search listings carry it as a string. */
22
26
  zpid: number;
23
27
  }
24
- export interface GetPropertyParams {
28
+ export interface GetPropertyRecordsParams {
25
29
  /** Zillow property id: the digits before `_zpid` in a home's Zillow URL, or the `zpid` of a property, comparable or address suggestion. Search listings carry it as a string. */
26
30
  zpid: number;
27
31
  }
@@ -33,163 +37,87 @@ export type PublicError = "blocked" | "concurrency_exceeded" | "timeout" | "extr
33
37
  export interface SearchHomesParams {
34
38
  /** `pagination.next_cursor` from the previous page; empty for the first page. A cursor holds only a page number, so send it with the same location and filters. `pagination.completion` is `exhausted` at the last page and `depth_limit` at page 20, the deepest Zillow serves; narrow the filters to reach more homes. */
35
39
  cursor?: string;
36
- /** Listed within this many days (`1` to `90`) or months (`6m` to `36m`); with `status=sold`, sold within it. */
37
- days_on_zillow?: ZillowDaysOnZillow | null;
38
- /** Keep only these home types; repeat the parameter for several (`home_types=house&home_types=condo`). All types when omitted. Rentals take `house`, `townhouse`, `condo` and `apartment`, where `condo` and `apartment` both select Zillow's combined apartments-and-condos filter; `apartment` is for rentals only. */
39
- home_types?: ZillowHomeType[] | null;
40
- /** Words the listing must mention, such as `pool` or `waterfront`. */
41
- keywords?: string | null;
42
40
  /** Where to search, as you would type it into Zillow: a state, county, city, ZIP code, neighborhood or borough (`Austin, TX`, `94110`, `Brooklyn`). Zillow's first matching region is used and the response's `region` says which; a custom area such as `Bay Area` answers 404. Send this, or `region_id` with `region_type`. */
43
41
  location?: string | null;
44
- /** Most bedrooms. */
45
- max_beds?: number | null;
46
- /** Highest monthly HOA fee in USD. Homes for sale or sold only. */
47
- max_hoa?: number | null;
48
- /** Largest lot in square feet. */
49
- max_lot_sqft?: number | null;
42
+ /** Zillow region id, the `metaData.regionId` of a `/v1/zillow/locations` region suggestion. Send with `region_type`, instead of `location`, to search exactly that region. */
43
+ region_id?: number | null;
44
+ /** The region suggestion's `metaData.regionType`; required with `region_id`. */
45
+ region_type?: ZillowRegionType | null;
46
+ /** `for_sale`, `for_rent`, or `sold` (Zillow's recently sold homes). */
47
+ status?: ZillowListingStatus;
48
+ /** Order of results. `relevance` is Zillow's default; on `sold` it already lists the newest sales first, like `newest`. `beds`, `baths`, `sqft` and `lot_size` sort from largest; with `for_rent`, the price sorts order by monthly rent. */
49
+ sort?: ZillowSearchSort;
50
+ /** Lowest price in USD; monthly rent with `status=for_rent`. */
51
+ min_price?: number | null;
50
52
  /** Highest price in USD; monthly rent with `status=for_rent`. */
51
53
  max_price?: number | null;
52
- /** Largest living area in square feet. */
53
- max_sqft?: number | null;
54
- /** Built in or before this year. */
55
- max_year_built?: number | null;
56
- /** Fewest bathrooms. Zillow counts every bathroom, half baths included, as one. */
57
- min_baths?: number | null;
58
54
  /** Fewest bedrooms. */
59
55
  min_beds?: number | null;
60
- /** Smallest lot in square feet. */
61
- min_lot_sqft?: number | null;
62
- /** Lowest price in USD; monthly rent with `status=for_rent`. */
63
- min_price?: number | null;
56
+ /** Most bedrooms. */
57
+ max_beds?: number | null;
58
+ /** Fewest bathrooms. Zillow counts every bathroom, half baths included, as one. */
59
+ min_baths?: number | null;
64
60
  /** Smallest living area in square feet. */
65
61
  min_sqft?: number | null;
62
+ /** Largest living area in square feet. */
63
+ max_sqft?: number | null;
64
+ /** Smallest lot in square feet. */
65
+ min_lot_sqft?: number | null;
66
+ /** Largest lot in square feet. */
67
+ max_lot_sqft?: number | null;
66
68
  /** Built in or after this year. */
67
69
  min_year_built?: number | null;
68
- /** Zillow region id, the `metaData.regionId` of a `/v1/zillow/locations` region suggestion. Send with `region_type`, instead of `location`, to search exactly that region. */
69
- region_id?: number | null;
70
- /** The region suggestion's `metaData.regionType`; required with `region_id`. */
71
- region_type?: ZillowRegionType | null;
72
- /** Order of results. `relevance` is Zillow's default; on `sold` it already lists the newest sales first, like `newest`. `beds`, `baths`, `sqft` and `lot_size` sort from largest; with `for_rent`, the price sorts order by monthly rent. */
73
- sort?: ZillowSearchSort;
74
- /** `for_sale`, `for_rent`, or `sold` (Zillow's recently sold homes). */
75
- status?: ZillowListingStatus;
70
+ /** Built in or before this year. */
71
+ max_year_built?: number | null;
72
+ /** Highest monthly HOA fee in USD. Homes for sale or sold only. */
73
+ max_hoa?: number | null;
74
+ /** Listed within this many days (`1` to `90`) or months (`6m` to `36m`); with `status=sold`, sold within it. */
75
+ days_on_zillow?: ZillowDaysOnZillow | null;
76
+ /** Keep only these home types; repeat the parameter for several (`home_types=house&home_types=condo`). All types when omitted. Rentals take `house`, `townhouse`, `condo` and `apartment`, where `condo` and `apartment` both select Zillow's combined apartments-and-condos filter; `apartment` is for rentals only. */
77
+ home_types?: ZillowHomeType[] | null;
78
+ /** Words the listing must mention, such as `pool` or `waterfront`. */
79
+ keywords?: string | null;
76
80
  }
77
81
  export interface SearchLocationsParams {
78
- /** Most suggestions to return; Zillow serves 12 at most. */
79
- limit?: number;
80
82
  /** Text to complete: part of an address, a city, ZIP code or neighborhood. */
81
83
  query: string;
82
84
  /** `region` for places (states, counties, cities, ZIP codes, neighborhoods, boroughs and Zillow's custom areas, `regionType` `flex_region`, which search does not take), `address` for homes, `all` for both. */
83
85
  type?: ZillowLocationType;
86
+ /** Most suggestions to return; Zillow serves 12 at most. */
87
+ limit?: number;
84
88
  }
85
- export interface ZillowAutocompleteMetadata {
86
- addressType?: string;
87
- city?: string;
88
- country: string;
89
- county?: string;
90
- countyFIPS?: string;
91
- lat: number;
92
- lng: number;
93
- maloneId?: number;
94
- regionId?: number;
95
- regionType?: string;
96
- state: string;
97
- streetName?: string;
98
- streetNumber?: string;
99
- unitNumber?: string;
100
- zipCode?: string;
101
- zpid?: number;
102
- }
103
- export interface ZillowAutocompleteResult {
104
- display: string;
105
- metaData: ZillowAutocompleteMetadata;
106
- resultType: string;
107
- }
108
- export interface ZillowComparable {
109
- address: ZillowComparableAddress;
110
- attributionInfo: ZillowComparableAttributionInfo;
111
- bathrooms: number | null;
112
- bedrooms: number | null;
113
- currency: string;
114
- formattedChip: ZillowComparableFormattedChip;
115
- hdpTypeDimension: string;
116
- hdpUrl: string;
117
- homeStatus: string;
118
- homeType: string;
119
- isPremierBuilder: boolean;
120
- isSavedByCurrentSignedInUser?: boolean;
121
- isShowcaseListing: boolean | null;
122
- latitude: number;
123
- listingMetadata: ZillowComparableListingMetadata;
124
- listingTypeDimension: string;
125
- listing_sub_type: ZillowComparableListingSubType;
126
- livingArea: number | null;
127
- livingAreaUnits: string | null;
128
- livingAreaUnitsShort: string | null;
129
- livingAreaValue: number | null;
130
- longitude: number;
131
- lotAreaUnits: string;
132
- lotAreaValue: number | null;
133
- lotSize: number | null;
134
- marketingTreatments?: string[] | null;
135
- miniCardPhotos: ZillowComparablePhoto[];
136
- newConstructionType: string | null;
137
- parentRegion: ZillowComparableParentRegion | null;
138
- price: number | null;
139
- propertyTypeDimension: string;
140
- providerListingID: string | null;
141
- state: string;
142
- zpid: number;
143
- }
144
- export interface ZillowComparableAddress {
145
- city: string;
146
- state: string;
147
- streetAddress: string;
148
- zipcode: string;
149
- }
150
- export interface ZillowComparableAttributionInfo {
151
- agentName: string | null;
152
- agentPhoneNumber: string | null;
153
- brokerName: string | null;
154
- brokerPhoneNumber: string | null;
155
- mlsId: string | null;
156
- mlsName: string | null;
157
- notMLSSourcedListing?: boolean;
158
- providerLogo: string | null;
159
- trueStatus: string | null;
160
- }
161
- export interface ZillowComparableChipLocation {
162
- fullValue: string | null;
163
- }
164
- export interface ZillowComparableFormattedChip {
165
- location: ZillowComparableChipLocation[];
166
- }
167
- export interface ZillowComparableListingMetadata {
168
- comminglingCategoryIsRulesApplicable: boolean;
169
- }
170
- export interface ZillowComparableListingSubType {
171
- is_FSBA: boolean;
172
- is_FSBO: boolean;
173
- is_bankOwned: boolean;
174
- is_comingSoon: boolean;
175
- is_forAuction: boolean;
176
- is_foreclosure: boolean;
177
- is_newHome: boolean;
178
- }
179
- export interface ZillowComparableParentRegion {
180
- name: string;
181
- }
182
- export interface ZillowComparablePhoto {
89
+ export interface ZillowAffordabilityEstimateV2 {
90
+ totalMonthlyCost: number | null;
91
+ usedInputs: ZillowAffordabilityInputs;
92
+ }
93
+ export interface ZillowAffordabilityInputs {
94
+ fromFinancialProfile?: boolean;
95
+ downPaymentAmount?: number;
96
+ downPaymentPercent?: number;
97
+ isDownpaymentPreferencePercent?: boolean;
98
+ creditScoreRange?: string;
99
+ rateSource?: string | null;
100
+ }
101
+ export interface ZillowAgentPhone {
102
+ area_code: string;
103
+ prefix: string;
104
+ number: string;
105
+ }
106
+ export interface ZillowAgentPhoto {
183
107
  url: string;
108
+ width: number;
109
+ height: number;
184
110
  }
185
111
  export interface ZillowComparables {
186
- items: ZillowComparable[];
187
- zpid: number;
112
+ zpid: string;
113
+ items: ZillowPropertySummary[];
188
114
  }
189
115
  export type ZillowCursorCompletion = "exhausted" | "depth_limit";
190
116
  export interface ZillowCursorPagination {
191
- completion: ZillowCursorCompletion | null;
117
+ page: number;
118
+ per_page: number;
192
119
  next_cursor: string | null;
120
+ completion: ZillowCursorCompletion | null;
193
121
  }
194
122
  export type ZillowDaysOnZillow = "1" | "7" | "14" | "30" | "90" | "6m" | "12m" | "24m" | "36m";
195
123
  export type ZillowHistoryMetric = "zestimate" | "rent_zestimate" | "zestimate_change" | "tax_paid" | "tax_assessment";
@@ -203,431 +131,385 @@ export interface ZillowHomeValueChartSeries {
203
131
  name: string;
204
132
  points: ZillowHomeValueChartPoint[];
205
133
  }
206
- export interface ZillowLatLong {
207
- latitude?: number;
208
- longitude?: number;
134
+ export interface ZillowListedBy {
135
+ role: string;
136
+ values: ZillowListedByValue[];
209
137
  }
210
- export interface ZillowListing {
211
- address: string;
212
- addressCity: string;
213
- addressState: string;
214
- addressStreet: string;
215
- addressZipcode: string;
216
- area?: number;
217
- availabilityCount?: number;
218
- availabilityDate?: string;
219
- baths?: number;
220
- beds?: number;
221
- brokerName?: string;
222
- builderName?: string;
223
- buildingName?: string;
224
- canSaveBuilding?: boolean;
225
- carouselPhotosComposable?: ZillowListingCarouselPhotos;
226
- contentType?: string;
227
- countryCurrency?: string;
228
- detailUrl: string;
229
- factsAndFeatures?: ZillowListingFactsAndFeatures;
230
- flexFieldText?: string;
231
- has3DModel: boolean;
232
- hasAdditionalAttributions?: boolean;
233
- hasImage?: boolean;
234
- hasOpenHouse?: boolean;
235
- hasVideo?: boolean;
236
- hdpData?: ZillowListingHdpData;
237
- id: string;
238
- imgSrc: string;
239
- info2String?: string;
240
- info3String?: string;
241
- info6String?: string;
242
- isBuilding?: boolean;
243
- isContactable?: boolean;
244
- isFeaturedListing: boolean;
245
- isHomeRec?: boolean;
246
- isInstantTourEnabled?: boolean;
247
- isPaidBuilderNewConstruction: boolean;
248
- isPropertyResultCDP?: boolean;
249
- isShowcaseListing: boolean;
250
- isUndisclosedAddress?: boolean;
251
- isUserClaimingOwner?: boolean;
252
- isUserConfirmedClaim?: boolean;
253
- isZillowOwned?: boolean;
254
- latLong: ZillowLatLong;
255
- list: boolean;
256
- listCardRecommendation?: ZillowListingCardRecommendation;
257
- listPriceIncludesRequiredMonthlyFees?: boolean;
258
- lotAreaString?: string;
259
- lotId?: number;
260
- marketingStatusSimplifiedCd?: string;
261
- marketingTreatments?: string[];
262
- maxBaseRent?: number;
263
- minBaseRent?: number;
264
- openHouseDescription?: string;
265
- openHouseEndDate?: string;
266
- openHouseStartDate?: string;
267
- palsId?: string;
268
- pgapt?: string;
269
- price?: string;
270
- providerListingId?: string;
271
- rawHomeStatusCd?: string;
272
- relaxed: boolean;
273
- rooms?: unknown[];
274
- sgapt?: string;
275
- shouldShowRequestOnPrice: boolean;
276
- shouldShowZestimateAsPrice?: boolean;
277
- soldPrice?: string;
278
- statusText: string;
279
- statusType: string;
280
- streetViewMetadataURL?: string;
281
- streetViewURL?: string;
282
- totalRequiredMonthlyMaxFee?: number;
283
- totalRequiredMonthlyMinFee?: number;
284
- unformattedPrice?: number;
285
- units?: ZillowListingUnit[];
286
- zestimate?: number;
287
- zpid: string;
288
- }
289
- export interface ZillowListingCardRecommendation {
290
- ctaRecommendations?: ZillowListingRecommendation[];
291
- flexFieldRecommendations: ZillowListingRecommendation[];
292
- zovInsight?: ZillowListingZovInsight;
138
+ export interface ZillowListedByValue {
139
+ type: string;
140
+ value: string;
293
141
  }
294
- export interface ZillowListingCarouselPhotos {
295
- baseUrl: string | null;
296
- communityBaseUrl: string | null;
297
- communityPhotoData: ZillowListingPhotoKey[] | null;
298
- isStaticUrls: boolean;
299
- photoData: ZillowListingPhotoKey[] | null;
142
+ export interface ZillowListingAgent {
143
+ id?: string;
144
+ display_name?: string;
145
+ profile_url?: string;
146
+ reviews_url?: string;
147
+ rating_average?: number;
148
+ review_count?: number;
149
+ first_name?: string;
150
+ business_name?: string;
151
+ badge_type?: string;
152
+ phone?: ZillowAgentPhone;
153
+ recent_sales?: number;
154
+ services_offered?: number[];
155
+ is_zillow_pro?: boolean;
156
+ photo?: ZillowAgentPhoto;
157
+ }
158
+ export interface ZillowListingAgentAttribution {
159
+ memberFullName: string | null;
160
+ memberStateLicense: string | null;
161
+ associatedAgentType: string;
300
162
  }
301
163
  export interface ZillowListingFactsAndFeatures {
302
164
  fullBathroomCount: number;
303
165
  halfBathroomCount?: number;
304
- hasAirConditioning: boolean;
305
166
  hasFireplace: boolean;
306
- hasPool: boolean;
167
+ hasAirConditioning: boolean;
307
168
  hasSpa: boolean;
169
+ hasPool: boolean;
308
170
  }
309
- export interface ZillowListingHdpData {
310
- homeInfo: ZillowListingHomeInfo;
171
+ export interface ZillowListingFlags {
172
+ is_pending?: boolean;
173
+ is_fsba?: boolean;
174
+ is_fsbo?: boolean;
175
+ is_bank_owned?: boolean;
176
+ is_coming_soon?: boolean;
177
+ is_for_auction?: boolean;
178
+ is_foreclosure?: boolean;
179
+ is_new_home?: boolean;
180
+ is_open_house?: boolean;
181
+ is_room_for_rent?: boolean;
311
182
  }
312
- export interface ZillowListingHomeInfo {
313
- bathrooms?: number;
314
- bedrooms?: number;
315
- city: string;
316
- comingSoonOnMarketDate?: number;
317
- contingentListingType?: string;
318
- country: string;
319
- currency: string;
320
- datePriceChanged?: number;
321
- dateSold?: number;
322
- daysOnZillow: number;
323
- group_type?: string;
324
- homeStatus: string;
325
- homeStatusForHDP: string;
326
- homeType: string;
327
- isFeatured: boolean;
328
- isNonOwnerOccupied: boolean;
329
- isPreforeclosureAuction: boolean;
330
- isPremierBuilder: boolean;
331
- isRentalWithBasePrice?: boolean;
332
- isShowcaseListing: boolean;
333
- isUnmappable: boolean;
334
- isZillowOwned: boolean;
335
- latitude?: number;
336
- listing_sub_type: ZillowListingSubType;
337
- livingArea?: number;
338
- longitude?: number;
339
- lotAreaUnit?: string;
340
- lotAreaValue?: number;
341
- newConstructionType?: string;
342
- openHouse?: string;
343
- open_house_info?: ZillowListingOpenHouseInfo;
344
- price?: number;
345
- priceChange?: number;
346
- priceForHDP?: number;
347
- priceReduction?: string;
348
- priceSuffix?: string;
349
- providerListingID?: string;
350
- rentZestimate?: number;
351
- shouldHighlight: boolean;
352
- state: string;
353
- streetAddress: string;
354
- taxAssessedValue?: number;
355
- timeOnZillow?: number;
356
- unit?: string;
357
- zestimate?: number;
358
- zipcode: string;
359
- zpid: number;
183
+ export interface ZillowListingOfficeAttribution {
184
+ officeName: string | null;
185
+ associatedOfficeType: string;
360
186
  }
361
187
  export interface ZillowListingOpenHouseInfo {
362
188
  open_house_showing: ZillowListingOpenHouseShowing[];
363
189
  }
364
190
  export interface ZillowListingOpenHouseShowing {
365
- open_house_end: number;
366
191
  open_house_start: number;
192
+ open_house_end: number;
367
193
  }
368
- export interface ZillowListingPhotoKey {
369
- photoKey: string;
194
+ export interface ZillowListingProvider {
195
+ title?: string;
196
+ disclaimerText?: unknown | null;
197
+ enhancedDescriptionText?: unknown | null;
198
+ postingWebsiteLinkText?: string;
199
+ sourceText?: string;
200
+ postingWebsiteURL?: unknown | null;
201
+ showNoContactInfoMessage?: boolean;
202
+ agentName?: string | null;
203
+ agentLicenseNumber?: unknown | null;
204
+ postingGroupName?: string | null;
205
+ logos?: unknown[];
206
+ enhancedVideoURL?: unknown | null;
370
207
  }
371
- export interface ZillowListingRecommendation {
372
- contentType: string;
373
- displayString: string;
208
+ export interface ZillowListingRestrictions {
209
+ can_commingle_comparables?: boolean;
210
+ can_show_automated_valuation?: boolean;
211
+ can_show_comparables?: boolean;
212
+ can_show_cropped_photos?: boolean;
213
+ can_show_non_idx_media?: boolean;
214
+ can_show_price_history?: boolean;
215
+ can_show_tax_history?: boolean;
216
+ can_show_user_generated_content?: boolean;
217
+ hide_days_on_site?: boolean;
218
+ hide_public_remarks?: boolean;
219
+ prefer_mls_photos?: boolean;
220
+ show_agent_email?: boolean;
221
+ show_agent_phone?: boolean;
222
+ show_attribution_above_facts?: boolean;
223
+ show_auction_status_as_sold?: boolean;
224
+ show_disclaimer_below_attribution?: boolean;
225
+ show_feed_logo_in_contact_box?: boolean;
226
+ show_listing_office_phone?: boolean;
227
+ watermark_photo_bottom_left?: boolean;
228
+ watermark_photo_bottom_right?: boolean;
229
+ attribute_listing_contact?: boolean;
230
+ commingling_rules_apply?: boolean;
231
+ commingling_category?: boolean;
232
+ listing_agent_must_be_contactable?: boolean;
233
+ office_name_precedes_agent_name?: boolean;
234
+ password_required_for_market_analysis?: boolean;
374
235
  }
375
236
  export type ZillowListingStatus = "for_sale" | "for_rent" | "sold";
376
- export interface ZillowListingSubType {
377
- is_FSBA?: boolean;
378
- is_FSBO?: boolean;
379
- is_bankOwned?: boolean;
380
- is_comingSoon?: boolean;
381
- is_forAuction?: boolean;
382
- is_foreclosure?: boolean;
383
- is_newHome?: boolean;
384
- is_openHouse?: boolean;
385
- is_pending?: boolean;
386
- is_roomForRent?: boolean;
387
- }
388
237
  export interface ZillowListingUnit {
389
- beds: string;
390
238
  price: string;
239
+ beds: string;
391
240
  roomForRent: boolean;
392
241
  }
393
- export interface ZillowListingZovInsight {
394
- amenityType: string;
395
- displayString: string;
396
- rarity: string;
397
- regionName: string;
242
+ export interface ZillowLocation {
243
+ display: string;
244
+ metaData: ZillowLocationMetadata;
245
+ resultType: string;
246
+ }
247
+ export interface ZillowLocationMetadata {
248
+ zpid?: string;
249
+ maloneId?: number;
250
+ regionId?: number;
251
+ addressType?: string;
252
+ streetNumber?: string;
253
+ streetName?: string;
254
+ unitNumber?: string;
255
+ city?: string;
256
+ state?: string;
257
+ country?: string;
258
+ zipCode?: string;
259
+ lat?: number;
260
+ lng?: number;
261
+ regionType?: string;
262
+ county?: string;
263
+ countyFIPS?: string;
398
264
  }
399
265
  export type ZillowLocationType = "all" | "region" | "address";
400
266
  export interface ZillowLocations {
401
- items: ZillowAutocompleteResult[];
267
+ items: ZillowLocation[];
268
+ }
269
+ export interface ZillowNearbyBuilding {
270
+ lotId?: string;
271
+ providerListingId?: string;
272
+ bdpLink?: string;
273
+ maxPrice?: number;
274
+ minPrice?: number;
275
+ totalRequiredMonthlyMinFee?: number | null;
276
+ totalRequiredMonthlyMaxFee?: number | null;
277
+ photoCount?: number | null;
278
+ bedroomGroups?: ZillowPropertyBedroomGroup[];
279
+ buildingAddress?: string;
280
+ buildingName?: string | null;
281
+ isLowIncome?: boolean | null;
282
+ isPaidListing?: boolean;
283
+ isSeniorHousing?: boolean | null;
284
+ isStudentHousing?: boolean;
285
+ latitude?: number;
286
+ longitude?: number;
287
+ minBaths?: number;
288
+ minBeds?: number;
289
+ minLivingArea?: number;
290
+ listPriceIncludesRequiredMonthlyFees?: boolean;
291
+ marketingTreatments?: string[] | null;
292
+ minBaseRent?: number;
293
+ maxBaseRent?: number;
294
+ state?: string;
295
+ photo?: ZillowPropertyNeighborhoodMapThumb;
296
+ }
297
+ export interface ZillowPhotoGallery {
298
+ base_url?: string | null;
299
+ community_base_url?: string | null;
300
+ photo_keys?: string[];
301
+ community_photo_keys?: string[];
302
+ }
303
+ export interface ZillowPriceHistoryAgent {
304
+ name: string;
305
+ profileUrl: string | null;
306
+ photo: ZillowPriceHistoryAgentPhoto | null;
307
+ }
308
+ export interface ZillowPriceHistoryAgentPhoto {
309
+ url: string;
402
310
  }
403
311
  export interface ZillowProperty {
404
- abbreviatedAddress?: string;
405
- address: ZillowPropertyAddress;
406
- affordabilityEstimate?: ZillowPropertyAffordabilityEstimate;
407
- affordabilityEstimateV2?: ZillowPropertyAffordabilityEstimateV2;
408
- attributionInfo: ZillowPropertyAttributionInfo;
409
- baseRent?: number;
410
- bathrooms: number | null;
411
- bedrooms: number | null;
412
- boroughId: number | null;
413
- boroughSearchUrl?: unknown | null;
312
+ zpid: string;
313
+ node_id?: string;
314
+ palsId?: string;
315
+ boroughId?: number | null;
316
+ cityId?: number;
317
+ countyId?: number;
318
+ stateId?: number;
319
+ mlsid?: string | null;
320
+ listingAccountUserId?: string | null;
321
+ listingFeedID?: unknown | null;
414
322
  brokerId?: unknown | null;
415
- brokerIdDimension?: string;
416
- brokerageName?: string | null;
417
- building?: ZillowPropertyBuilding | null;
418
323
  buildingId?: string | null;
419
- buyAbilityData?: ZillowPropertyBuyAbilityData;
420
- city: string;
421
- cityId: number;
422
- citySearchUrl?: ZillowPropertyRegionLink;
423
- comingSoonOnMarketDate?: unknown | null;
324
+ providerListingID?: string | null;
325
+ parcelId?: string | null;
326
+ maloneId?: string;
327
+ source_system_id?: number | null;
328
+ description?: string;
329
+ hdpUrl?: string;
330
+ postingUrl?: string | null;
331
+ virtualTourUrl?: string | null;
332
+ rentZestimateURL?: string | null;
333
+ marketTrendsURL?: string;
334
+ interactiveFloorPlanUrl?: string;
335
+ nearbyBuildingLinks?: ZillowPropertyNearbyBuildingLink[];
336
+ neighborhoodSearchUrl?: unknown;
337
+ stateSearchUrl?: unknown;
338
+ countySearchUrl?: unknown;
339
+ citySearchUrl?: unknown;
340
+ zipcodeSearchUrl?: unknown;
341
+ boroughSearchUrl?: unknown | null;
424
342
  communityUrl?: unknown | null;
425
- contactAgentFormVariant?: string;
426
- contingentListingType: unknown | null;
427
- country: string;
428
- county?: string;
429
- countyFIPS?: string | null;
430
- countyId: number;
431
- countySearchUrl?: ZillowPropertyRegionLink;
432
- currency: string;
433
- datePosted?: number;
343
+ streetViewMetadataUrlMapLightboxAddress?: string;
344
+ price?: number | null;
345
+ priceChange?: number | null;
346
+ zestimate?: number | null;
347
+ rentZestimate?: number | null;
348
+ lastSoldPrice?: number | null;
349
+ photoCount?: number;
350
+ priceHistory?: ZillowPropertyPriceHistory[];
351
+ zestimateMinus30?: unknown | null;
352
+ tourViewCount?: number;
353
+ pageViewCount?: number;
354
+ favoriteCount?: number;
355
+ totalRequiredMonthlyMinFee?: number | null;
356
+ totalRequiredMonthlyMaxFee?: number | null;
357
+ listPriceLow?: unknown | null;
358
+ rentalApplicationPriceDetail?: ZillowPropertyRentalApplicationPriceDetail;
359
+ zestimateLowPercent?: string | null;
360
+ zestimateHighPercent?: string | null;
361
+ homeStatus?: string;
362
+ listing_restrictions?: ZillowListingRestrictions;
363
+ pslMarketingStatus?: string;
364
+ keystoneHomeStatus?: string;
365
+ isIncomeRestricted?: unknown | null;
366
+ moveInCompletionDate?: unknown | null;
367
+ priceChangeDate?: number | null;
368
+ priceChangeDateString?: string | null;
434
369
  dateSold?: number | null;
370
+ comingSoonOnMarketDate?: unknown | null;
435
371
  dateSoldString?: string;
436
- daysOnZillow?: number;
437
- description?: string;
438
- desktopWebHdpImageLink?: string;
372
+ datePosted?: number;
373
+ attributionInfo?: ZillowPropertyAttributionInfo;
374
+ parentRegion?: ZillowPropertyParentRegion;
375
+ thirdPartyVirtualTour?: ZillowPropertyThirdPartyVirtualTour | null;
376
+ sellingSoon?: ZillowPropertySellingSoon[];
377
+ listing_agent?: ZillowListingAgent;
378
+ resoFacts?: ZillowPropertyResoFacts;
379
+ pals?: ZillowPropertyPal[];
380
+ vrModel?: ZillowPropertyVRModel;
381
+ nearbyHomes?: ZillowPropertySummary[];
382
+ nearbyBuildings?: ZillowNearbyBuilding[];
383
+ lastSoldListing?: ZillowPropertyLastSoldListing;
384
+ address?: ZillowPropertyAddress;
385
+ whatILove?: unknown | null;
386
+ home_insights?: string[] | null;
387
+ city?: string;
388
+ state?: string;
389
+ streetAddress?: string;
390
+ zipcode?: string;
391
+ country?: string;
392
+ isUndisclosedAddress?: boolean;
393
+ homeType?: string;
394
+ currency?: string;
395
+ bedrooms?: number | null;
396
+ bathrooms?: number | null;
397
+ yearBuilt?: number | null;
398
+ livingAreaValue?: number | null;
399
+ livingAreaUnitsShort?: string;
400
+ listing_sub_type?: ZillowListingFlags;
401
+ listingDataSource?: string;
402
+ brokerageName?: string | null;
403
+ timeZone?: string;
404
+ openHouseSchedule?: ZillowPropertyOpenHouseSchedule[];
405
+ isPremierBuilder?: boolean;
406
+ newConstructionType?: string | null;
407
+ moveInReady?: boolean;
408
+ livingArea?: number | null;
409
+ monthlyHoaFee?: number | null;
410
+ lotAreaUnits?: string;
411
+ lotAreaValue?: number | null;
412
+ lotSize?: number | null;
413
+ contingentListingType?: unknown | null;
414
+ longitude?: number | null;
415
+ latitude?: number | null;
416
+ livingAreaUnits?: string;
417
+ marketingName?: string | null;
418
+ neighborhoodRegion?: ZillowPropertyNeighborhoodRegion;
419
+ postingProductType?: string;
420
+ propertyTypeDimension?: string;
421
+ listingTypeDimension?: string;
422
+ restimateMinus30?: string | null;
423
+ staticMap?: ZillowPropertyStaticMap;
439
424
  downPaymentAssistance?: ZillowPropertyDownPaymentAssistance;
440
- editPropertyHistorylink?: unknown | null;
441
- favoriteCount?: number;
442
- featuredListingTypeDimension?: string;
425
+ affordabilityEstimate?: ZillowPropertyAffordabilityEstimate;
426
+ affordabilityEstimateV2?: ZillowAffordabilityEstimateV2;
443
427
  foreclosureTypes?: ZillowPropertyForeclosureTypes;
444
- formattedChip: ZillowPropertyFormattedChip;
428
+ hdpTypeDimension?: string;
445
429
  hasApprovedThirdPartyVirtualTourUrl?: boolean | null;
446
- hasBadGeocode?: boolean;
447
- hasPromotion?: boolean;
430
+ listingProvider?: ZillowListingProvider | null;
431
+ marketingType?: string | null;
432
+ marketingTreatments?: string[] | null;
433
+ timeOnZillow?: string | null;
434
+ daysOnZillow?: number;
435
+ ouid?: string;
436
+ tourEligibility?: ZillowPropertyTourEligibility;
437
+ mortgageZHLRates?: ZillowPropertyMortgageZHLRates | null;
438
+ propertyTaxRate?: number;
439
+ secondsOnZillow?: number;
440
+ listingAccount?: unknown | null;
441
+ isZillowOwned?: boolean;
448
442
  hasPublicVideo?: boolean;
449
- hdpTypeDimension?: string;
450
- hdpUrl: string;
451
- hdpVariant?: string;
452
- hiResImageLink?: string;
453
- hideClimateRiskScore?: boolean;
454
- homeInsights?: ZillowPropertyHomeInsight[] | null;
455
- homeStatus: string;
456
- homeType: string;
457
- homeValues?: unknown | null;
458
- id?: string;
459
- interactiveFloorPlanUrl?: string;
460
- isCurrentSignedInAgentResponsible?: boolean;
461
- isCurrentSignedInUserVerifiedOwner?: boolean;
462
- isFeatured?: boolean;
463
- isHousingConnector?: boolean;
464
- isIncomeRestricted?: unknown | null;
465
- isInstantTourEnabled?: boolean;
466
- isListedByOwner?: boolean;
467
- isListingClaimedByCurrentSignedInUser?: boolean;
468
- isListingOwnedByCurrentSignedInUser?: boolean;
443
+ isRecentStatusChange?: boolean;
469
444
  isNonOwnerOccupied?: boolean;
470
- isPaidMultiFamilyBrokerId?: boolean;
471
445
  isPreforeclosureAuction?: boolean;
472
- isPremierBuilder: boolean;
473
- isRecentStatusChange?: boolean;
446
+ isFeatured?: boolean;
447
+ isShowcaseListing?: boolean;
448
+ county?: string;
449
+ rentalApplicationsAcceptedType?: string;
450
+ featuredListingTypeDimension?: string;
451
+ brokerIdDimension?: string;
474
452
  isRentalsLeadCapMet?: boolean;
475
- isShowcaseListing: boolean;
476
- isUndisclosedAddress: boolean;
477
- isVerifiedClaimedByCurrentSignedInUser?: boolean;
478
- isZillowOwned?: boolean;
479
- keystoneHomeStatus?: string;
480
- lastSoldListing?: ZillowPropertyLastSoldListing;
481
- lastSoldPrice: number | null;
482
- latitude: number | null;
483
- lfaViewPropertyPageUrl?: unknown | null;
484
- listPriceIncludesRequiredMonthlyFees?: boolean;
485
- listPriceLow?: unknown | null;
486
- listedBy?: ZillowPropertyListedBy[];
487
- listingAccount?: unknown | null;
488
- listingAccountUserId?: string | null;
489
- listingDataSource?: string;
490
- listingFeedID?: unknown | null;
491
- listingMetadata: Record<string, boolean | null>;
492
- listingOwnerConfigIDs?: unknown | null;
493
- listingProvider?: ZillowPropertyListingProvider | null;
494
- listingRules?: ZillowPropertyListingRules;
495
- listingSource?: unknown | null;
496
- listingSubType?: ZillowPropertyListingSubType;
497
- listingTypeDimension?: string;
498
- listing_sub_type: ZillowPropertyListingFlags;
499
- livingArea: number | null;
500
- livingAreaUnits?: string;
501
- livingAreaUnitsShort?: string;
502
- livingAreaValue: number | null;
503
- longitude: number | null;
504
- lotAreaUnits: string;
505
- lotAreaValue: number | null;
453
+ isPaidMultiFamilyBrokerId?: boolean;
454
+ isHousingConnector?: boolean;
455
+ hasPromotion?: boolean;
456
+ planNumber?: string;
457
+ specNumber?: unknown | null;
506
458
  lotNumber?: unknown | null;
459
+ listPriceIncludesRequiredMonthlyFees?: boolean;
460
+ baseRent?: number;
461
+ rentalCostsAndFees?: ZillowRentalCostsAndFees;
462
+ postingContact?: ZillowPropertyPostingContact;
507
463
  lotPremium?: unknown | null;
508
- lotSize: number | null;
509
- maloneId?: string;
510
- marketTrendsURL?: string;
511
- marketingName?: string | null;
512
- marketingTreatments?: string[] | null;
513
- marketingType?: string;
514
- mlsid?: string | null;
515
- monthlyHoaFee?: number | null;
516
- mortgageZHLRates?: ZillowPropertyMortgageZHLRates | null;
517
- moveHomeMapLocationLink?: unknown | null;
518
- moveInCompletionDate?: unknown | null;
519
- moveInReady?: boolean;
520
- nearbyBuildingLinks?: ZillowPropertyNearbyBuildingLink[];
521
- nearbyBuildings?: ZillowPropertyNearbyBuilding[];
464
+ roomForRent?: boolean | null;
465
+ homeValues?: unknown | null;
466
+ rentalMarketingTreatments?: string[] | null;
467
+ building?: ZillowPropertyBuilding | null;
468
+ hasBadGeocode?: boolean;
469
+ specialOffers?: unknown[];
522
470
  nearbyCities?: ZillowPropertyNearbyRegion[];
523
- nearbyHomes?: ZillowPropertyNearbyHome[];
524
471
  nearbyNeighborhoods?: ZillowPropertyNearbyRegion[];
525
472
  nearbyZipcodes?: ZillowPropertyNearbyRegion[];
526
- neighborhoodMapThumb?: ZillowPropertyNeighborhoodMapThumb[];
527
- neighborhoodRegion?: ZillowPropertyNeighborhoodRegion;
528
- neighborhoodSearchUrl?: ZillowPropertyRegionPath;
529
- newConstructionType?: string | null;
530
- odpPropertyModels?: ZillowPropertyOdpPropertyModels;
531
- openHouseSchedule?: ZillowPropertyOpenHouseSchedule[];
532
- originalPhotos?: ZillowPropertyPhoto[];
533
- ouid?: string;
534
- ownerAccount?: unknown | null;
535
- pageUrlFragment?: string;
536
- pageViewCount?: number;
537
- pals?: ZillowPropertyPal[];
538
- palsId: string;
539
- parcelId?: string | null;
540
- parentRegion?: ZillowPropertyParentRegion;
541
- photoCount: number;
542
- photos?: ZillowPropertyPhotoElement[];
543
- planNumber?: string;
544
- postingContact?: ZillowPropertyPostingContact;
545
- postingPresentationTypes?: unknown | null;
546
- postingProductType?: string;
547
- postingUrl?: string | null;
548
- price: number | null;
549
- priceChange?: number | null;
550
- priceChangeDate?: number | null;
551
- priceChangeDateString?: string | null;
552
- priceHistory?: ZillowPropertyPriceHistory[];
553
- primaryPublicVideo?: unknown | null;
554
- propertyEventLogLink?: unknown | null;
555
- propertyHasLasViolation?: boolean;
556
- propertyTaxRate?: number;
557
- propertyTypeDimension: string;
558
- propertyUpdatePageLink?: unknown | null;
559
- providerListingID?: string | null;
560
- pslMarketingStatus?: string;
561
- rentZestimate?: number | null;
562
- rentZestimateURL?: string | null;
563
- rentalApplicationPriceDetail?: ZillowPropertyRentalApplicationPriceDetail;
564
- rentalApplicationsAcceptedType?: string;
565
- rentalAvailableTourTimes?: unknown[];
566
- rentalCostsAndFees?: ZillowPropertyRentalCostsAndFees;
473
+ abbreviatedAddress?: string;
474
+ isListedByOwner?: boolean;
475
+ isInstantTourEnabled?: boolean;
476
+ countyFIPS?: string | null;
567
477
  rentalInstantTour?: unknown | null;
568
- rentalMarketingTreatments?: string[] | null;
569
- rentalUpsellMessage?: ZillowPropertyRentalUpsellMessage;
570
- resoFacts: ZillowPropertyResoFacts;
571
- responsivePhotos: ZillowPropertyResponsivePhoto[];
478
+ rentalAvailableTourTimes?: unknown[];
479
+ propertyHasLasViolation?: boolean;
480
+ taxAssessedValue?: number | null;
481
+ listingSource?: unknown | null;
482
+ listed_by?: ZillowListedBy[];
483
+ related_properties?: ZillowRelatedProperties[];
484
+ tour_scheduling?: ZillowTourScheduling[];
485
+ responsivePhotos?: ZillowPropertyResponsivePhoto[];
486
+ photos?: ZillowPropertyPhotoElement[];
487
+ desktopWebHdpImageLink?: string;
572
488
  responsivePhotosOriginalRatio?: ZillowPropertyPhotoElement[];
573
- restimateMinus30?: string | null;
574
- richMedia: ZillowPropertyRichMedia | null;
575
- richMediaVideos?: unknown | null;
576
- roomForRent?: boolean | null;
577
- secondsOnZillow?: number;
578
- sellingSoon?: ZillowPropertySellingSoon[];
489
+ originalPhotos?: ZillowPropertyPhoto[];
490
+ hiResImageLink?: string;
579
491
  singleXXLPhoto?: ZillowPropertyNeighborhoodMapThumb[];
580
- specNumber?: unknown | null;
581
- specialOffers?: unknown[];
582
- ssid?: number | null;
583
- state: string;
584
- stateId: number;
585
- stateSearchUrl?: ZillowPropertyRegionPath;
586
- staticMap?: ZillowPropertyStaticMap;
587
- streetAddress: string;
588
- streetViewMetadataUrlMapLightboxAddress?: string;
589
- streetViewTileImageUrlMediumAddress?: string;
590
- streetViewTileImageUrlMediumLatLong?: string | null;
591
492
  summaryFirstPhoto?: ZillowPropertyPhoto[];
592
- taxAssessedValue?: number | null;
593
- thirdPartyVirtualTour?: ZillowPropertyThirdPartyVirtualTour | null;
493
+ streetViewTileImageUrlMediumLatLong?: string | null;
494
+ streetViewTileImageUrlMediumAddress?: string;
594
495
  thumb?: ZillowPropertyNeighborhoodMapThumb[];
595
- timeOnZillow?: string | null;
596
- timeZone: string;
597
- totalRequiredMonthlyMaxFee?: number | null;
598
- totalRequiredMonthlyMinFee?: number | null;
599
- tourAppointmentsForCurrentLoggedInUser?: unknown | null;
600
- tourEligibility?: ZillowPropertyTourEligibility;
601
- tourViewCount?: number;
602
- virtualTourUrl?: string | null;
603
- vrModel?: ZillowPropertyVRModel;
604
- whatILove?: unknown | null;
605
- yearBuilt?: number | null;
606
- zestimate: number | null;
607
- zestimateHighPercent?: string | null;
608
- zestimateLowPercent?: string | null;
609
- zestimateMinus30?: unknown | null;
610
- zipcode: string;
611
- zipcodeSearchUrl?: ZillowPropertyRegionPath;
612
- zpid: number;
496
+ neighborhoodMapThumb?: ZillowPropertyNeighborhoodMapThumb[];
497
+ richMedia?: ZillowPropertyRichMedia | null;
498
+ primaryPublicVideo?: unknown | null;
499
+ richMediaVideos?: unknown | null;
613
500
  }
614
501
  export interface ZillowPropertyAddress {
502
+ streetAddress: string;
615
503
  city: string;
616
- community?: unknown | null;
617
- neighborhood?: unknown | null;
618
504
  state: string;
619
- streetAddress: string;
620
- subdivision?: unknown | null;
621
505
  zipcode: string;
506
+ neighborhood?: unknown | null;
507
+ community?: unknown | null;
508
+ subdivision?: unknown | null;
622
509
  }
623
510
  export interface ZillowPropertyAffordabilityEstimate {
624
511
  totalMonthlyCost: number | null;
625
512
  }
626
- export interface ZillowPropertyAffordabilityEstimateV2 {
627
- mortgageChipData: ZillowPropertyMortgageChipData;
628
- totalMonthlyCost: number | null;
629
- usedInputs: ZillowPropertyUsedInputs;
630
- }
631
513
  export interface ZillowPropertyAtAGlanceFact {
632
514
  factLabel: string;
633
515
  factValue: string | null;
@@ -635,34 +517,34 @@ export interface ZillowPropertyAtAGlanceFact {
635
517
  export interface ZillowPropertyAttributeSource {
636
518
  infoString1: string | null;
637
519
  infoString2: string | null;
638
- infoString3: unknown | null;
520
+ infoString3: string | null;
639
521
  }
640
522
  export interface ZillowPropertyAttributionInfo {
641
- agentEmail?: unknown | null;
523
+ mlsId: string | null;
524
+ trueStatus: string | null;
525
+ lastChecked?: string;
526
+ lastUpdated?: string;
527
+ mlsName?: string | null;
528
+ listingAgentAttributionContact?: unknown | null;
529
+ listingAttributionContact?: string | null;
530
+ notMLSSourcedListing?: boolean | null;
642
531
  agentName?: string | null;
532
+ agentEmail?: unknown | null;
643
533
  agentPhoneNumber?: string | null;
644
534
  brokerName?: string | null;
645
535
  brokerPhoneNumber?: string | null;
646
- buyerBrokerageName?: string | null;
647
- infoString10?: string;
648
- infoString16?: unknown | null;
536
+ listingAgreement?: unknown | null;
649
537
  infoString3?: unknown | null;
650
538
  infoString5?: string | null;
651
- lastChecked?: string;
652
- lastUpdated?: string;
653
- listingAgentAttributionContact?: unknown | null;
654
- listingAgreement?: unknown | null;
655
- listingAttributionContact?: string | null;
539
+ infoString10?: string;
540
+ infoString16?: unknown | null;
656
541
  mlsDisclaimer?: string;
657
- mlsId: string | null;
658
- mlsName?: string | null;
659
- notMLSSourcedListing?: boolean;
542
+ buyerBrokerageName?: string | null;
660
543
  providerLogo?: string | null;
661
- trueStatus: string | null;
662
544
  }
663
545
  export interface ZillowPropertyBedroomGroup {
664
- beds: string;
665
546
  price: string;
547
+ beds: string;
666
548
  }
667
549
  export interface ZillowPropertyBucket {
668
550
  lastUpdated: number;
@@ -671,295 +553,80 @@ export interface ZillowPropertyBucket {
671
553
  }
672
554
  export interface ZillowPropertyBuilding {
673
555
  bdpUrl: string;
674
- buildingAttributes: ZillowPropertyBuildingAttributes;
675
- buildingName: string;
676
556
  rentalUnitsSummary: ZillowPropertyRentalUnitsSummary;
557
+ buildingName: string;
677
558
  streetAddress: string;
559
+ buildingAttributes: ZillowPropertyBuildingAttributes;
678
560
  }
679
561
  export interface ZillowPropertyBuildingAttributes {
680
562
  incomeRestrictions: unknown | null;
681
563
  }
682
- export interface ZillowPropertyBuyAbilityData {
683
- chipLabel?: unknown | null;
684
- hub?: ZillowPropertyHub;
685
- isEligibleProperty: boolean;
686
- }
687
- export interface ZillowPropertyCreditScore {
688
- rangeType: string;
689
- }
690
- export interface ZillowPropertyCtaButton {
691
- enrollmentStatus: string;
692
- }
693
564
  export interface ZillowPropertyDownPaymentAssistance {
694
565
  eligibility: ZillowPropertyEligibility;
695
566
  }
696
567
  export interface ZillowPropertyEligibility {
697
568
  dpa: boolean;
698
569
  }
699
- export interface ZillowPropertyFee {
700
- type: string;
701
- zillowDisclaimers: string[] | null;
702
- }
703
- export interface ZillowPropertyFeeGroup {
704
- fees: ZillowPropertyFee[];
705
- }
706
- export interface ZillowPropertyFees {
707
- monthly: ZillowPropertyMonthly;
708
- }
709
570
  export interface ZillowPropertyFeesAndDue {
710
- fee: string;
711
571
  name: string | null;
712
- phone: unknown | null;
713
572
  type: string;
573
+ fee: string;
574
+ phone: unknown | null;
714
575
  }
715
576
  export interface ZillowPropertyFloorPlan {
716
- heroImageUrl?: string;
717
577
  viewerUrl?: string;
578
+ heroImageUrl?: string;
718
579
  }
719
580
  export interface ZillowPropertyForeclosureTypes {
720
- isAnyForeclosure?: boolean;
721
581
  isBankOwned: boolean;
722
582
  isForeclosedNFS?: boolean;
723
583
  isPreforeclosure?: boolean;
724
- wasDefault?: unknown | null;
725
- wasForeclosed?: boolean;
584
+ isAnyForeclosure?: boolean;
726
585
  wasNonRetailAuction: boolean;
586
+ wasForeclosed?: boolean;
587
+ wasDefault?: unknown | null;
727
588
  }
728
- export interface ZillowPropertyFormattedChip {
729
- location: ZillowPropertyLocation[];
589
+ export interface ZillowPropertyHighlight {
590
+ text?: string;
591
+ content_type?: string;
592
+ amenity_type?: string;
593
+ rarity?: string;
594
+ region_name?: string;
730
595
  }
731
596
  export interface ZillowPropertyHistory {
597
+ zpid: string;
598
+ series: ZillowHomeValueChartSeries[];
732
599
  metric: ZillowHistoryMetric;
733
600
  period: ZillowHistoryPeriod;
734
- series: ZillowHomeValueChartSeries[];
735
- zpid: number;
736
- }
737
- export interface ZillowPropertyHomeInsight {
738
- insights: ZillowPropertyInsight[];
739
- }
740
- export interface ZillowPropertyHub {
741
- ctaButton: ZillowPropertyCtaButton;
742
- title: string;
743
601
  }
744
602
  export interface ZillowPropertyImx {
745
- hasLocalizedPhotos: boolean;
746
- isLmsTour: boolean;
747
603
  revisionId: string;
748
604
  viewerUrl: string;
749
- }
750
- export interface ZillowPropertyInsight {
751
- modelId: string;
752
- phrases: string[];
753
- treatmentId: string;
605
+ hasLocalizedPhotos: boolean;
606
+ isLmsTour: boolean;
754
607
  }
755
608
  export interface ZillowPropertyLastSoldListing {
756
- mlsAttribution: unknown | null;
757
609
  palsId: string | null;
610
+ mlsAttribution: unknown | null;
758
611
  photos: unknown | null;
759
612
  }
760
- export interface ZillowPropertyListedBy {
761
- elements: ZillowPropertyListedByElement[];
762
- id: string;
763
- textStyle: unknown | null;
764
- }
765
- export interface ZillowPropertyListedByElement {
766
- action: unknown | null;
767
- id: string;
768
- text: string;
769
- }
770
- export interface ZillowPropertyListingFlags {
771
- is_FSBA?: boolean;
772
- is_FSBO?: boolean;
773
- is_bankOwned?: boolean;
774
- is_comingSoon?: boolean;
775
- is_forAuction?: boolean;
776
- is_foreclosure?: boolean;
777
- is_newHome?: boolean;
778
- is_openHouse?: boolean;
779
- is_pending?: boolean;
780
- is_roomForRent?: boolean;
781
- }
782
- export interface ZillowPropertyListingProvider {
783
- agentLicenseNumber?: unknown | null;
784
- agentName?: string | null;
785
- disclaimerText?: unknown | null;
786
- enhancedDescriptionText?: unknown | null;
787
- enhancedVideoURL?: unknown | null;
788
- isZRMSourceText?: unknown | null;
789
- logos: unknown[];
790
- postingGroupName?: string | null;
791
- postingWebsiteLinkText?: string;
792
- postingWebsiteURL?: unknown | null;
793
- showLogos?: unknown | null;
794
- showNoContactInfoMessage?: boolean;
795
- sourceText?: string;
796
- title?: string;
797
- }
798
- export interface ZillowPropertyListingRules {
799
- hideDaysOnSiteDisplay?: boolean;
800
- hidePublicRemarks: boolean;
801
- }
802
- export interface ZillowPropertyListingSubType {
803
- isBankOwned: boolean;
804
- isComingSoon: boolean;
805
- isFSBA: boolean;
806
- isFSBO: boolean;
807
- isForAuction: boolean;
808
- isForeclosure: boolean;
809
- isNewHome: boolean;
810
- isOpenHouse: boolean;
811
- isPending: boolean;
812
- }
813
- export interface ZillowPropertyLoan {
814
- rateSource: string;
815
- }
816
- export interface ZillowPropertyLocation {
817
- fullValue: string | null;
818
- }
819
- export interface ZillowPropertyMonthly {
820
- feeGroup: ZillowPropertyFeeGroup[];
821
- }
822
- export interface ZillowPropertyMortgageCTA {
823
- ctaCopyText: string;
824
- personalizedCta: ZillowPropertyPersonalizedCta;
825
- personalizedCtaCopyText: string;
826
- personalizedRoutingURL: string;
827
- }
828
- export interface ZillowPropertyMortgageChipData {
829
- isPersonalized: boolean;
830
- mortgageCTA: ZillowPropertyMortgageCTA;
831
- }
832
613
  export interface ZillowPropertyMortgageZHLRates {
833
- arm5Bucket?: ZillowPropertyBucket;
834
614
  fifteenYearFixedBucket?: ZillowPropertyBucket;
835
615
  thirtyYearFixedBucket: ZillowPropertyBucket;
836
- }
837
- export interface ZillowPropertyNavAction {
838
- __typename: string;
839
- analyticsTag: string;
840
- showAbad: boolean;
841
- urlExperience: ZillowPropertyURLExperience;
842
- }
843
- export interface ZillowPropertyNearbyBuilding {
844
- bdpLink: string;
845
- bedroomGroups: ZillowPropertyBedroomGroup[];
846
- buildingAddress: string;
847
- buildingName: string | null;
848
- isLowIncome: boolean | null;
849
- isPaidListing: boolean;
850
- isSeniorHousing: boolean | null;
851
- isStudentHousing: boolean;
852
- latitude: number;
853
- listPriceIncludesRequiredMonthlyFees: boolean;
854
- listingMetadata: ZillowPropertyNearbyBuildingListingMetadata;
855
- longitude: number;
856
- lotId: string;
857
- marketingTreatments: string[] | null;
858
- maxBaseRent: number;
859
- maxPrice: number;
860
- minBaseRent: number;
861
- minBaths: number;
862
- minBeds: number;
863
- minLivingArea: number;
864
- minPrice: number;
865
- photo: ZillowPropertyNeighborhoodMapThumb;
866
- photoCount: number | null;
867
- providerListingId: string;
868
- showUpdateTime: boolean;
869
- state: string;
870
- totalRequiredMonthlyMaxFee: number | null;
871
- totalRequiredMonthlyMinFee: number | null;
616
+ arm5Bucket?: ZillowPropertyBucket;
872
617
  }
873
618
  export interface ZillowPropertyNearbyBuildingLink {
874
619
  buildingUrl: ZillowPropertyRegionLink;
875
620
  }
876
- export interface ZillowPropertyNearbyBuildingListingMetadata {
877
- BuildingDataG: string;
878
- BuildingDataH: string;
879
- BuildingDataI: string;
880
- BuildingDataJ: string;
881
- BuildingDataL: string;
882
- BuildingDataM: string;
883
- BuildingDataN: string;
884
- BuildingDataO: string;
885
- BuildingDataP: string;
886
- }
887
- export interface ZillowPropertyNearbyHome {
888
- address: ZillowPropertyNearbyHomeAddress;
889
- attributionInfo: ZillowPropertyNearbyHomeAttributionInfo;
890
- baseRent: number | null;
891
- bathrooms: number | null;
892
- bedrooms: number | null;
893
- currency: string;
894
- formattedChip: ZillowPropertyFormattedChip;
895
- hdpTypeDimension: string;
896
- hdpUrl: string;
897
- homeStatus: string;
898
- homeType: string;
899
- isPremierBuilder: boolean;
900
- isShowcaseListing: boolean | null;
901
- latitude: number;
902
- listPriceIncludesRequiredMonthlyFees: boolean | null;
903
- listingMetadata: ZillowPropertyNearbyHomeListingMetadata;
904
- listingTypeDimension: string;
905
- listing_sub_type: ZillowPropertyNearbyHomeListingSubType;
906
- livingArea: number | null;
907
- livingAreaUnits: string | null;
908
- livingAreaUnitsShort: string | null;
909
- livingAreaValue: number | null;
910
- longitude: number;
911
- lotAreaUnits: string;
912
- lotAreaValue: number | null;
913
- lotSize: number | null;
914
- miniCardPhotos: ZillowPropertyNeighborhoodMapThumb[];
915
- newConstructionType: string | null;
916
- parentRegion: unknown | null;
917
- price: number | null;
918
- propertyTypeDimension: string;
919
- providerListingID: string | null;
920
- resoFacts: ZillowPropertyNearbyHomeResoFacts;
921
- state: string;
922
- totalRequiredMonthlyMaxFee: number | null;
923
- totalRequiredMonthlyMinFee: number | null;
924
- zpid: number;
925
- }
926
- export interface ZillowPropertyNearbyHomeAddress {
927
- city: string;
928
- state: string;
929
- streetAddress: string;
930
- zipcode: string;
931
- }
932
- export interface ZillowPropertyNearbyHomeAttributionInfo {
933
- agentName: string | null;
934
- agentPhoneNumber: string | null;
935
- brokerName: string | null;
936
- brokerPhoneNumber: string | null;
937
- mlsId: string | null;
938
- mlsName: string | null;
939
- providerLogo: string | null;
940
- trueStatus: string | null;
941
- }
942
- export interface ZillowPropertyNearbyHomeListingMetadata {
943
- comminglingCategoryIsRulesApplicable: boolean;
944
- }
945
- export interface ZillowPropertyNearbyHomeListingSubType {
946
- is_FSBA: boolean;
947
- is_FSBO: boolean;
948
- is_bankOwned: boolean;
949
- is_comingSoon: boolean;
950
- is_forAuction: boolean;
951
- is_foreclosure: boolean;
952
- is_newHome: boolean;
953
- }
954
621
  export interface ZillowPropertyNearbyHomeResoFacts {
955
- bathroomsFull: number | null;
956
- bathroomsHalf: number | null;
957
622
  bathroomsOneQuarter: number | null;
623
+ bathroomsHalf: number | null;
958
624
  bathroomsThreeQuarter: number | null;
625
+ bathroomsFull: number | null;
959
626
  }
960
627
  export interface ZillowPropertyNearbyRegion {
961
- body: unknown | null;
962
628
  name: string;
629
+ body: unknown | null;
963
630
  regionUrl: ZillowPropertyRegionPath;
964
631
  }
965
632
  export interface ZillowPropertyNeighborhoodMapThumb {
@@ -968,37 +635,29 @@ export interface ZillowPropertyNeighborhoodMapThumb {
968
635
  export interface ZillowPropertyNeighborhoodRegion {
969
636
  name: string;
970
637
  }
971
- export interface ZillowPropertyOdpPropertyModels {
972
- rentalsSidecar: ZillowPropertyRentalsSidecar;
973
- }
974
638
  export interface ZillowPropertyOpenHouseSchedule {
975
- endTime: string;
976
639
  startTime: string;
640
+ endTime: string;
977
641
  }
978
642
  export interface ZillowPropertyPal {
643
+ palsId: string;
979
644
  marketingStatus: string;
980
645
  marketingType: string;
981
- palsId: string;
982
646
  }
983
647
  export interface ZillowPropertyParentRegion {
984
- name: string;
985
648
  regionId?: number;
986
- }
987
- export interface ZillowPropertyPersonalizedCta {
988
- buttonType: string;
989
- navAction: ZillowPropertyNavAction;
990
- text: string;
649
+ name: string;
991
650
  }
992
651
  export interface ZillowPropertyPhoto {
993
652
  caption: string;
994
653
  mixedSources: ZillowPropertyPhotoSources;
995
654
  }
996
655
  export interface ZillowPropertyPhotoElement {
997
- caption: string;
998
656
  key?: string | null;
999
- mixedSources: ZillowPropertyPhotoSources;
1000
- subjectType?: string | null;
657
+ caption: string;
1001
658
  url?: string;
659
+ subjectType?: string | null;
660
+ mixedSources: ZillowPropertyPhotoSources;
1002
661
  }
1003
662
  export interface ZillowPropertyPhotoSource {
1004
663
  url: string;
@@ -1008,38 +667,43 @@ export interface ZillowPropertyPhotoSources {
1008
667
  jpeg: ZillowPropertyPhotoSource[];
1009
668
  webp?: ZillowPropertyPhotoSource[];
1010
669
  }
1011
- export interface ZillowPropertyPlacementGroupDecision {
1012
- experienceName: string;
1013
- experienceType: string;
1014
- placementDecisions: unknown[];
1015
- placementGroup: string;
1016
- }
1017
670
  export interface ZillowPropertyPostingContact {
1018
671
  name: string | null;
1019
672
  photo: unknown | null;
1020
673
  }
1021
674
  export interface ZillowPropertyPriceHistory {
1022
- attributeSource?: ZillowPropertyAttributeSource;
1023
- buyerAgent?: unknown | null;
1024
- date: string;
1025
- event?: string;
1026
- postingIsRental?: boolean;
1027
- price: number | null;
1028
- priceChangeRate?: number;
675
+ price?: number | null;
1029
676
  pricePerSquareFoot?: number | null;
1030
- sellerAgent?: unknown | null;
1031
- showCountyLink?: boolean;
1032
- source?: string;
677
+ priceChangeRate?: number;
678
+ date?: string;
1033
679
  time?: number;
680
+ event?: string;
681
+ source?: string;
682
+ buyerAgent?: ZillowPriceHistoryAgent | null;
683
+ sellerAgent?: ZillowPriceHistoryAgent | null;
684
+ postingIsRental?: boolean;
685
+ attributeSource?: ZillowPropertyAttributeSource;
1034
686
  }
1035
687
  export interface ZillowPropertyPropertyTourOptions {
1036
688
  isFinal: boolean;
1037
689
  tourAvailability: ZillowPropertyTourAvailability[];
1038
690
  tourType: string;
1039
691
  }
692
+ export interface ZillowPropertyRecords {
693
+ zpid: string;
694
+ priceHistory: ZillowPropertyPriceHistory[];
695
+ lastSoldPrice: number | null;
696
+ taxHistory: ZillowTaxHistoryEntry[] | null;
697
+ homeStatus: string;
698
+ dateSold: number | null;
699
+ attributionInfo: ZillowRecordsAttributionInfo;
700
+ schools: ZillowSchool[];
701
+ nearbyHomes: ZillowPropertySummary[] | null;
702
+ resoFacts: ZillowSchoolAssignmentFacts | null;
703
+ }
1040
704
  export interface ZillowPropertyRegionLink {
1041
- path: string;
1042
705
  text: string;
706
+ path: string;
1043
707
  }
1044
708
  export interface ZillowPropertyRegionPath {
1045
709
  path: string;
@@ -1049,63 +713,73 @@ export interface ZillowPropertyRentalApplicationPriceDetail {
1049
713
  defaultPriceInCents: number;
1050
714
  isStreetEasy: boolean;
1051
715
  }
1052
- export interface ZillowPropertyRentalCostsAndFees {
1053
- __typename: string;
1054
- fees: ZillowPropertyFees;
1055
- leaseDuration: number | null;
1056
- }
1057
716
  export interface ZillowPropertyRentalUnitsSummary {
1058
717
  unitCount: number;
1059
718
  }
1060
- export interface ZillowPropertyRentalUpsellMessage {
1061
- placementGroupDecision: ZillowPropertyPlacementGroupDecision;
1062
- }
1063
- export interface ZillowPropertyRentalsSidecar {
1064
- rentalsSidecarListings: ZillowPropertyRentalsSidecarListing[];
1065
- }
1066
- export interface ZillowPropertyRentalsSidecarListing {
1067
- tourSchedulingPayload: ZillowPropertyTourSchedulingPayload;
1068
- }
1069
719
  export interface ZillowPropertyResoFacts {
720
+ listingId?: unknown | null;
721
+ additionalParcelsDescription?: unknown | null;
722
+ zoningDescription?: unknown | null;
723
+ hoaFeeTotal?: string | null;
724
+ pricePerSquareFoot?: number | null;
725
+ storiesTotal?: unknown | null;
726
+ totalActualRent?: unknown | null;
727
+ canRaiseHorses?: boolean;
728
+ developmentStatus?: unknown | null;
729
+ hasPetsAllowed?: boolean | null;
730
+ availabilityDate?: number | null;
731
+ landLeaseExpirationDate?: unknown | null;
732
+ offerReviewDate?: unknown | null;
733
+ onMarketDate?: number;
734
+ otherFacts?: unknown[];
735
+ bedrooms: number | null;
736
+ bathrooms: number | null;
737
+ bathroomsFull: number | null;
738
+ bathroomsThreeQuarter: number | null;
739
+ bathroomsHalf: number | null;
740
+ bathroomsOneQuarter: number | null;
741
+ bathroomsPartial?: unknown | null;
742
+ homeType: string;
743
+ lotSize?: string | null;
744
+ yearBuilt?: number | null;
745
+ propertySubType?: string[] | null;
746
+ carportParkingCapacity?: number | null;
747
+ coveredParkingCapacity?: number | null;
748
+ garageParkingCapacity?: number | null;
749
+ hasAttachedGarage?: boolean | null;
750
+ hasCarport?: boolean | null;
751
+ hasGarage?: boolean;
752
+ hasOpenParking?: boolean | null;
753
+ openParkingCapacity?: number | null;
754
+ parkingCapacity?: number;
755
+ parkingFeatures?: string[];
1070
756
  aboveGradeFinishedArea?: unknown | null;
1071
757
  accessibilityFeatures?: unknown | null;
1072
758
  additionalFeeInfo?: unknown | null;
1073
- additionalParcelsDescription?: unknown | null;
1074
- allowedPets?: string[] | null;
1075
- appliances?: string[] | null;
1076
759
  architecturalStyle?: string | null;
1077
- associationAmenities?: unknown | null;
760
+ associations?: unknown[];
1078
761
  associationFee?: unknown | null;
762
+ associationAmenities?: unknown | null;
1079
763
  associationFee2?: unknown | null;
1080
764
  associationFeeIncludes?: unknown | null;
1081
765
  associationName?: unknown | null;
1082
766
  associationName2?: unknown | null;
1083
767
  associationPhone?: unknown | null;
1084
768
  associationPhone2?: unknown | null;
1085
- associations?: unknown[];
769
+ basementYN?: unknown | null;
770
+ buildingFeatures?: unknown | null;
771
+ buildingName?: string | null;
772
+ appliances?: string[] | null;
1086
773
  atAGlanceFacts?: ZillowPropertyAtAGlanceFact[];
1087
774
  attic?: unknown | null;
1088
- availabilityDate?: number | null;
1089
775
  basement?: unknown | null;
1090
- basementYN?: unknown | null;
1091
- bathrooms: number | null;
1092
776
  bathroomsFloat?: number;
1093
- bathroomsFull: number | null;
1094
- bathroomsHalf: number | null;
1095
- bathroomsOneQuarter: number | null;
1096
- bathroomsPartial?: unknown | null;
1097
- bathroomsThreeQuarter: number | null;
1098
- bedrooms: number | null;
1099
777
  belowGradeFinishedArea?: unknown | null;
1100
778
  bodyType?: unknown | null;
1101
779
  builderModel?: unknown | null;
1102
780
  builderName?: string | null;
1103
781
  buildingArea?: unknown | null;
1104
782
  buildingAreaSource?: unknown | null;
1105
- buildingFeatures?: unknown | null;
1106
- buildingName?: string | null;
1107
- canRaiseHorses?: boolean;
1108
- carportParkingCapacity?: number | null;
1109
783
  cityRegion?: string;
1110
784
  commonWalls?: unknown | null;
1111
785
  communityFeatures?: unknown | null;
@@ -1113,10 +787,8 @@ export interface ZillowPropertyResoFacts {
1113
787
  constructionMaterials?: string[];
1114
788
  contingency?: unknown | null;
1115
789
  cooling?: unknown | null;
1116
- coveredParkingCapacity?: number | null;
1117
790
  cropsIncludedYN?: unknown | null;
1118
791
  cumulativeDaysOnMarket?: unknown | null;
1119
- developmentStatus?: unknown | null;
1120
792
  doorFeatures?: unknown | null;
1121
793
  electric?: unknown | null;
1122
794
  elevation?: unknown | null;
@@ -1135,7 +807,6 @@ export interface ZillowPropertyResoFacts {
1135
807
  frontageLength?: unknown | null;
1136
808
  frontageType?: unknown | null;
1137
809
  furnished?: boolean;
1138
- garageParkingCapacity?: number | null;
1139
810
  gas?: unknown | null;
1140
811
  greenBuildingVerificationType?: unknown | null;
1141
812
  greenEnergyEfficient?: unknown | null;
@@ -1145,29 +816,22 @@ export interface ZillowPropertyResoFacts {
1145
816
  greenWaterConservation?: unknown | null;
1146
817
  hasAdditionalParcels?: boolean;
1147
818
  hasAssociation?: unknown | null;
1148
- hasAttachedGarage?: boolean | null;
1149
819
  hasAttachedProperty?: boolean;
1150
- hasCarport?: boolean | null;
1151
820
  hasCooling?: boolean | null;
1152
821
  hasElectricOnProperty?: unknown | null;
1153
822
  hasFireplace?: boolean | null;
1154
- hasGarage?: boolean;
1155
823
  hasHeating?: boolean | null;
1156
824
  hasHomeWarranty?: boolean;
1157
825
  hasLandLease?: boolean;
1158
- hasOpenParking?: boolean | null;
1159
- hasPetsAllowed?: boolean | null;
1160
- hasPrivatePool?: unknown | null;
1161
826
  hasRentControl?: unknown | null;
1162
827
  hasSpa?: boolean;
828
+ hasPrivatePool?: unknown | null;
1163
829
  hasView?: boolean;
1164
830
  hasWaterfrontView?: unknown | null;
1165
831
  heating?: string[] | null;
1166
832
  highSchool?: unknown | null;
1167
833
  highSchoolDistrict?: unknown | null;
1168
834
  hoaFee?: unknown | null;
1169
- hoaFeeTotal?: string | null;
1170
- homeType: string;
1171
835
  horseAmenities?: unknown | null;
1172
836
  horseYN?: unknown | null;
1173
837
  inclusions?: unknown | null;
@@ -1178,163 +842,333 @@ export interface ZillowPropertyResoFacts {
1178
842
  isNewConstruction?: unknown | null;
1179
843
  isSeniorCommunity?: unknown | null;
1180
844
  landLeaseAmount?: unknown | null;
1181
- landLeaseExpirationDate?: unknown | null;
1182
845
  laundryFeatures?: string[] | null;
1183
846
  leaseTerm?: string;
1184
847
  levels?: unknown | null;
1185
- listAOR?: unknown | null;
1186
- listingId?: unknown | null;
1187
848
  listingTerms?: unknown | null;
849
+ lotFeatures?: unknown | null;
850
+ lotSizeDimensions?: unknown | null;
1188
851
  livingArea?: string;
1189
852
  livingAreaRange?: unknown | null;
1190
853
  livingAreaRangeUnits?: unknown | null;
1191
854
  livingQuarters?: unknown[];
1192
- lotFeatures?: unknown | null;
1193
- lotSize?: string | null;
1194
- lotSizeDimensions?: unknown | null;
1195
855
  mainLevelBathrooms?: unknown | null;
1196
856
  mainLevelBedrooms?: unknown | null;
1197
857
  marketingType?: string | null;
1198
- media?: unknown[];
1199
858
  middleOrJuniorSchool?: unknown | null;
1200
859
  middleOrJuniorSchoolDistrict?: unknown | null;
1201
860
  municipality?: unknown | null;
1202
861
  numberOfUnitsInCommunity?: unknown | null;
1203
862
  numberOfUnitsVacant?: unknown | null;
1204
- offerReviewDate?: unknown | null;
1205
- onMarketDate?: number;
1206
- openParkingCapacity?: number | null;
1207
863
  otherEquipment?: unknown | null;
1208
- otherFacts?: unknown[];
1209
864
  otherParking?: string[];
1210
865
  otherStructures?: string[] | null;
1211
866
  ownership?: unknown | null;
1212
867
  ownershipType?: unknown | null;
1213
868
  parcelNumber?: string | null;
1214
869
  parkName?: unknown | null;
1215
- parkingCapacity?: number;
1216
- parkingFeatures?: string[];
1217
870
  patioAndPorchFeatures?: unknown | null;
1218
871
  petsMaxWeight?: unknown | null;
1219
872
  poolFeatures?: unknown | null;
1220
- pricePerSquareFoot?: number | null;
1221
873
  propertyCondition?: unknown | null;
1222
- propertySubType?: string[] | null;
1223
874
  roadSurfaceType?: unknown | null;
1224
875
  roofType?: string | null;
1225
- roomTypes?: unknown | null;
1226
876
  rooms?: unknown[];
877
+ roomTypes?: unknown | null;
1227
878
  securityFeatures?: unknown | null;
1228
879
  sewer?: unknown | null;
1229
880
  spaFeatures?: unknown | null;
1230
881
  specialListingConditions?: unknown | null;
1231
882
  stories?: number | null;
1232
883
  storiesDecimal?: number | null;
1233
- storiesTotal?: unknown | null;
1234
884
  structureType?: unknown | null;
1235
885
  subdivisionName?: unknown | null;
1236
886
  taxAnnualAmount?: number | null;
1237
887
  taxAssessedValue?: number | null;
1238
888
  tenantPays?: unknown | null;
1239
889
  topography?: unknown | null;
1240
- totalActualRent?: unknown | null;
1241
890
  utilities?: unknown | null;
1242
891
  vegetation?: unknown | null;
1243
892
  view?: string[];
1244
893
  virtualTour?: unknown | null;
1245
- waterBodyName?: unknown | null;
1246
894
  waterSource?: unknown | null;
895
+ waterBodyName?: unknown | null;
896
+ waterfrontFeatures?: unknown | null;
1247
897
  waterView?: unknown | null;
1248
898
  waterViewYN?: unknown | null;
1249
- waterfrontFeatures?: unknown | null;
1250
899
  windowFeatures?: unknown | null;
1251
900
  woodedArea?: unknown | null;
1252
- yearBuilt?: number | null;
1253
901
  yearBuiltEffective?: unknown | null;
1254
902
  zoning?: unknown | null;
1255
- zoningDescription?: unknown | null;
903
+ allowedPets?: string[] | null;
904
+ listAOR?: unknown | null;
905
+ media?: unknown[];
1256
906
  }
1257
907
  export interface ZillowPropertyResponsivePhoto {
1258
- caption?: string;
1259
908
  key?: string;
1260
- mixedSources: ZillowPropertyPhotoSources;
1261
909
  photoKey?: string;
1262
- subjectType?: string | null;
910
+ caption?: string;
1263
911
  url: string;
912
+ mixedSources: ZillowPropertyPhotoSources;
913
+ subjectType?: string | null;
1264
914
  }
1265
915
  export interface ZillowPropertyRichMedia {
1266
- floorPlan?: ZillowPropertyFloorPlan[] | null;
1267
- imx?: ZillowPropertyImx[] | null;
1268
916
  virtualTour: ZillowPropertyVirtualTour[] | null;
917
+ imx?: ZillowPropertyImx[] | null;
918
+ floorPlan?: ZillowPropertyFloorPlan[] | null;
1269
919
  }
1270
920
  export interface ZillowPropertySellingSoon {
1271
921
  modelId: string;
1272
- percentile: number;
1273
922
  treatmentId: string;
923
+ percentile: number;
1274
924
  }
1275
925
  export interface ZillowPropertyStaticMap {
1276
926
  sources: ZillowPropertyStaticMapSource[];
1277
927
  }
1278
928
  export interface ZillowPropertyStaticMapSource {
1279
- isHighResolutionStaticMap: boolean | null;
1280
929
  url: string;
1281
930
  width: number;
931
+ isHighResolutionStaticMap: boolean | null;
932
+ }
933
+ export interface ZillowPropertySummary {
934
+ zpid: string;
935
+ palsId?: string;
936
+ providerListingID?: string | null;
937
+ lotId?: string;
938
+ openHouseDescription?: string;
939
+ hdpUrl?: string;
940
+ streetViewURL?: string;
941
+ streetViewMetadataURL?: string;
942
+ price?: number | null;
943
+ formattedPrice?: string;
944
+ soldPrice?: string;
945
+ zestimate?: number | null;
946
+ rentZestimate?: number | null;
947
+ priceChange?: number;
948
+ priceReduction?: string;
949
+ priceSuffix?: string;
950
+ availabilityCount?: number;
951
+ totalRequiredMonthlyMinFee?: number | null;
952
+ totalRequiredMonthlyMaxFee?: number | null;
953
+ is_price_disclosed?: boolean;
954
+ homeStatus?: string;
955
+ statusText?: string;
956
+ rawHomeStatus?: string;
957
+ marketingStatus?: string;
958
+ listing_restrictions?: ZillowListingRestrictions;
959
+ dateSold?: number;
960
+ comingSoonOnMarketDate?: unknown | null;
961
+ datePriceChanged?: number;
962
+ openHouseStartDate?: string;
963
+ openHouseEndDate?: string;
964
+ availabilityDate?: string;
965
+ attributionInfo?: ZillowPropertyAttributionInfo;
966
+ parentRegion?: unknown;
967
+ address: ZillowSummaryAddress;
968
+ latitude?: number | null;
969
+ longitude?: number | null;
970
+ currency?: string;
971
+ currencySymbol?: string;
972
+ bedrooms?: number | null;
973
+ bathrooms?: number | null;
974
+ livingArea?: number | null;
975
+ livingAreaValue?: number | null;
976
+ livingAreaUnits?: string | null;
977
+ livingAreaUnitsShort?: string | null;
978
+ lotSize?: number | null;
979
+ lotAreaValue?: number | null;
980
+ lotAreaUnits?: string;
981
+ lotAreaString?: string;
982
+ homeType?: string;
983
+ taxAssessedValue?: number;
984
+ daysOnZillow?: number;
985
+ timeOnZillow?: number;
986
+ listing_sub_type?: ZillowListingFlags;
987
+ brokerName?: string;
988
+ state?: string;
989
+ country?: string;
990
+ newConstructionType?: string | null;
991
+ contingentListingType?: unknown | null;
992
+ marketingTreatments?: string[] | null;
993
+ isUnmappable?: boolean;
994
+ isPreforeclosureAuction?: boolean;
995
+ isNonOwnerOccupied?: boolean;
996
+ isPremierBuilder?: boolean;
997
+ isZillowOwned?: boolean;
998
+ isShowcaseListing?: boolean | null;
999
+ isFeaturedListing?: boolean;
1000
+ isPaidBuilderNewConstruction?: boolean;
1001
+ isContactable?: boolean;
1002
+ isInstantTourEnabled?: boolean;
1003
+ hasImage?: boolean;
1004
+ has3DModel?: boolean;
1005
+ hasVideo?: boolean;
1006
+ hasAdditionalAttributions?: boolean;
1007
+ hasOpenHouse?: boolean;
1008
+ openHouse?: string;
1009
+ open_house_info?: ZillowListingOpenHouseInfo;
1010
+ highlights?: ZillowPropertyHighlight[];
1011
+ factsAndFeatures?: ZillowListingFactsAndFeatures;
1012
+ resoFacts?: ZillowPropertyNearbyHomeResoFacts;
1013
+ units?: ZillowListingUnit[];
1014
+ rooms?: unknown[];
1015
+ buildingName?: string;
1016
+ builderName?: string;
1017
+ isBuilding?: boolean;
1018
+ listPriceIncludesRequiredMonthlyFees?: boolean | null;
1019
+ minBaseRent?: number;
1020
+ maxBaseRent?: number;
1021
+ baseRent?: number | null;
1022
+ group_type?: string;
1023
+ unit?: string;
1024
+ isRentalWithBasePrice?: boolean;
1025
+ photos?: ZillowSummaryPhoto[];
1026
+ photo_gallery?: ZillowPhotoGallery;
1282
1027
  }
1283
1028
  export interface ZillowPropertyThirdPartyVirtualTour {
1284
- approved: boolean;
1029
+ providerKey: string | null;
1285
1030
  externalUrl?: string | null;
1286
1031
  lightboxUrl: string | null;
1287
- providerKey: string | null;
1288
1032
  staticUrl?: string | null;
1033
+ approved: boolean;
1289
1034
  }
1290
1035
  export interface ZillowPropertyTourAvailability {
1291
- date: string;
1292
1036
  status: string;
1037
+ date: string;
1293
1038
  times: string[];
1294
1039
  }
1295
1040
  export interface ZillowPropertyTourEligibility {
1296
1041
  isPropertyTourEligible: boolean;
1297
1042
  propertyTourOptions: ZillowPropertyPropertyTourOptions;
1298
1043
  }
1299
- export interface ZillowPropertyTourSchedulingPayload {
1300
- inPersonAvailabilityExists: boolean | null;
1301
- inPersonTourEnabled: boolean;
1302
- instantTourConfigurations: unknown[];
1303
- liveVideoTourEnabled: boolean;
1304
- selfGuidedTourEnabled: boolean;
1305
- }
1306
- export interface ZillowPropertyURLExperience {
1307
- authAssuranceLevel: string;
1308
- ctaUrl: string;
1309
- }
1310
- export interface ZillowPropertyUsedInputs {
1311
- creditScore: ZillowPropertyCreditScore;
1312
- downPaymentAmount: number;
1313
- downPaymentPercent: number;
1314
- fromFinancialProfile: boolean;
1315
- isDownpaymentPreferencePercent: boolean;
1316
- loan: ZillowPropertyLoan | null;
1317
- }
1318
1044
  export interface ZillowPropertyVRModel {
1319
- revisionId: string | null;
1320
1045
  vrModelGuid: string | null;
1046
+ revisionId: string | null;
1321
1047
  }
1322
1048
  export interface ZillowPropertyVirtualTour {
1323
1049
  revisionId: string;
1324
- viewerUrl: string;
1325
1050
  vrModelGuid?: string;
1051
+ viewerUrl: string;
1052
+ }
1053
+ export interface ZillowRecordsAttributionInfo {
1054
+ mlsId: string | null;
1055
+ lastChecked: string | null;
1056
+ lastUpdated: string | null;
1057
+ agentName: string | null;
1058
+ agentLicenseNumber: string | null;
1059
+ agentPhoneNumber: string | null;
1060
+ agentEmail: string | null;
1061
+ coAgentName: string | null;
1062
+ coAgentLicenseNumber: string | null;
1063
+ coAgentNumber: string | null;
1064
+ buyerAgentName: string | null;
1065
+ buyerAgentMemberStateLicense: string | null;
1066
+ buyerBrokerageName: string | null;
1067
+ brokerName: string | null;
1068
+ brokerPhoneNumber: string | null;
1069
+ listingAgents: ZillowListingAgentAttribution[] | null;
1070
+ listingOffices: ZillowListingOfficeAttribution[] | null;
1071
+ listingAgreement: string | null;
1072
+ mlsName: string | null;
1073
+ mlsDisclaimer: string | null;
1074
+ notMLSSourcedListing: boolean | null;
1075
+ providerLogo: string | null;
1326
1076
  }
1327
1077
  export interface ZillowRegion {
1328
1078
  id: number;
1329
1079
  name: string;
1080
+ bounds?: ZillowRegionBounds;
1330
1081
  type: ZillowRegionType;
1331
1082
  }
1083
+ export interface ZillowRegionBounds {
1084
+ north: number;
1085
+ south: number;
1086
+ east: number;
1087
+ west: number;
1088
+ }
1332
1089
  export type ZillowRegionType = "state" | "county" | "city" | "zipcode" | "neighborhood" | "borough";
1090
+ export interface ZillowRelatedProperties {
1091
+ name: string;
1092
+ items: ZillowPropertySummary[];
1093
+ }
1094
+ export interface ZillowRentalCostsAndFees {
1095
+ leaseDuration: number | null;
1096
+ feeGroups: ZillowRentalFeeGroup[];
1097
+ }
1098
+ export interface ZillowRentalFee {
1099
+ type: string;
1100
+ zillowDisclaimers: string[] | null;
1101
+ }
1102
+ export interface ZillowRentalFeeGroup {
1103
+ fees: ZillowRentalFee[];
1104
+ }
1105
+ export interface ZillowSchool {
1106
+ schoolId?: number;
1107
+ districtId?: number;
1108
+ name: string;
1109
+ link: string;
1110
+ rating: number | null;
1111
+ themedRatings?: ZillowSchoolThemedRating[];
1112
+ isAssigned: boolean;
1113
+ level?: string;
1114
+ grades: string;
1115
+ type?: string;
1116
+ distance: number;
1117
+ enrollment?: number | null;
1118
+ studentTeacherRatio?: number | null;
1119
+ studentCounselorRatio?: number | null;
1120
+ percentageOfFullTimeTeachersWhoAreCertified?: number | null;
1121
+ districtName?: string;
1122
+ }
1123
+ export interface ZillowSchoolAssignmentFacts {
1124
+ elementarySchool: string | null;
1125
+ elementarySchoolDistrict: string | null;
1126
+ middleOrJuniorSchool: string | null;
1127
+ middleOrJuniorSchoolDistrict: string | null;
1128
+ highSchool: string | null;
1129
+ highSchoolDistrict: string | null;
1130
+ }
1131
+ export interface ZillowSchoolThemedRating {
1132
+ name: string;
1133
+ rating: number;
1134
+ type: string;
1135
+ }
1333
1136
  export interface ZillowSearchPage {
1334
- items: ZillowListing[];
1335
- pagination: ZillowCursorPagination;
1137
+ items: ZillowPropertySummary[];
1336
1138
  region: ZillowRegion;
1337
1139
  total_results: number;
1140
+ total_pages: number;
1141
+ result_contexts?: ZillowSearchResultContext[] | null;
1142
+ pagination: ZillowCursorPagination;
1143
+ }
1144
+ export interface ZillowSearchResultContext {
1145
+ context_id: number;
1146
+ text: string | null;
1147
+ image_url: string | null;
1338
1148
  }
1339
1149
  export type ZillowSearchSort = "relevance" | "newest" | "price_low" | "price_high" | "beds" | "baths" | "sqft" | "lot_size";
1150
+ export interface ZillowSummaryAddress {
1151
+ display?: string;
1152
+ streetAddress?: string;
1153
+ city?: string;
1154
+ state?: string;
1155
+ zipcode?: string;
1156
+ isUndisclosedAddress?: boolean;
1157
+ }
1158
+ export interface ZillowSummaryPhoto {
1159
+ url: string;
1160
+ }
1161
+ export interface ZillowTaxHistoryEntry {
1162
+ time: number;
1163
+ taxPaid: number | null;
1164
+ taxIncreaseRate: number;
1165
+ value: number | null;
1166
+ valueIncreaseRate: number;
1167
+ }
1168
+ export interface ZillowTourScheduling {
1169
+ inPersonTourEnabled: boolean;
1170
+ liveVideoTourEnabled: boolean;
1171
+ selfGuidedTourEnabled: boolean;
1172
+ inPersonAvailabilityExists: boolean | null;
1173
+ }
1340
1174
  //# sourceMappingURL=types.d.ts.map