{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper | 💛 $0.5/1k | No Limit", "description": "⚡ From $0.5/1k 💛 Scrape Idealista property listings from Spain, Italy, Portugal, and France. Extract prices, locations, descriptions, images, property details, and listing URLs from search pages or individual property pages. Export to CSV/JSON", "version": "0.1", "x-build-id": "FUfXT3030qVLLs2w9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epicscrapers~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epicscrapers-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/epicscrapers~idealista-scraper/runs": { "post": { "operationId": "runs-sync-epicscrapers-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/epicscrapers~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-epicscrapers-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": { "startUrls": { "title": "Idealista URLs", "type": "array", "description": "Paste Idealista search result pages or individual property pages here. When you use URLs, the Actor automatically detects the country, language, property type, location, and filters from each URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Country for location search", "enum": [ "es", "it", "pt", "fr" ], "type": "string", "description": "Choose the country only when searching by location name below. For URL searches, the country is detected from the Idealista URL automatically.", "default": "it" }, "operation": { "title": "I want to find", "enum": [ "sale", "rent" ], "type": "string", "description": "Choose whether you want properties for sale or for rent. This is used only for location searches.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "homes", "offices", "premises", "garages", "lands", "buildings", "rooms", "newDevelopments" ], "type": "string", "description": "Choose what kind of properties you want to search for. This is used only for location searches.", "default": "homes" }, "locationQuery": { "title": "City or area", "type": "string", "description": "Enter a city, town, neighborhood, or area name, for example Genova, Madrid, Lisboa, or Paris. The Actor will choose the best matching Idealista location." }, "locationIds": { "title": "Idealista location IDs", "type": "array", "description": "Advanced option. If you already know Idealista location IDs, enter them here instead of using a city or area name.", "items": { "type": "string" } }, "locationSelectionMode": { "title": "How to choose matching locations", "enum": [ "best", "all", "exact" ], "type": "string", "description": "When a city or area name has multiple matches, choose whether to use the best match, all matches, or only an exact name match.", "default": "best" }, "maxResults": { "title": "Maximum results per query", "minimum": 1, "type": "integer", "description": "The maximum number of properties to save for each Idealista URL or location search.", "default": 100 }, "includeDetails": { "title": "Open each property page for more details", "type": "boolean", "description": "Turn this on to request the full property details for every search result. This gives richer data but makes the run slower.", "default": false }, "includeMultimedia": { "title": "Get extra photos and media", "type": "boolean", "description": "Turn this on to request the separate media endpoint for each property. Search results already include basic images when available.", "default": false }, "includeRecommendations": { "title": "Get similar recommended properties", "type": "boolean", "description": "Turn this on to also collect a small list of similar properties recommended by Idealista for each result.", "default": false }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only include properties with a price at or above this amount. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only include properties with a price at or below this amount. Leave empty for no maximum." }, "minSize": { "title": "Minimum size", "minimum": 0, "type": "integer", "description": "Only include properties with at least this many square meters. Leave empty for no minimum size." }, "maxSize": { "title": "Maximum size", "minimum": 0, "type": "integer", "description": "Only include properties with no more than this many square meters. Leave empty for no maximum size." }, "minRooms": { "title": "Minimum rooms", "minimum": 0, "type": "integer", "description": "Only include homes with at least this many rooms, when Idealista supports this filter for the selected property type." }, "maxRooms": { "title": "Maximum rooms", "minimum": 0, "type": "integer", "description": "Only include homes with no more than this many rooms, when Idealista supports this filter for the selected property type." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only include properties with at least this many bathrooms, when available." }, "hasPhotos": { "title": "Only properties with photos", "type": "boolean", "description": "Turn this on to prefer results that include photos, when supported by Idealista for the selected search.", "default": false }, "hasPlan": { "title": "Only properties with a floor plan", "type": "boolean", "description": "Turn this on to include only properties that have a floor plan, when supported by Idealista.", "default": false }, "exterior": { "title": "Exterior properties only", "type": "boolean", "description": "Turn this on to include only exterior-facing properties, when supported by Idealista.", "default": false }, "elevator": { "title": "Elevator", "type": "boolean", "description": "Turn this on to include only properties with an elevator, when supported by Idealista.", "default": false }, "airConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Turn this on to include only properties with air conditioning, when supported by Idealista.", "default": false }, "garage": { "title": "Garage or parking", "type": "boolean", "description": "Turn this on to include only properties with a garage or parking option, when supported by Idealista.", "default": false }, "heating": { "title": "Heating", "type": "boolean", "description": "Turn this on to include only properties with heating, when supported by Idealista.", "default": false }, "accessible": { "title": "Accessible property", "type": "boolean", "description": "Turn this on to include only properties marked as accessible, when supported by Idealista.", "default": false }, "security": { "title": "Security features", "type": "boolean", "description": "Turn this on to include only properties with security features, when supported by Idealista.", "default": false }, "quality": { "title": "Image quality", "enum": [ "low", "high" ], "type": "string", "description": "Advanced option. Choose the image/detail quality requested from Idealista.", "default": "low" }, "gallery": { "title": "Include gallery in search results", "type": "boolean", "description": "Advanced option. Keep this on to request gallery images in search results when Idealista provides them.", "default": true }, "order": { "title": "Result ordering", "type": "string", "description": "Advanced option. Idealista ordering mode. The default usually matches Idealista's recommended order.", "default": "weigh" }, "sort": { "title": "Sort direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Advanced option. Choose ascending or descending result order.", "default": "desc" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The Actor uses Apify Residential Proxy by default and automatically selects the proxy country from the URL or selected country.", "default": { "useApifyProxy": true } }, "itemsPerPage": { "title": "Results per search page", "minimum": 1, "maximum": 50, "type": "integer", "description": "Advanced option. How many listings to request per Idealista search page. Idealista currently caps this at 50.", "default": 50 }, "searchConcurrency": { "title": "Parallel search page requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Advanced option. Number of search result pages to fetch in parallel. Higher values can be faster but may increase proxy errors or rate limits.", "default": 4 }, "maxRetries": { "title": "Retry failed requests", "minimum": 0, "type": "integer", "description": "Advanced option. How many times to retry temporary API errors before giving up.", "default": 3 }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 5, "type": "integer", "description": "Advanced option. Maximum time to wait for each Idealista API request before retrying it. Increase this if residential proxies are slow.", "default": 45 }, "delaySeconds": { "title": "Delay between search batches", "minimum": 0, "type": "number", "description": "Advanced option. Wait this many seconds between batches of parallel search page requests. Increase if Idealista starts rate limiting.", "default": 0 }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Advanced option. Turn this on to print more technical information while the Actor runs.", "default": false } } }, "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 } } } } } } } } } }