{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper — Spain & Italy Real Estate", "description": "Scrape idealista.com — Spain, Portugal, and Italy’s top real estate portal. Structured pricing, GPS coordinates, and incremental NEW/CHANGED/EXPIRED tracking. Compact output for AI agents and MCP workflows.", "version": "0.1", "x-build-id": "hqdd2UQOoZZuprcub" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-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/blackfalcondata~idealista-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-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/blackfalcondata~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-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": { "location": { "title": "Location", "type": "string", "description": "Location slug (e.g. \"madrid-madrid\", \"barcelona\", \"lisboa\", \"roma\"). Use JSON array for multiple locations." }, "locationId": { "title": "Location ID", "type": "string", "description": "Idealista internal location ID (e.g. \"0-EU-ES-28-07-001-079\" for Madrid). Overrides location slug if provided." }, "country": { "title": "Country", "enum": [ "ES", "PT", "IT" ], "type": "string", "description": "Idealista market to search.", "default": "ES" }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Sale or rental listings.", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "homes", "offices", "premises", "garages", "bedrooms", "land" ], "type": "string", "description": "Type of property to search.", "default": "homes" }, "maxResults": { "title": "Max Results", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum listings to return (0 = unlimited).", "default": 50 }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum API pages per location (50 listings per page).", "default": 5 }, "minPrice": { "title": "Min Price (€)", "minimum": 0, "type": "integer", "description": "Minimum listing price filter." }, "maxPrice": { "title": "Max Price (€)", "minimum": 0, "type": "integer", "description": "Maximum listing price filter." }, "minRooms": { "title": "Min Rooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "minSizeM2": { "title": "Min Size (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor area in square metres." }, "maxSizeM2": { "title": "Max Size (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor area in square metres." }, "distance": { "title": "Search radius (metres)", "minimum": 500, "maximum": 100000, "type": "integer", "description": "Radius in metres around the city centre when searching by location name (not used when locationId is provided). Default: 10000 (10 km).", "default": 10000 }, "descriptionMaxLength": { "title": "Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to this many characters. 0 = no truncation.", "default": 0 }, "compact": { "title": "Compact Output", "type": "boolean", "description": "Output only core fields (for AI-agent/MCP workflows).", "default": false }, "incrementalMode": { "title": "Incremental Mode", "type": "boolean", "description": "Track new/changed/expired listings across runs. Requires stateKey.", "default": false }, "stateKey": { "title": "State Key", "type": "string", "description": "Stable identifier for this tracking universe (e.g. \"es-madrid-sale-homes\")." }, "emitUnchanged": { "title": "Emit Unchanged Records", "type": "boolean", "description": "When incremental, also emit listings that have not changed.", "default": false }, "emitExpired": { "title": "Emit Expired Records", "type": "boolean", "description": "When incremental, also emit listings no longer found.", "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 } } } } } } } } } }