Idealista-scraper
Try for free
No credit card required
Go to Store
You can access the Idealista-scraper 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": "dCSbj4s0NVxudlThx"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/axlymxp~idealista-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-axlymxp-idealista-scraper",
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/axlymxp~idealista-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-axlymxp-idealista-scraper",
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/axlymxp~idealista-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-axlymxp-idealista-scraper",
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 "function",
135 "country",
136 "propertyType",
137 "operation"
138 ],
139 "properties": {
140 "function": {
141 "title": "Function",
142 "enum": [
143 "search_properties",
144 "get_locations"
145 ],
146 "type": "string",
147 "description": "Function to execute",
148 "default": "search_properties"
149 },
150 "country": {
151 "title": "Country Code",
152 "enum": [
153 "es",
154 "it",
155 "pt"
156 ],
157 "type": "string",
158 "description": "Country code (es: Spain, it: Italy, pt: Portugal)",
159 "default": "es"
160 },
161 "maxItems": {
162 "title": "Maximum Items",
163 "minimum": 1,
164 "maximum": 50,
165 "type": "integer",
166 "description": "Maximum number of items per page",
167 "default": 30
168 },
169 "locationName": {
170 "title": "Location Name",
171 "type": "string",
172 "description": "Name of the location to search in",
173 "default": "Isla de la Cartuja, Sevilla"
174 },
175 "distance": {
176 "title": "Distance",
177 "minimum": 0,
178 "type": "integer",
179 "description": "Search radius in kilometers",
180 "default": 0
181 },
182 "locationId": {
183 "title": "Location ID",
184 "type": "string",
185 "description": "Idealista location ID"
186 },
187 "propertyType": {
188 "title": "Property Type",
189 "enum": [
190 "newDevelopments",
191 "homes",
192 "offices",
193 "premises",
194 "transfers",
195 "garages",
196 "lands",
197 "storageRooms",
198 "buildings"
199 ],
200 "type": "string",
201 "description": "Type of property to search for",
202 "default": "homes"
203 },
204 "sort": {
205 "title": "Sort Direction",
206 "enum": [
207 "asc",
208 "desc"
209 ],
210 "type": "string",
211 "description": "Sort direction for results",
212 "default": "desc"
213 },
214 "operation": {
215 "title": "Operation Type",
216 "enum": [
217 "sale",
218 "rent"
219 ],
220 "type": "string",
221 "description": "Type of operation",
222 "default": "sale"
223 },
224 "numPage": {
225 "title": "Page Number",
226 "minimum": 1,
227 "type": "integer",
228 "description": "Page number to retrieve",
229 "default": 1
230 },
231 "order": {
232 "title": "Order By",
233 "enum": [
234 "weigh",
235 "price",
236 "publicationDate",
237 "priceDown",
238 "ratioeurm2",
239 "size"
240 ],
241 "type": "string",
242 "description": "Field to order results by",
243 "default": "weigh"
244 },
245 "locale": {
246 "title": "Language",
247 "enum": [
248 "en",
249 "es",
250 "it",
251 "pt"
252 ],
253 "type": "string",
254 "description": "Language for results",
255 "default": "en"
256 },
257 "quality": {
258 "title": "Image Quality",
259 "enum": [
260 "high",
261 "medium",
262 "low"
263 ],
264 "type": "string",
265 "description": "Quality of images",
266 "default": "high"
267 },
268 "gallery": {
269 "title": "Include Gallery",
270 "enum": [
271 "true",
272 "false"
273 ],
274 "type": "string",
275 "description": "Whether to include image gallery",
276 "default": "true"
277 },
278 "prefix": {
279 "title": "Location Prefix",
280 "type": "string",
281 "description": "Prefix for location search (required for get_locations function)"
282 }
283 }
284 },
285 "runsResponseSchema": {
286 "type": "object",
287 "properties": {
288 "data": {
289 "type": "object",
290 "properties": {
291 "id": {
292 "type": "string"
293 },
294 "actId": {
295 "type": "string"
296 },
297 "userId": {
298 "type": "string"
299 },
300 "startedAt": {
301 "type": "string",
302 "format": "date-time",
303 "example": "2025-01-08T00:00:00.000Z"
304 },
305 "finishedAt": {
306 "type": "string",
307 "format": "date-time",
308 "example": "2025-01-08T00:00:00.000Z"
309 },
310 "status": {
311 "type": "string",
312 "example": "READY"
313 },
314 "meta": {
315 "type": "object",
316 "properties": {
317 "origin": {
318 "type": "string",
319 "example": "API"
320 },
321 "userAgent": {
322 "type": "string"
323 }
324 }
325 },
326 "stats": {
327 "type": "object",
328 "properties": {
329 "inputBodyLen": {
330 "type": "integer",
331 "example": 2000
332 },
333 "rebootCount": {
334 "type": "integer",
335 "example": 0
336 },
337 "restartCount": {
338 "type": "integer",
339 "example": 0
340 },
341 "resurrectCount": {
342 "type": "integer",
343 "example": 0
344 },
345 "computeUnits": {
346 "type": "integer",
347 "example": 0
348 }
349 }
350 },
351 "options": {
352 "type": "object",
353 "properties": {
354 "build": {
355 "type": "string",
356 "example": "latest"
357 },
358 "timeoutSecs": {
359 "type": "integer",
360 "example": 300
361 },
362 "memoryMbytes": {
363 "type": "integer",
364 "example": 1024
365 },
366 "diskMbytes": {
367 "type": "integer",
368 "example": 2048
369 }
370 }
371 },
372 "buildId": {
373 "type": "string"
374 },
375 "defaultKeyValueStoreId": {
376 "type": "string"
377 },
378 "defaultDatasetId": {
379 "type": "string"
380 },
381 "defaultRequestQueueId": {
382 "type": "string"
383 },
384 "buildNumber": {
385 "type": "string",
386 "example": "1.0.0"
387 },
388 "containerUrl": {
389 "type": "string"
390 },
391 "usage": {
392 "type": "object",
393 "properties": {
394 "ACTOR_COMPUTE_UNITS": {
395 "type": "integer",
396 "example": 0
397 },
398 "DATASET_READS": {
399 "type": "integer",
400 "example": 0
401 },
402 "DATASET_WRITES": {
403 "type": "integer",
404 "example": 0
405 },
406 "KEY_VALUE_STORE_READS": {
407 "type": "integer",
408 "example": 0
409 },
410 "KEY_VALUE_STORE_WRITES": {
411 "type": "integer",
412 "example": 1
413 },
414 "KEY_VALUE_STORE_LISTS": {
415 "type": "integer",
416 "example": 0
417 },
418 "REQUEST_QUEUE_READS": {
419 "type": "integer",
420 "example": 0
421 },
422 "REQUEST_QUEUE_WRITES": {
423 "type": "integer",
424 "example": 0
425 },
426 "DATA_TRANSFER_INTERNAL_GBYTES": {
427 "type": "integer",
428 "example": 0
429 },
430 "DATA_TRANSFER_EXTERNAL_GBYTES": {
431 "type": "integer",
432 "example": 0
433 },
434 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
435 "type": "integer",
436 "example": 0
437 },
438 "PROXY_SERPS": {
439 "type": "integer",
440 "example": 0
441 }
442 }
443 },
444 "usageTotalUsd": {
445 "type": "number",
446 "example": 0.00005
447 },
448 "usageUsd": {
449 "type": "object",
450 "properties": {
451 "ACTOR_COMPUTE_UNITS": {
452 "type": "integer",
453 "example": 0
454 },
455 "DATASET_READS": {
456 "type": "integer",
457 "example": 0
458 },
459 "DATASET_WRITES": {
460 "type": "integer",
461 "example": 0
462 },
463 "KEY_VALUE_STORE_READS": {
464 "type": "integer",
465 "example": 0
466 },
467 "KEY_VALUE_STORE_WRITES": {
468 "type": "number",
469 "example": 0.00005
470 },
471 "KEY_VALUE_STORE_LISTS": {
472 "type": "integer",
473 "example": 0
474 },
475 "REQUEST_QUEUE_READS": {
476 "type": "integer",
477 "example": 0
478 },
479 "REQUEST_QUEUE_WRITES": {
480 "type": "integer",
481 "example": 0
482 },
483 "DATA_TRANSFER_INTERNAL_GBYTES": {
484 "type": "integer",
485 "example": 0
486 },
487 "DATA_TRANSFER_EXTERNAL_GBYTES": {
488 "type": "integer",
489 "example": 0
490 },
491 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
492 "type": "integer",
493 "example": 0
494 },
495 "PROXY_SERPS": {
496 "type": "integer",
497 "example": 0
498 }
499 }
500 }
501 }
502 }
503 }
504 }
505 }
506 }
507}Idealista-scraper 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 Idealista-scraper 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:
axly
