PropertyScan AI
Try for free
30 days trial then $5.00/month - No credit card required now
Go to Store
PropertyScan AI
serafimc/propertyscan-ai
Try for free
30 days trial then $5.00/month - No credit card required now
Extract the latest real estate listings from top sites like Zillow, Realtor.com, and more. Customize your search with advanced filters to find exactly what you need!
You can access the PropertyScan AI programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "WcqZ47ZkKlTtfNxyd"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/serafimc~propertyscan-ai/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-serafimc-propertyscan-ai",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/serafimc~propertyscan-ai/runs": {
50 "post": {
51 "operationId": "runs-sync-serafimc-propertyscan-ai",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/serafimc~propertyscan-ai/run-sync": {
93 "post": {
94 "operationId": "run-sync-serafimc-propertyscan-ai",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "search_sites"
135 ],
136 "properties": {
137 "optional_keywords": {
138 "title": "Optional Keywords (OR)",
139 "type": "array",
140 "description": "Specify additional keywords to refine the search. Listings that match at least one of these keywords will be included (e.g., 'waterfront', 'garage', 'garden').",
141 "items": {
142 "type": "string"
143 }
144 },
145 "search_sites": {
146 "title": "Real Estate Platforms",
147 "type": "array",
148 "description": "Select the real estate websites to scrape property listings from. You can choose from predefined platforms or add custom sites.",
149 "items": {
150 "type": "string"
151 }
152 },
153 "operation_type": {
154 "title": "Operation Type",
155 "enum": [
156 "sale",
157 "rent",
158 "all"
159 ],
160 "type": "string",
161 "description": "Filter listings based on their transaction type: properties for sale, for rent, or both.",
162 "default": "all"
163 },
164 "property_type": {
165 "title": "Property Type",
166 "type": "array",
167 "description": "Select the types of properties to include in the search. Modify the list as needed.",
168 "items": {
169 "type": "string"
170 }
171 },
172 "price_limit": {
173 "title": "Maximum Price",
174 "minimum": 0,
175 "type": "integer",
176 "description": "Set a price cap for property listings. Use 0 to retrieve all listings regardless of price.",
177 "default": 0
178 },
179 "location": {
180 "title": "Location",
181 "type": "string",
182 "description": "Specify the geographic area for the search. This can be a city, state, ZIP code, or a specific address.",
183 "default": ""
184 },
185 "days_to_search": {
186 "title": "Date Range (Days)",
187 "minimum": 0,
188 "type": "integer",
189 "description": "Define how many days back to search for new listings (e.g., '7' to retrieve listings from the past week).",
190 "default": 1
191 },
192 "result_limit": {
193 "title": "Results Limit",
194 "minimum": 1,
195 "type": "integer",
196 "description": "Set a limit on the number of results per search. Adjust this to control data volume and processing time.",
197 "default": 10
198 }
199 }
200 },
201 "runsResponseSchema": {
202 "type": "object",
203 "properties": {
204 "data": {
205 "type": "object",
206 "properties": {
207 "id": {
208 "type": "string"
209 },
210 "actId": {
211 "type": "string"
212 },
213 "userId": {
214 "type": "string"
215 },
216 "startedAt": {
217 "type": "string",
218 "format": "date-time",
219 "example": "2025-01-08T00:00:00.000Z"
220 },
221 "finishedAt": {
222 "type": "string",
223 "format": "date-time",
224 "example": "2025-01-08T00:00:00.000Z"
225 },
226 "status": {
227 "type": "string",
228 "example": "READY"
229 },
230 "meta": {
231 "type": "object",
232 "properties": {
233 "origin": {
234 "type": "string",
235 "example": "API"
236 },
237 "userAgent": {
238 "type": "string"
239 }
240 }
241 },
242 "stats": {
243 "type": "object",
244 "properties": {
245 "inputBodyLen": {
246 "type": "integer",
247 "example": 2000
248 },
249 "rebootCount": {
250 "type": "integer",
251 "example": 0
252 },
253 "restartCount": {
254 "type": "integer",
255 "example": 0
256 },
257 "resurrectCount": {
258 "type": "integer",
259 "example": 0
260 },
261 "computeUnits": {
262 "type": "integer",
263 "example": 0
264 }
265 }
266 },
267 "options": {
268 "type": "object",
269 "properties": {
270 "build": {
271 "type": "string",
272 "example": "latest"
273 },
274 "timeoutSecs": {
275 "type": "integer",
276 "example": 300
277 },
278 "memoryMbytes": {
279 "type": "integer",
280 "example": 1024
281 },
282 "diskMbytes": {
283 "type": "integer",
284 "example": 2048
285 }
286 }
287 },
288 "buildId": {
289 "type": "string"
290 },
291 "defaultKeyValueStoreId": {
292 "type": "string"
293 },
294 "defaultDatasetId": {
295 "type": "string"
296 },
297 "defaultRequestQueueId": {
298 "type": "string"
299 },
300 "buildNumber": {
301 "type": "string",
302 "example": "1.0.0"
303 },
304 "containerUrl": {
305 "type": "string"
306 },
307 "usage": {
308 "type": "object",
309 "properties": {
310 "ACTOR_COMPUTE_UNITS": {
311 "type": "integer",
312 "example": 0
313 },
314 "DATASET_READS": {
315 "type": "integer",
316 "example": 0
317 },
318 "DATASET_WRITES": {
319 "type": "integer",
320 "example": 0
321 },
322 "KEY_VALUE_STORE_READS": {
323 "type": "integer",
324 "example": 0
325 },
326 "KEY_VALUE_STORE_WRITES": {
327 "type": "integer",
328 "example": 1
329 },
330 "KEY_VALUE_STORE_LISTS": {
331 "type": "integer",
332 "example": 0
333 },
334 "REQUEST_QUEUE_READS": {
335 "type": "integer",
336 "example": 0
337 },
338 "REQUEST_QUEUE_WRITES": {
339 "type": "integer",
340 "example": 0
341 },
342 "DATA_TRANSFER_INTERNAL_GBYTES": {
343 "type": "integer",
344 "example": 0
345 },
346 "DATA_TRANSFER_EXTERNAL_GBYTES": {
347 "type": "integer",
348 "example": 0
349 },
350 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
351 "type": "integer",
352 "example": 0
353 },
354 "PROXY_SERPS": {
355 "type": "integer",
356 "example": 0
357 }
358 }
359 },
360 "usageTotalUsd": {
361 "type": "number",
362 "example": 0.00005
363 },
364 "usageUsd": {
365 "type": "object",
366 "properties": {
367 "ACTOR_COMPUTE_UNITS": {
368 "type": "integer",
369 "example": 0
370 },
371 "DATASET_READS": {
372 "type": "integer",
373 "example": 0
374 },
375 "DATASET_WRITES": {
376 "type": "integer",
377 "example": 0
378 },
379 "KEY_VALUE_STORE_READS": {
380 "type": "integer",
381 "example": 0
382 },
383 "KEY_VALUE_STORE_WRITES": {
384 "type": "number",
385 "example": 0.00005
386 },
387 "KEY_VALUE_STORE_LISTS": {
388 "type": "integer",
389 "example": 0
390 },
391 "REQUEST_QUEUE_READS": {
392 "type": "integer",
393 "example": 0
394 },
395 "REQUEST_QUEUE_WRITES": {
396 "type": "integer",
397 "example": 0
398 },
399 "DATA_TRANSFER_INTERNAL_GBYTES": {
400 "type": "integer",
401 "example": 0
402 },
403 "DATA_TRANSFER_EXTERNAL_GBYTES": {
404 "type": "integer",
405 "example": 0
406 },
407 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
408 "type": "integer",
409 "example": 0
410 },
411 "PROXY_SERPS": {
412 "type": "integer",
413 "example": 0
414 }
415 }
416 }
417 }
418 }
419 }
420 }
421 }
422 }
423}PropertyScan AI OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for PropertyScan AI from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Developer
Marcos SerafimMaintained by Community
Actor Metrics
1 monthly user
-
1 star
>99% runs succeeded
Created in Feb 2025
Modified a day ago
Categories
