{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper", "description": "Fast Idealista scraper for Spain, Italy, and Portugal. Returns 100+ fields per listing including AI summaries, Q&A pairs, deal signals, engagement scores, and price tracking. Supports 60+ search filters, multiple locations per run, and outputs data optimized for RAG pipelines and answer engines.", "version": "1.0", "x-build-id": "kuoTw31zBJn98qUj5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacut~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacut-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/datacut~idealista-scraper/runs": { "post": { "operationId": "runs-sync-datacut-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/datacut~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-datacut-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": { "country": { "title": "Country", "enum": [ "es", "it", "pt" ], "type": "string", "description": "Which Idealista site to search.", "default": "es" }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Search for properties for sale or rent.", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "homes", "offices", "premises", "garages", "lands", "storageRooms", "buildings", "bedrooms" ], "type": "string", "description": "Type of property to search for.", "default": "homes" }, "location": { "title": "Location", "type": "string", "description": "City name (e.g. 'Madrid', 'Barcelona') or Idealista location ID. City names are resolved automatically." }, "locations": { "title": "Multiple Locations", "type": "array", "description": "Search multiple cities in one run (max 10). Results are deduplicated. Use this OR 'location', not both.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of listings to scrape. Capped at 500 per run to avoid detection.", "default": 50 }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price_asc", "price_desc", "size_asc", "size_desc", "date_desc", "price_per_m2_asc", "price_drop" ], "type": "string", "description": "How to sort search results.", "default": "relevance" }, "fetchDetails": { "title": "Fetch Details", "type": "boolean", "description": "Fetch full property details (energy cert, characteristics, comments). 1 extra API call per listing.", "default": false }, "fetchStats": { "title": "Fetch Stats", "type": "boolean", "description": "Fetch engagement stats (views, emails, favourites, shares). 1 extra API call per listing.", "default": false }, "minPrice": { "title": "Min Price", "type": "number", "description": "Minimum price in euros (sale) or euros/month (rent). Leave empty for no limit." }, "maxPrice": { "title": "Max Price", "type": "number", "description": "Maximum price in euros (sale) or euros/month (rent). Leave empty for no limit." }, "minSize": { "title": "Min Size (m²)", "type": "number", "description": "Minimum property size in square meters." }, "maxSize": { "title": "Max Size (m²)", "type": "number", "description": "Maximum property size in square meters." }, "bedrooms": { "title": "Bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Minimum number of bedrooms.", "default": "" }, "bathrooms": { "title": "Bathrooms", "enum": [ "", "1", "2", "3" ], "type": "string", "description": "Minimum number of bathrooms.", "default": "" }, "publicationDate": { "title": "Published Since", "enum": [ "", "T", "W", "M", "Y" ], "type": "string", "description": "Filter by listing age.", "default": "" }, "condition": { "title": "Condition", "enum": [ "", "newConstruction", "goodCondition", "needsRenovation" ], "type": "string", "description": "Filter by property condition.", "default": "" }, "furnished": { "title": "Furnished", "enum": [ "", "furnished", "partiallyFurnished", "unfurnished" ], "type": "string", "description": "Filter by furnishing level (mainly for rentals).", "default": "" }, "ownerType": { "title": "Owner Type", "enum": [ "", "privateOwner", "professionalOwner" ], "type": "string", "description": "Filter by property owner type.", "default": "" }, "floor": { "title": "Floor", "enum": [ "", "groundFloor", "firstFloor", "secondFloor", "thirdFloor", "fourthOrHigher" ], "type": "string", "description": "Filter by apartment floor level.", "default": "" }, "flat": { "title": "Flat / Apartment", "type": "boolean", "description": "Only show flats/apartments.", "default": false }, "penthouse": { "title": "Penthouse", "type": "boolean", "description": "Only show penthouses.", "default": false }, "duplex": { "title": "Duplex", "type": "boolean", "description": "Only show duplexes.", "default": false }, "studio": { "title": "Studio", "type": "boolean", "description": "Only show studios.", "default": false }, "chalet": { "title": "Chalet / House", "type": "boolean", "description": "Only show chalets/houses.", "default": false }, "countryHouse": { "title": "Country House", "type": "boolean", "description": "Only show country houses / fincas.", "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 elevator access.", "default": false }, "garage": { "title": "Garage / Parking", "type": "boolean", "description": "Only show properties with garage or parking.", "default": false }, "garden": { "title": "Garden", "type": "boolean", "description": "Only show properties with garden.", "default": false }, "swimmingPool": { "title": "Swimming Pool", "type": "boolean", "description": "Only show properties with swimming pool.", "default": false }, "terrace": { "title": "Terrace", "type": "boolean", "description": "Only show properties with terrace.", "default": false }, "storeRoom": { "title": "Storage Room", "type": "boolean", "description": "Only show properties with storage room.", "default": false }, "builtinWardrobes": { "title": "Built-in Wardrobes", "type": "boolean", "description": "Only show properties with built-in wardrobes.", "default": false }, "exterior": { "title": "Exterior", "type": "boolean", "description": "Only show exterior-facing properties.", "default": false }, "heating": { "title": "Heating", "type": "boolean", "description": "Only show properties with heating.", "default": false }, "accessible": { "title": "Accessible", "type": "boolean", "description": "Only show accessible properties.", "default": false }, "luxury": { "title": "Luxury", "type": "boolean", "description": "Only show luxury properties.", "default": false }, "seaViews": { "title": "Sea Views", "type": "boolean", "description": "Only show properties with sea views.", "default": false }, "bankOffer": { "title": "Bank Offer", "type": "boolean", "description": "Only show bank-owned properties.", "default": false }, "newDevelopment": { "title": "New Development", "type": "boolean", "description": "Only show new development listings.", "default": false }, "rentToOwn": { "title": "Rent to Own", "type": "boolean", "description": "Only show rent-to-own properties.", "default": false }, "stateSubsidized": { "title": "State Subsidized (VPO)", "type": "boolean", "description": "Only show state-subsidized housing.", "default": false }, "petsAllowed": { "title": "Pets Allowed", "type": "boolean", "description": "Only show rentals that allow pets.", "default": false }, "smokingPolicy": { "title": "Smoking Policy", "enum": [ "", "allowed", "notAllowed" ], "type": "string", "description": "Filter by smoking policy.", "default": "" }, "newGender": { "title": "Gender Preference", "enum": [ "", "mixed", "female", "male" ], "type": "string", "description": "Roommate gender preference (only for shared rooms).", "default": "" }, "occupation": { "title": "Occupation", "enum": [ "", "worker", "student" ], "type": "string", "description": "Roommate occupation filter (only for shared rooms).", "default": "" }, "propertyCodes": { "title": "Property Codes", "type": "array", "description": "Specific Idealista property codes to fetch directly (max 100). Skips search and goes straight to detail.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies. Residential proxies recommended for best results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Discord or Slack webhook URL for real-time alerts (breaker trips, run completion, errors)." } } }, "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 } } } } } } } } } }