{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper: Extract Rent & Sale Listings", "description": "Powerful Idealista scraper for professional real estate data. Extract listings from IT, ES, and PT with 40+ filters. Get GPS coordinates, full descriptions, and media. Perfect for investors, developers, and data scientists.", "version": "1.0", "x-build-id": "WyMqqsUpbjhkoWVFp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/burbn~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-burbn-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/burbn~idealista-scraper/runs": { "post": { "operationId": "runs-sync-burbn-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/burbn~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-burbn-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": [ "locationId", "operation" ], "properties": { "locationId": { "title": "📍 Location ID", "type": "string", "description": "Enter an Idealista location ID to search properties in (e.g., 0-EU-IT-MI-01-001-135 for Milano). Get location IDs using the Idealista Auto-Complete actor (https://apify.com/burbn/idealista-auto-complete).", "default": "0-EU-IT-MI-01-001-135" }, "operation": { "title": "🏷️ Operation Type", "enum": [ "rent", "sale" ], "type": "string", "description": "Select whether to search for properties for rent or for sale.", "default": "rent" }, "country": { "title": "🌍 Country", "enum": [ "it", "es", "pt" ], "type": "string", "description": "Select the country to search properties in.", "default": "it" }, "propertyType": { "title": "🏗️ Property Type", "enum": [ "", "homes", "bedrooms", "newDevelopments", "offices", "premises", "garages", "lands", "storageRooms", "buildings" ], "type": "string", "description": "Filter by property type (leave empty for all types).", "default": "" }, "sort": { "title": "📊 Sort Order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort results by price (ascending or descending).", "default": "asc" }, "locale": { "title": "🗣️ Language", "enum": [ "en", "es", "it", "pt", "de", "fr", "ro", "ru", "pl", "sv", "fi", "nb", "nl" ], "type": "string", "description": "Select the language for property descriptions.", "default": "en" }, "maxItems": { "title": "📦 Results Per Page", "minimum": 1, "maximum": 40, "type": "integer", "description": "Number of items per API page (max 40). Higher values = fewer API calls.", "default": 40 }, "maxPages": { "title": "📄 Max Pages to Scrape", "minimum": 0, "type": "integer", "description": "Maximum number of pages to scrape per location (0 = all pages). Use to limit API calls.", "default": 1 }, "minPrice": { "title": "💰 Min Price", "minimum": 0, "type": "integer", "description": "Minimum price filter (0 = no minimum).", "default": 0 }, "maxPrice": { "title": "💰 Max Price", "minimum": 0, "type": "integer", "description": "Maximum price filter (0 = no maximum).", "default": 0 }, "minSize": { "title": "📐 Min Size (sqm)", "minimum": 0, "type": "integer", "description": "Minimum area size in square meters (0 = no minimum).", "default": 0 }, "maxSize": { "title": "📐 Max Size (sqm)", "minimum": 0, "type": "integer", "description": "Maximum area size in square meters (0 = no maximum).", "default": 0 }, "bedrooms": { "title": "🛏️ Bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Filter by number of bedrooms (leave empty for any).", "default": "" }, "bathrooms": { "title": "🚿 Bathrooms", "enum": [ "", "1", "2", "3" ], "type": "string", "description": "Filter by number of bathrooms (leave empty for any).", "default": "" }, "furnished": { "title": "🪑 Furnished", "enum": [ "", "furnished", "furnishedKitchen" ], "type": "string", "description": "Filter by furnishing status (rent only).", "default": "" }, "sinceDate": { "title": "📅 Listed Since", "enum": [ "", "T", "W", "M" ], "type": "string", "description": "Filter by listing date. Note: use T/W/M for rent, Y/W/M for sale.", "default": "" }, "swimmingPool": { "title": "🏊 Swimming Pool", "type": "boolean", "description": "Only show properties with a swimming pool.", "default": false }, "airConditioning": { "title": "❄️ Air Conditioning", "type": "boolean", "description": "Only show properties with air conditioning.", "default": false }, "elevator": { "title": "🛗 Elevator", "type": "boolean", "description": "Only show properties with an elevator.", "default": false }, "terrace": { "title": "🌿 Terrace", "type": "boolean", "description": "Only show properties with a terrace.", "default": false }, "garden": { "title": "🌳 Garden", "type": "boolean", "description": "Only show properties with a garden.", "default": false }, "garage": { "title": "🅿️ Garage", "type": "boolean", "description": "Only show properties with a garage.", "default": false }, "penthouse": { "title": "🏙️ Penthouse", "type": "boolean", "description": "Only show penthouse properties.", "default": false }, "duplex": { "title": "🏘️ Duplex", "type": "boolean", "description": "Only show duplex properties.", "default": false }, "luxury": { "title": "💎 Luxury", "type": "boolean", "description": "Only show luxury properties.", "default": false }, "exterior": { "title": "🌤️ Exterior", "type": "boolean", "description": "Only show exterior-facing properties.", "default": false }, "seaViews": { "title": "🌊 Sea Views", "type": "boolean", "description": "Only show properties with sea views.", "default": false }, "virtualTour": { "title": "🎥 Virtual Tour", "type": "boolean", "description": "Only show properties with a virtual tour.", "default": false }, "storeRoom": { "title": "📦 Store Room", "type": "boolean", "description": "Only show properties with a store/storage room.", "default": false }, "builtinWardrobes": { "title": "🗄️ Built-in Wardrobes", "type": "boolean", "description": "Only show properties with built-in wardrobes.", "default": false }, "accessible": { "title": "♿ Accessible", "type": "boolean", "description": "Only show accessible properties.", "default": false }, "privateOwner": { "title": "👤 Private Owner", "type": "boolean", "description": "Only show properties listed by private owners.", "default": false }, "preservations": { "title": "🔨 Preservation State", "enum": [ "", "renew", "newDevelopment", "good" ], "type": "string", "description": "Filter by property preservation state.", "default": "" }, "subTypology": { "title": "🏗️ Sub-Typology", "enum": [ "", "apartamentoType", "villaType", "loftType", "terracedHouse", "semidetachedHouse" ], "type": "string", "description": "Filter by specific property sub-type.", "default": "" }, "floorHeights": { "title": "🏢 Floor Height", "enum": [ "", "topFloor", "intermediateFloor", "groundFloor" ], "type": "string", "description": "Filter by floor position (comma-separated for multiple, e.g., topFloor,groundFloor).", "default": "" }, "rentalUsages": { "title": "📅 Rental Usage", "enum": [ "", "seasonal", "longTerm" ], "type": "string", "description": "Filter by rental usage type (rent only).", "default": "" }, "smokingPolicy": { "title": "🚬 Smoking Policy", "enum": [ "", "allowed", "disallowed" ], "type": "string", "description": "Filter by smoking policy.", "default": "" }, "petsPolicy": { "title": "🐾 Pets Policy", "enum": [ "", "allowed", "disallowed" ], "type": "string", "description": "Filter by pets policy.", "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 } } } } } } } } } }