{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper", "description": "Scrape Idealista real estate listings across Spain, Portugal & Italy. Get 70+ fields per property: price, photos, contacts, energy rating, and price/m² analytics. Filter by location, price, size, features, and more. No account needed.", "version": "1.0", "x-build-id": "ser7pYELVbmBFaQYD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-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/brilliant_gum~idealista-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-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/brilliant_gum~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-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", "properties": { "urls": { "title": "URLs to scrape", "type": "array", "description": "List of Idealista property or search/listing URLs to scrape", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchLocation": { "title": "Search Location", "type": "string", "description": "Idealista location name (e.g., 'madrid-madrid', 'barcelona/eixample')" }, "operation": { "title": "Operation Type", "enum": [ "sale", "rent", "share" ], "type": "string", "description": "Type of listing operation", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "homes", "offices", "premises", "garages", "bedrooms" ], "type": "string", "description": "Type of property to search for", "default": "homes" }, "country": { "title": "Country", "enum": [ "es", "pt", "it", "auto" ], "type": "string", "description": "Country to search in (auto-detected from URLs)", "default": "auto" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum price filter" }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum price filter" }, "minSize": { "title": "Minimum Size (m2)", "minimum": 0, "type": "integer", "description": "Minimum area in square meters" }, "maxSize": { "title": "Maximum Size (m2)", "minimum": 0, "type": "integer", "description": "Maximum area in square meters" }, "bedrooms": { "title": "Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms" }, "bathrooms": { "title": "Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms" }, "features": { "title": "Features", "type": "array", "description": "Required property features", "items": { "type": "string", "enum": [ "elevator", "parking", "terrace", "garden", "pool", "ac", "furnished", "newBuild" ] } }, "condition": { "title": "Condition", "enum": [ "new", "good", "toRenovate", "any" ], "type": "string", "description": "Property condition filter", "default": "any" }, "sinceDate": { "title": "Published Since", "enum": [ "24h", "48h", "week", "month", "any" ], "type": "string", "description": "Only show listings published within this timeframe", "default": "any" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of properties to scrape", "default": 3 }, "includeDetails": { "title": "Include Full Details", "type": "boolean", "description": "Fetch full property details (slower but more data)", "default": true }, "includePhotos": { "title": "Include Photos", "type": "boolean", "description": "Include photo URLs in results", "default": true }, "includeContact": { "title": "Include Contact Info", "type": "boolean", "description": "Include phone numbers and agent information", "default": true }, "includeEnergy": { "title": "Include Energy Rating", "type": "boolean", "description": "Include energy efficiency data", "default": true }, "deduplication": { "title": "Deduplication", "type": "boolean", "description": "Skip properties already scraped in previous runs", "default": true }, "calculatePricePerM2": { "title": "Calculate Price per m2", "type": "boolean", "description": "Automatically calculate price per square meter", "default": true }, "marketStats": { "title": "Market Statistics", "type": "boolean", "description": "Calculate zone averages and medians for comparison", "default": false }, "gpsPolygon": { "title": "GPS Polygon", "type": "array", "description": "Custom geographic boundary (array of {lat, lng} points)" }, "radiusSearch": { "title": "Radius Search", "type": "object", "description": "Search within radius from a center point" }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Default: home residential proxy. Alternative: Apify proxy." }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum parallel requests", "default": 3 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Delay between requests in milliseconds", "default": 3000 }, "maxRetries": { "title": "Max Retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum retry attempts for failed requests", "default": 3 }, "apiKey": { "title": "API Key", "type": "string", "description": "Idealista API key (optional, enables API mode)" }, "apiSecret": { "title": "API Secret", "type": "string", "description": "Idealista API secret (optional)" }, "proxyConfiguration": { "title": "Proxy Configuration (alias)", "type": "object", "description": "Alternative proxy config field name (same as proxyConfig). Uses Apify Residential ES by default." } } }, "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 } } } } } } } } } }