{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper", "description": "Scrape public Idealista public sale and rental property listings, prices, and sizes. Export structured properties, source URLs, IDs, and available details to CSV, JSON, or Excel for European property listing research.", "version": "0.1", "x-build-id": "TC2sYeky9VjmuKCvj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-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/mlg14~idealista-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-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/mlg14~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-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": [ "operation", "country" ], "properties": { "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Search properties for sale or rent.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "homes" ], "type": "string", "description": "Homes are supported for generated search routes. For other property types, supply exact search URLs.", "default": "homes" }, "country": { "title": "Country", "enum": [ "es", "pt", "it", "fr" ], "type": "string", "description": "Country for generated routes and listing links.", "default": "fr" }, "location": { "title": "Location", "type": "string", "description": "City name for a generated homes search route. In France, only Paris has a verified generated route; use an exact URL elsewhere.", "default": "Paris" }, "locations": { "title": "Locations", "type": "array", "description": "Optional city names or search URLs to search in order. Overrides location.", "items": { "type": "string" }, "default": [] }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Exact public search result URLs. Overrides location and locations; use for detailed site filters or non-home property types.", "items": { "type": "string" }, "default": [] }, "propertyCodes": { "title": "Property codes", "type": "array", "description": "Optional listing codes to fetch directly instead of search pages.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Maximum number of unique listings to save. Zero means no item limit.", "default": 50 }, "maxPages": { "title": "Maximum pages per search", "minimum": 1, "type": "integer", "description": "Maximum result pages to visit for each search URL or location.", "default": 50 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keep only listings at or above this price in euros. Applied after reading the page.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keep only listings at or below this price in euros. Zero means any price. Applied after reading the page.", "default": 0 }, "minSize": { "title": "Minimum size", "minimum": 0, "type": "integer", "description": "Keep only listings at or above this size in square meters. Applied after reading the page.", "default": 0 }, "maxSize": { "title": "Maximum size", "minimum": 0, "type": "integer", "description": "Keep only listings at or below this size in square meters. Zero means any size. Applied after reading the page.", "default": 0 }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Keep only listings with one of these exact bedroom counts. Empty means any.", "items": { "type": "string" }, "default": [] }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "Visit each listing page to add a fuller description and image URLs when available. This adds one request per listing.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy configuration for site requests.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }