{ "openapi": "3.0.1", "info": { "title": "Idealista Api Actor", "description": "Idealista API Scraper – Official API (never blocked). Spain, Italy & Portugal. Auto beachfronts (zoiId), agent phone search, full filters, GPS polygon, custom JS calculations, market stats. The strongest Idealista actor on Apify.", "version": "0.0", "x-build-id": "Qea9jvMkhaHQRLz8a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~idealista-api-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-idealista-api-actor", "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/axlymxp~idealista-api-actor/runs": { "post": { "operationId": "runs-sync-axlymxp-idealista-api-actor", "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/axlymxp~idealista-api-actor/run-sync": { "post": { "operationId": "run-sync-axlymxp-idealista-api-actor", "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": [ "country", "operation", "propertyType" ], "properties": { "country": { "title": "Country", "enum": [ "es", "it", "pt" ], "type": "string", "description": "Select the country you want to scrape: Spain (es), Italy (it) or Portugal (pt). Spain is the biggest market.", "default": "es" }, "operation": { "title": "Operation", "enum": [ "sale", "rent", "share", "transfers" ], "type": "string", "description": "Type of listing: sale (buy), rent, share (roommates) or transfers (business transfers).", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "homes", "offices", "premises", "garages", "bedrooms", "lands", "storageRooms", "buildings", "newDevelopments", "transfers" ], "type": "string", "description": "Main property category (homes = residential, premises = commercial, newDevelopments = off-plan projects, etc.).", "default": "homes" }, "searchType": { "title": "Search Type", "enum": [ "auto", "locationIds", "zoiId", "phone", "center" ], "type": "string", "description": "auto = smartest (recommended). zoiId = special zones (beachfronts), phone = search by agent phone, center = GPS radius search.", "default": "auto" }, "locationPrefix": { "title": "Location Name", "type": "string", "description": "City, area or neighborhood (e.g. 'Madrid', 'Barcelona', 'primera línea de playa'). Actor automatically resolves via autocomplete." }, "locationIds": { "title": "Direct Location ID (advanced)", "type": "string", "description": "Enter one location ID (e.g. 0-EU-ES-28-07-001-079)." }, "phone": { "title": "Agent Phone Number", "type": "string", "description": "Search all properties listed by a specific agent using their phone number." }, "center": { "title": "GPS Center (lat,lng)", "type": "string", "description": "Center point for radius search (e.g. '40.4168,-3.7038' for Madrid center)." }, "distance": { "title": "Search Radius (meters)", "minimum": 100, "maximum": 100000, "type": "integer", "description": "Radius around the GPS center in meters (5000 = 5 km). Use together with 'center'." }, "minPrice": { "title": "Min Price", "minimum": 0, "type": "integer", "description": "Minimum price in euros." }, "maxPrice": { "title": "Max Price", "minimum": 0, "type": "integer", "description": "Maximum price in euros." }, "minSize": { "title": "Min Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum size in square meters." }, "maxSize": { "title": "Max Size (m²)", "minimum": 0, "type": "integer", "description": "Maximum size in square meters." }, "minTransferCost": { "title": "Min Transfer Cost", "minimum": 0, "type": "integer", "description": "Minimum business transfer cost (used for premises/transfers)." }, "maxTransferCost": { "title": "Max Transfer Cost", "minimum": 0, "type": "integer", "description": "Maximum business transfer cost (used for premises/transfers)." }, "minRooms": { "title": "Min Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "maxProperties": { "title": "Max Properties", "minimum": 10, "maximum": 100000, "type": "integer", "description": "Total number of properties to extract (higher values give more valuable runs).", "default": 100000 }, "sortBy": { "title": "Sort By", "enum": [ "weigh", "price", "publicationDate", "size" ], "type": "string", "description": "How to sort the results.", "default": "weigh" }, "sinceDate": { "title": "Since Date", "enum": [ "-1", "T", "W", "M", "Y" ], "type": "string", "description": "-1 = any time, T = last 24h, Y = last 48h, W = last week, M = last month.", "default": "-1" }, "elevator": { "title": "Has Elevator", "type": "boolean", "description": "Filter only properties with a lift/elevator." }, "garage": { "title": "Has Parking", "type": "boolean", "description": "Filter only properties with parking or garage." }, "garden": { "title": "Has Garden", "type": "boolean", "description": "Filter only properties with garden." }, "swimmingPool": { "title": "Has Swimming Pool", "type": "boolean", "description": "Filter only properties with swimming pool." }, "terrance": { "title": "Has Terrace", "type": "boolean", "description": "Filter only properties with terrace." }, "airConditioning": { "title": "Air Conditioning", "type": "boolean", "description": "Filter only properties with air conditioning." }, "petsAllowed": { "title": "Pets Allowed", "type": "boolean", "description": "Filter rental properties that allow pets." }, "seaViews": { "title": "Sea Views", "type": "boolean", "description": "Filter only properties with sea views." }, "balcony": { "title": "Has Balcony", "type": "boolean", "description": "Filter only properties with balcony." }, "builtinWardrobes": { "title": "Fitted Wardrobes", "type": "boolean", "description": "Filter only properties with built-in wardrobes." }, "storeRoom": { "title": "Storage Room", "type": "boolean", "description": "Filter only properties with storage room." }, "accessible": { "title": "Accessible", "type": "boolean", "description": "Filter wheelchair-accessible properties." }, "exterior": { "title": "Exterior", "type": "boolean", "description": "Filter only exterior properties." }, "heating": { "title": "Heating", "type": "boolean", "description": "Filter only properties with heating system." }, "corner": { "title": "On a Corner", "type": "boolean", "description": "Filter commercial properties located on a corner." }, "smokeVentilation": { "title": "Smoke Outlet", "type": "boolean", "description": "Filter commercial properties with smoke ventilation." }, "bankOffer": { "title": "Bank Offer", "type": "boolean", "description": "Filter properties owned by banks." }, "hasPlan": { "title": "With Floor Plan", "type": "boolean", "description": "Filter only properties that include a floor plan." }, "virtualTour": { "title": "With Virtual Tour", "type": "boolean", "description": "Filter only properties with virtual tour." }, "energyEfficiency": { "title": "Energy Efficiency", "uniqueItems": true, "type": "array", "description": "Filter by energy certificate (multiple selection supported). High = A+/A/B, Medium = C/D, Low = E/F/G.", "items": { "type": "string", "enum": [ "high", "medium", "low" ] } }, "furnished": { "title": "Furnished", "enum": [ "-1", "furnishedKitchen", "furnished", "" ], "type": "string", "description": "-1 = indifferent, furnishedKitchen = only fitted kitchen, furnished = fully furnished." }, "preservations": { "title": "Property Condition", "uniqueItems": true, "type": "array", "description": "Filter by condition (multiple selection supported).", "items": { "type": "string", "enum": [ "newDevelopment", "good", "renew" ] } }, "floorHeights": { "title": "Floor Level", "uniqueItems": true, "type": "array", "description": "Filter by floor position (multiple selection supported).", "items": { "type": "string", "enum": [ "topFloor", "intermediateFloor", "groundFloor" ] } }, "subTypology": { "title": "Sub Typology", "enum": [ "independantHouse", "semidetachedHouse", "terracedHouse", "apartamentoType", "" ], "type": "string", "description": "Detailed subtype for homes (e.g. detached house, apartment, etc.)." }, "ubication": { "title": "Location Type (Commercial)", "uniqueItems": true, "type": "array", "description": "Commercial location type (multiple selection supported).", "items": { "type": "string", "enum": [ "shoppingcenter", "street", "mezzanine", "underground", "ontopfloor", "others" ] } }, "commercialActivitySubcategories": { "title": "Commercial Activity", "uniqueItems": true, "type": "array", "description": "Type of business activity (multiple selection supported).", "items": { "type": "string", "enum": [ "accommodation", "barsAndNightclub", "catering", "foodTrade", "tobaccoShop", "pharmacy", "newsstand", "retail", "educationalCenter", "aestheticAndBeauty", "sportsFacilities", "professionalServices", "laboratory", "storehouse", "otherCommercialActivities" ] } }, "businessOperationType": { "title": "Business Operation Type", "uniqueItems": true, "type": "array", "description": "Type of commercial transaction (multiple selection supported).", "items": { "type": "string", "enum": [ "rentWarehouseOnly", "rentWarehouseWithBusinessTransfer", "saleWarehouseOnly", "saleWarehouseWithBusinessTransfer", "saleWarehouseThirdPartiesRented" ] } }, "fetchFullDetails": { "title": "Fetch Full Details", "type": "boolean", "description": "Get complete description, all images, energy certificate and features for every property (highly recommended).", "default": false }, "generateMarketStats": { "title": "Generate Market Stats", "type": "boolean", "description": "Add a summary item with average price/m², price distribution and market insights.", "default": false }, "customMapFunction": { "title": "Custom Map Function (JS)", "type": "string", "description": "JavaScript function to transform each property. Example: (item) => { item.pricePerSqm = Math.round(item.price / item.size); return item; }" }, "debug": { "title": "Debug", "type": "boolean", "description": "Enable debug mode. (advanced)", "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 } } } } } } } } } }