{ "openapi": "3.0.1", "info": { "title": "Idealista Property Search Scraper", "description": "Search Idealista listings with prices, size, rooms, photos, location, and links. Batch location searches and page through property results across supported European markets.", "version": "1.0", "x-build-id": "gnmyzpQP0wZPK8YFN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrappa~idealista-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrappa-idealista-search-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/thescrappa~idealista-search-scraper/runs": { "post": { "operationId": "runs-sync-thescrappa-idealista-search-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/thescrappa~idealista-search-scraper/run-sync": { "post": { "operationId": "run-sync-thescrappa-idealista-search-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": [ "location_ids", "country", "operation", "property_type" ], "properties": { "location_ids": { "title": "Locations", "minItems": 1, "maxItems": 100, "type": "array", "description": "Idealista location IDs to search.", "items": { "type": "object", "required": [ "location_id" ], "properties": { "location_id": { "title": "Location ID", "type": "string", "description": "Idealista location id such as 0-EU-ES-28.", "maxLength": 80, "pattern": "^[A-Za-z0-9._-]+$", "editor": "textfield" }, "country": { "title": "Country", "type": "string", "description": "Market: es, it, pt, or fr. Default es.", "enum": [ "es", "it", "pt", "fr" ], "editor": "select" }, "operation": { "title": "Operation", "type": "string", "description": "sale or rent. Room stock uses bedrooms + rent.", "enum": [ "sale", "rent" ], "editor": "select" }, "property_type": { "title": "Property Type", "type": "string", "description": "homes, newDevelopments, bedrooms, offices, premises, transfers, buildings, storageRooms, garages, vacationRentals, luxury, or lands.", "enum": [ "homes", "newDevelopments", "bedrooms", "offices", "premises", "transfers", "buildings", "storageRooms", "garages", "vacationRentals", "luxury", "lands" ], "editor": "select" }, "center": { "title": "Center", "type": "string", "description": "lat,lon for near-me search.", "maxLength": 40, "pattern": "^-?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)?$", "editor": "textfield" }, "distance": { "title": "Distance", "type": "integer", "description": "Radius in meters when using center.", "minimum": 1, "maximum": 50000, "editor": "number" }, "max_items": { "title": "Max Items", "type": "integer", "description": "Page size honored by origin, 1-5.", "minimum": 1, "maximum": 5, "default": 5, "editor": "number" }, "num_page": { "title": "NUM Page", "type": "integer", "description": "1-based page number.", "minimum": 1, "default": 1, "editor": "number" }, "order": { "title": "Order", "type": "string", "description": "Sort direction or ordering mode for property results.", "maxLength": 40, "editor": "textfield" }, "sort": { "title": "Sort", "type": "string", "description": "Listing sort mode, such as price or publication date.", "enum": [ "asc", "desc" ], "default": "desc", "editor": "select" }, "quality": { "title": "Quality", "type": "string", "description": "Filter results by listing quality when supported.", "enum": [ "high", "low" ], "editor": "select" }, "gallery": { "title": "Gallery", "type": "boolean", "description": "Filter for listings that include gallery photos.", "default": false, "editor": "checkbox" }, "locale": { "title": "Locale", "type": "string", "description": "Language and regional formatting for the listing search.", "maxLength": 8, "editor": "textfield" }, "microsite_short_name": { "title": "Microsite Short Name", "type": "string", "description": "Anonymous agency stock filter, for example clikalia.", "maxLength": 80, "pattern": "^[A-Za-z0-9._-]+$", "editor": "textfield" }, "chalet": { "title": "Chalet", "type": "boolean", "description": "Apply-filter key. Send true on homes.", "editor": "checkbox" }, "current_occupation_type": { "title": "Current Occupation Type", "type": "string", "description": "free, bareOwnership, tenanted, illegallyOccupied, or viager.", "enum": [ "free", "bareOwnership", "tenanted", "illegallyOccupied", "viager" ], "editor": "select" }, "auction": { "title": "Auction", "type": "string", "description": "IT only: onlyAuctions or excludeAuctions.", "enum": [ "onlyAuctions", "excludeAuctions" ], "editor": "select" }, "home_type": { "title": "Home Type", "type": "string", "description": "Idealista home subtype, such as an apartment or house.", "maxLength": 40, "editor": "textfield" }, "bank_offer": { "title": "Bank Offer", "type": "string", "description": "Filter listings associated with a bank offer.", "maxLength": 40, "editor": "textfield" }, "advertiser_type": { "title": "Advertiser Type", "type": "string", "description": "Filter results by advertiser category.", "maxLength": 40, "editor": "textfield" }, "min_price": { "title": "Min Price", "type": "integer", "description": "Minimum asking price for a property listing.", "minimum": 0, "editor": "number" }, "max_price": { "title": "Max Price", "type": "integer", "description": "Maximum asking price for a property listing.", "minimum": 0, "editor": "number" }, "min_size": { "title": "Min Size", "type": "integer", "description": "Minimum property area in square metres.", "minimum": 0, "editor": "number" }, "max_size": { "title": "Max Size", "type": "integer", "description": "Maximum property area in square metres.", "minimum": 0, "editor": "number" }, "min_rooms": { "title": "Min Rooms", "type": "integer", "description": "Minimum room count for a property listing.", "minimum": 0, "editor": "number" }, "max_rooms": { "title": "Max Rooms", "type": "integer", "description": "Maximum room count for a property listing.", "minimum": 0, "editor": "number" }, "shape": { "title": "Shape", "type": "string", "description": "Geographic search shape used to restrict Idealista results.", "editor": "textfield" } } } }, "country": { "title": "Country", "enum": [ "es", "it", "pt", "fr" ], "type": "string", "description": "Market: es, it, pt, or fr. Default es." }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "sale or rent. Room stock uses bedrooms + rent." }, "property_type": { "title": "Property Type", "enum": [ "homes", "newDevelopments", "bedrooms", "offices", "premises", "transfers", "buildings", "storageRooms", "garages", "vacationRentals", "luxury", "lands" ], "type": "string", "description": "homes, newDevelopments, bedrooms, offices, premises, transfers, buildings, storageRooms, garages, vacationRentals, luxury, or lands." }, "center": { "title": "Center", "pattern": "^-?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)?$", "maxLength": 40, "type": "string", "description": "lat,lon for near-me search." }, "distance": { "title": "Distance", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Radius in meters when using center." }, "max_items": { "title": "Max Items", "minimum": 1, "maximum": 5, "type": "integer", "description": "Page size honored by origin, 1-5.", "default": 5 }, "num_page": { "title": "NUM Page", "minimum": 1, "type": "integer", "description": "1-based page number.", "default": 1 }, "order": { "title": "Order", "maxLength": 40, "type": "string", "description": "Sort direction or ordering mode for property results." }, "sort": { "title": "Sort", "enum": [ "asc", "desc" ], "type": "string", "description": "Listing sort mode, such as price or publication date.", "default": "desc" }, "quality": { "title": "Quality", "enum": [ "high", "low" ], "type": "string", "description": "Filter results by listing quality when supported." }, "gallery": { "title": "Gallery", "type": "boolean", "description": "Filter for listings that include gallery photos.", "default": false }, "locale": { "title": "Locale", "maxLength": 8, "type": "string", "description": "Language and regional formatting for the listing search." }, "microsite_short_name": { "title": "Microsite Short Name", "pattern": "^[A-Za-z0-9._-]+$", "maxLength": 80, "type": "string", "description": "Anonymous agency stock filter, for example clikalia." }, "chalet": { "title": "Chalet", "type": "boolean", "description": "Apply-filter key. Send true on homes." }, "current_occupation_type": { "title": "Current Occupation Type", "enum": [ "free", "bareOwnership", "tenanted", "illegallyOccupied", "viager" ], "type": "string", "description": "free, bareOwnership, tenanted, illegallyOccupied, or viager." }, "auction": { "title": "Auction", "enum": [ "onlyAuctions", "excludeAuctions" ], "type": "string", "description": "IT only: onlyAuctions or excludeAuctions." }, "home_type": { "title": "Home Type", "maxLength": 40, "type": "string", "description": "Idealista home subtype, such as an apartment or house." }, "bank_offer": { "title": "Bank Offer", "maxLength": 40, "type": "string", "description": "Filter listings associated with a bank offer." }, "advertiser_type": { "title": "Advertiser Type", "maxLength": 40, "type": "string", "description": "Filter results by advertiser category." }, "min_price": { "title": "Min Price", "minimum": 0, "type": "integer", "description": "Minimum asking price for a property listing." }, "max_price": { "title": "Max Price", "minimum": 0, "type": "integer", "description": "Maximum asking price for a property listing." }, "min_size": { "title": "Min Size", "minimum": 0, "type": "integer", "description": "Minimum property area in square metres." }, "max_size": { "title": "Max Size", "minimum": 0, "type": "integer", "description": "Maximum property area in square metres." }, "min_rooms": { "title": "Min Rooms", "minimum": 0, "type": "integer", "description": "Minimum room count for a property listing." }, "max_rooms": { "title": "Max Rooms", "minimum": 0, "type": "integer", "description": "Maximum room count for a property listing." }, "shape": { "title": "Shape", "type": "string", "description": "Geographic search shape used to restrict Idealista results." }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum dataset items to save across this entire run.", "default": 100 }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum pages to request for each batch entry.", "default": 2 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }