{ "openapi": "3.0.1", "info": { "title": "Idealista.com", "description": "Are you looking for a property in Spain or Portugal or Italy? With idealista it's easier, with more than 1.400.000 listings of flats and houses for sale or rent.", "version": "0.0", "x-build-id": "FTdkrviTkLoWl27oC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukass~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukass-idealista-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lukass~idealista-scraper/runs": { "post": { "operationId": "runs-sync-lukass-idealista-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lukass~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-lukass-idealista-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "proxy", "operation", "country" ], "properties": { "district": { "title": "Location", "type": "string", "description": "Where you want to look for the real estates, e.g. Madrid. For further filtering you can use the URL below." }, "country": { "title": "Country", "enum": [ "es", "pt", "it" ], "type": "string", "description": "Select your country", "default": "es" }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Select Listing sale or rent properties", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "homes", "newDevelopments", "bedrooms", "offices", "premises", "transfers", "garages", "lands", "storageRooms", "buildings" ], "type": "string", "description": "Select type of property", "default": "homes" }, "maxItems": { "title": "Limit the number of items", "type": "integer", "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." }, "endPage": { "title": "Limit of scraped pages", "type": "integer", "description": "Scrape only limit pages" }, "startUrl": { "title": "URL you want to scrape", "type": "array", "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/", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "minSize": { "title": "Min size", "enum": [ "any", "40", "50", "60", "70", "80", "90", "100", "110", "120", "130", "140", "150", "160", "170", "180", "190", "200", "220", "240", "260", "280", "300", "320", "340", "360", "380", "400", "420", "440", "460", "480", "500", "550", "600", "650", "700", "800", "900", "nolimit" ], "type": "string", "description": "Select min size of property", "default": "any" }, "maxSize": { "title": "Max size", "enum": [ "any", "40", "50", "60", "70", "80", "90", "100", "110", "120", "130", "140", "150", "160", "170", "180", "190", "200", "220", "240", "260", "280", "300", "320", "340", "360", "380", "400", "420", "440", "460", "480", "500", "550", "600", "650", "700", "800", "900", "nolimit" ], "type": "string", "description": "Select max size of property", "default": "any" }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "[\"studio\",\"1\",\"2\",\"3\",\"4\"] (leave empty for any)" }, "bathrooms": { "title": "Bathrooms", "type": "array", "description": "[\"1\",\"2\",\"3\"] (leave empty for any)" }, "homeType": { "title": "Type of home", "type": "array", "description": "[\"flat\",\"penthouse\",\"duplex\",\"detachedHouse\",\"semiDetachedHouse\",\"terracedHouse\",\"countryHouse\",\"apartment\",\"villa\",\"loft\"] (leave empty for any)" }, "condition": { "title": "Condition", "type": "array", "description": "[\"newDevelopment\",\"good\",\"renew\"] (leave empty for any)" }, "propertyStatus": { "title": "Current status of the property", "type": "array", "description": "[\"bareOwnership\",\"tenanted\",\"illegallyOccupied\",\"free\"] (leave empty for any)" }, "floorHeights": { "title": "Floor", "type": "array", "description": "[\"topFloor\",\"intermediateFloor\",\"groundFloor\"] (leave empty for any)" }, "features": { "title": "Features", "type": "array", "description": "[ \"airConditioning\", \"builtinWardrobes\", \"elevator\", \"exteriorDomesticSpace\", \"balcony\", \"terrance\", \"exterior\", \"garage\", \"garden\", \"swimmingPool\", \"storeRoom\", \"accessible\", \"luxury\"] (leave empty for any)" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }