{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper [Just 💰$0.49] — Sale & Rent, Phone, Agency", "description": "💰 from $0.49 per 1,000 listings — the cheapest Idealista scraper to start on. Scrape homes for sale and for rent across Spain, Portugal & Italy with agent phones & emails; agency profiles; GPS, photos & full pricing. Incremental tracking of new & updated listings.", "version": "0.2", "x-build-id": "nxTTlhw2skwsPY2m6" }, "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." }, "country": { "title": "🌍 Country", "enum": [ "ES", "PT", "IT", "FR" ], "type": "string", "description": "Idealista market to search. France is searched by locationId (e.g. 0-EU-FR-75 for Paris) or by coordinates; typed place names resolve for Spain, Portugal and Italy.", "default": "ES" }, "maxResults": { "title": "💯 Max Results", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum listings to return (0 = unlimited).", "default": 100 }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Paste idealista URLs from your browser: search-result pages to scrape those exact searches, or single listing pages (`/inmueble/...`, `/imovel/...`, `/immobile/...`) to get just those properties. Each URL is scraped independently and results are merged.", "items": { "type": "string" } }, "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. Several IDs can be given comma-separated or as a JSON array (e.g. [\"0-EU-PT-11-07-026-26\",\"0-EU-PT-11-06-033-33\"]). Map-zone codes from a /multi/ search URL (e.g. aX2,buZ,bv3) are accepted too." }, "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", "newDevelopments", "lands", "buildings", "storageRooms", "transfers", "vacationRentals" ], "type": "string", "description": "Type of property to search.", "default": "homes" }, "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." }, "maxRooms": { "title": "Max Rooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms. 0 = studio." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Minimum number of bathrooms." }, "maxBathrooms": { "title": "Max Bathrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of bathrooms." }, "homeTypes": { "title": "Home type", "type": "array", "description": "Only these kinds of home (any of them). Applies to the Homes property type.", "items": { "type": "string", "enum": [ "flat", "apartment", "penthouse", "duplex", "studio", "loft", "chalet", "detachedHouse", "semiDetachedHouse", "terracedHouse", "villa", "countryHouse" ], "enumTitles": [ "Flat", "Apartment", "Penthouse", "Duplex", "Studio", "Loft", "Chalet / house", "Detached house", "Semi-detached house", "Terraced house", "Villa", "Country house" ] } }, "condition": { "title": "✨ Condition", "type": "array", "description": "Only listings in these conditions (any of them).", "items": { "type": "string", "enum": [ "newDevelopment", "good", "renew" ], "enumTitles": [ "New build", "Good condition", "Needs renovation" ] } }, "floorTypes": { "title": "Floor", "type": "array", "description": "Only listings on these floors (any of them).", "items": { "type": "string", "enum": [ "topFloor", "intermediateFloor", "groundFloor" ], "enumTitles": [ "Top floor", "Middle floors", "Ground floor" ] } }, "features": { "title": "Must have", "type": "array", "description": "Only listings that have ALL of these.", "items": { "type": "string", "enum": [ "swimmingPool", "terrace", "elevator", "garage", "garden", "airConditioning", "storageRoom", "builtInWardrobes", "balcony", "exterior", "seaViews", "accessible", "luxury", "outdoorSpace", "floorPlan", "virtualTour", "bankOwned", "petsAllowed", "furnished" ], "enumTitles": [ "Swimming pool", "Terrace", "Lift", "Parking space", "Garden", "Air conditioning", "Storage room", "Fitted wardrobes", "Balcony", "Exterior (street-facing)", "Sea views", "Wheelchair accessible", "Luxury", "Private outdoor space", "Floor plan available", "Virtual tour", "Bank-owned", "Pets allowed (rent)", "Furnished (rent)" ] } }, "occupancy": { "title": "Occupancy", "type": "array", "description": "Only listings with this occupancy status (any of them). Sale listings.", "items": { "type": "string", "enum": [ "free", "tenanted", "bareOwnership", "illegallyOccupied" ], "enumTitles": [ "Vacant", "Tenanted", "Bare ownership", "Illegally occupied" ] } }, "energyRating": { "title": "Energy rating", "enum": [ "high", "medium", "low" ], "type": "string", "description": "Only listings with this energy-efficiency band." }, "publishedWithin": { "title": "Published within", "enum": [ "last24Hours", "last48Hours", "lastWeek", "lastMonth" ], "type": "string", "description": "Only listings published recently. Idealista offers 48 hours (not 24) for sales and 24 hours (not 48) for rentals; the nearest window is used." }, "sellerType": { "title": "👤 Seller", "enum": [ "any", "private", "professional" ], "type": "string", "description": "Only listings from private owners, or only from professionals (agencies, developers, banks)." }, "auctions": { "title": "🔨 Auctions", "enum": [ "any", "only", "exclude" ], "type": "string", "description": "Include auction listings, show only auctions, or leave them out. Sale listings; auctions are listed on Idealista Italy." }, "rentalType": { "title": "🗓️ Rental type", "enum": [ "any", "longTerm", "seasonal" ], "type": "string", "description": "Long-term (main residence) or seasonal rentals (limited periods: study terms, temporary work, relocation). Rental homes only." }, "sortBy": { "title": "🔀 Sort by", "enum": [ "price", "publicationDate", "modificationDate", "size", "pricePerM2", "rooms", "floor", "priceReduction", "distance" ], "type": "string", "description": "Order of the results. Leave empty for Idealista's default order. Distance needs Latitude/Longitude." }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Direction for Sort by." }, "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 }, "lat": { "title": "🌐 Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "GPS latitude. Pair with lon. Ignored when cityName is set." }, "lon": { "title": "🌐 Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "GPS longitude. Pair with lat." }, "radiusKm": { "title": "📏 Search Radius (km)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Search radius in kilometres around the resolved city." }, "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 }, "excludeEmptyFields": { "title": "Exclude empty fields from output", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "includeDetails": { "title": "Include full property details", "type": "boolean", "description": "Fetch each listing's full detail page — energy rating, characteristics, and the complete description. Slower and adds result cost.", "default": false }, "descriptionFormat": { "title": "📝 Description Format", "enum": [ "all", "text", "html", "markdown" ], "type": "string", "description": "Choose which representation of the listing description to include. `all` keeps every variant; the others keep only the selected one.", "default": "all" }, "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 }, "skipReposts": { "title": "🚫 Skip Reposts", "type": "boolean", "description": "When incremental, skip listings that are reposts of previously seen (now expired) listings.", "default": false }, "notifyOnlyChanges": { "title": "🔄 Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for NEW and UPDATED listings. Has no effect outside incremental mode.", "default": false }, "notificationLimit": { "title": "📊 Max Listings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of listings included in each notification message (1–20).", "default": 5 }, "telegramToken": { "title": "🔑 Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "💬 Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent (e.g. \"-100123456789\")." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Paste from Server Settings → Integrations → Webhooks." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. Create at api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📱 WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager (NOT the phone number itself — the numeric ID shown next to your business number). Free service-conversation messages within 24 hours of last user-initiated contact." }, "whatsappAccessToken": { "title": "🔐 WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with `whatsapp_business_messaging` scope. Get a permanent token from a system user in Meta Business Manager." }, "whatsappTo": { "title": "📨 WhatsApp Recipient", "type": "string", "description": "Recipient phone number in E.164 format (e.g. +4512345678). The recipient must have messaged your business number within the last 24 hours." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST `{ metadata, items }` per run. Single attempt, 15 s timeout." }, "webhookHeaders": { "title": "🪝 Webhook Headers (optional)", "type": "object", "description": "Additional HTTP headers sent with the generic webhook POST (e.g. `{\"Authorization\":\"Bearer ...\"}`). Content-Type is always `application/json`." }, "appConnector": { "title": "Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results (including any contact details). Best-effort across MCP connectors as Apify expands its catalog." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." }, "maxPages": { "title": "📄 Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum result pages per location (50 listings per page)." }, "propertyCodes": { "title": "Listing IDs", "type": "array", "description": "Fetch these listings directly by their Idealista ID (the number in the listing URL, e.g. 112272495). Uses the Country setting for the site.", "items": { "type": "string" } }, "mode": { "title": "⚙️ Scrape mode", "enum": [ "listings", "agencies" ], "type": "string", "description": "What to scrape — property listings, or the agencies behind them.", "default": "listings" }, "cityName": { "title": "🏙️ City Name", "type": "string", "description": "City name (e.g. \"Paris\", \"Lyon\"). Resolved to the nearest known city." } } }, "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 } } } } } } } } } }