
Idealista.com
7 days trial then $22.00/month - No credit card required now

Idealista.com
7 days trial then $22.00/month - No credit card required now
Are you looking for a property in Spain or Portugal? With idealista it's easier, with more than 1.400.000 listings of flats and houses for sale or rent. Advertise your home privately for free.
You can access the Idealista.com 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": "BL9J8bQpUWXfdmlhE"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/lukass~idealista-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-lukass-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/lukass~idealista-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-lukass-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/lukass~idealista-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-lukass-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 "proxy"
135 ],
136 "properties": {
137 "district": {
138 "title": "Location",
139 "type": "string",
140 "description": "Where you want to look for the real estates, e.g. Madrid. For further filtering you can use the URL below."
141 },
142 "country": {
143 "title": "Country",
144 "enum": [
145 "es",
146 "pt",
147 "it"
148 ],
149 "type": "string",
150 "description": "Select your country",
151 "default": "es"
152 },
153 "maxItems": {
154 "title": "Limit the number of items",
155 "type": "integer",
156 "description": "How many real estates do you want to get. If you don't want to get all items, because you maybe only want to test the solution, or want to know what are the new real estates on the market."
157 },
158 "endPage": {
159 "title": "Limit of scraped pages",
160 "type": "integer",
161 "description": "Scrape only limit pages"
162 },
163 "startUrl": {
164 "title": "URL you want to scrape",
165 "type": "array",
166 "description": "URL(s) of places or pages what will be scraped. For example https://www.idealista.com/venta-viviendas/madrid/centro/con-de-tres-dormitorios,de-cuatro-cinco-habitaciones-o-mas,tres-banos-o-mas/",
167 "items": {
168 "type": "object",
169 "required": [
170 "url"
171 ],
172 "properties": {
173 "url": {
174 "type": "string",
175 "title": "URL of a web page",
176 "format": "uri"
177 }
178 }
179 }
180 },
181 "proxy": {
182 "title": "Proxy configuration",
183 "type": "object",
184 "description": "Select proxies to be used by your crawler.",
185 "default": {
186 "useApifyProxy": true,
187 "apifyProxyGroups": [
188 "RESIDENTIAL"
189 ]
190 }
191 }
192 }
193 },
194 "runsResponseSchema": {
195 "type": "object",
196 "properties": {
197 "data": {
198 "type": "object",
199 "properties": {
200 "id": {
201 "type": "string"
202 },
203 "actId": {
204 "type": "string"
205 },
206 "userId": {
207 "type": "string"
208 },
209 "startedAt": {
210 "type": "string",
211 "format": "date-time",
212 "example": "2025-01-08T00:00:00.000Z"
213 },
214 "finishedAt": {
215 "type": "string",
216 "format": "date-time",
217 "example": "2025-01-08T00:00:00.000Z"
218 },
219 "status": {
220 "type": "string",
221 "example": "READY"
222 },
223 "meta": {
224 "type": "object",
225 "properties": {
226 "origin": {
227 "type": "string",
228 "example": "API"
229 },
230 "userAgent": {
231 "type": "string"
232 }
233 }
234 },
235 "stats": {
236 "type": "object",
237 "properties": {
238 "inputBodyLen": {
239 "type": "integer",
240 "example": 2000
241 },
242 "rebootCount": {
243 "type": "integer",
244 "example": 0
245 },
246 "restartCount": {
247 "type": "integer",
248 "example": 0
249 },
250 "resurrectCount": {
251 "type": "integer",
252 "example": 0
253 },
254 "computeUnits": {
255 "type": "integer",
256 "example": 0
257 }
258 }
259 },
260 "options": {
261 "type": "object",
262 "properties": {
263 "build": {
264 "type": "string",
265 "example": "latest"
266 },
267 "timeoutSecs": {
268 "type": "integer",
269 "example": 300
270 },
271 "memoryMbytes": {
272 "type": "integer",
273 "example": 1024
274 },
275 "diskMbytes": {
276 "type": "integer",
277 "example": 2048
278 }
279 }
280 },
281 "buildId": {
282 "type": "string"
283 },
284 "defaultKeyValueStoreId": {
285 "type": "string"
286 },
287 "defaultDatasetId": {
288 "type": "string"
289 },
290 "defaultRequestQueueId": {
291 "type": "string"
292 },
293 "buildNumber": {
294 "type": "string",
295 "example": "1.0.0"
296 },
297 "containerUrl": {
298 "type": "string"
299 },
300 "usage": {
301 "type": "object",
302 "properties": {
303 "ACTOR_COMPUTE_UNITS": {
304 "type": "integer",
305 "example": 0
306 },
307 "DATASET_READS": {
308 "type": "integer",
309 "example": 0
310 },
311 "DATASET_WRITES": {
312 "type": "integer",
313 "example": 0
314 },
315 "KEY_VALUE_STORE_READS": {
316 "type": "integer",
317 "example": 0
318 },
319 "KEY_VALUE_STORE_WRITES": {
320 "type": "integer",
321 "example": 1
322 },
323 "KEY_VALUE_STORE_LISTS": {
324 "type": "integer",
325 "example": 0
326 },
327 "REQUEST_QUEUE_READS": {
328 "type": "integer",
329 "example": 0
330 },
331 "REQUEST_QUEUE_WRITES": {
332 "type": "integer",
333 "example": 0
334 },
335 "DATA_TRANSFER_INTERNAL_GBYTES": {
336 "type": "integer",
337 "example": 0
338 },
339 "DATA_TRANSFER_EXTERNAL_GBYTES": {
340 "type": "integer",
341 "example": 0
342 },
343 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
344 "type": "integer",
345 "example": 0
346 },
347 "PROXY_SERPS": {
348 "type": "integer",
349 "example": 0
350 }
351 }
352 },
353 "usageTotalUsd": {
354 "type": "number",
355 "example": 0.00005
356 },
357 "usageUsd": {
358 "type": "object",
359 "properties": {
360 "ACTOR_COMPUTE_UNITS": {
361 "type": "integer",
362 "example": 0
363 },
364 "DATASET_READS": {
365 "type": "integer",
366 "example": 0
367 },
368 "DATASET_WRITES": {
369 "type": "integer",
370 "example": 0
371 },
372 "KEY_VALUE_STORE_READS": {
373 "type": "integer",
374 "example": 0
375 },
376 "KEY_VALUE_STORE_WRITES": {
377 "type": "number",
378 "example": 0.00005
379 },
380 "KEY_VALUE_STORE_LISTS": {
381 "type": "integer",
382 "example": 0
383 },
384 "REQUEST_QUEUE_READS": {
385 "type": "integer",
386 "example": 0
387 },
388 "REQUEST_QUEUE_WRITES": {
389 "type": "integer",
390 "example": 0
391 },
392 "DATA_TRANSFER_INTERNAL_GBYTES": {
393 "type": "integer",
394 "example": 0
395 },
396 "DATA_TRANSFER_EXTERNAL_GBYTES": {
397 "type": "integer",
398 "example": 0
399 },
400 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
401 "type": "integer",
402 "example": 0
403 },
404 "PROXY_SERPS": {
405 "type": "integer",
406 "example": 0
407 }
408 }
409 }
410 }
411 }
412 }
413 }
414 }
415 }
416}
Idealista.com 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.com 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:
Actor Metrics
40 monthly users
-
5 bookmarks
>99% runs succeeded
Created in May 2022
Modified 4 months ago