{ "openapi": "3.0.1", "info": { "title": "idealista Scraper", "description": "Scrape idealista.com, idealista.it and idealista.pt listings with price, size, rooms, energy rating, coordinates, agency, photos and 3D tours. Export to CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "hzirhvgc7HCXuSnEQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~idealista-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Any idealista.com, idealista.it or idealista.pt search page (with whatever filters you set on the site) or a single ad URL such as https://www.idealista.com/inmueble/112430280/. Leave empty to use the search builder below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "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": "Sale or rent listings.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "homes", "rooms", "offices", "premises", "garages", "land", "storage", "buildings" ], "type": "string", "description": "Listing section. Rooms are rent-only. Storage and buildings exist on idealista.com and idealista.pt; idealista.it has no such sections.", "default": "homes" }, "location": { "title": "Location slug", "type": "string", "description": "The location part of an idealista URL: `madrid-madrid`, `barcelona-barcelona`, `valencia-provincia`, `milano-milano`, `roma-roma`, `lisboa`, `porto`. Copy it from the site's own URL after you search there." }, "minPrice": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Total price for sale, monthly rent for rent." }, "maxPrice": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Total price for sale, monthly rent for rent." }, "minSize": { "title": "Min size (m²)", "minimum": 0, "type": "integer", "description": "Built area lower bound." }, "maxSize": { "title": "Max size (m²)", "minimum": 0, "type": "integer", "description": "Built area upper bound." }, "bedrooms": { "title": "Bedrooms", "type": "array", "description": "Any combination. On idealista.it this maps to total rooms (monolocale to 5+ locali), on idealista.pt to T0 to T4+.", "items": { "type": "string", "enum": [ "0", "1", "2", "3", "4" ], "enumTitles": [ "Studio / 0", "1", "2", "3", "4 or more" ] } }, "publishedWithin": { "title": "Published within", "enum": [ "24h", "48h", "week", "month" ], "type": "string", "description": "Only ads published in this window." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest", "priceAsc", "priceDesc", "sqmPriceAsc", "sqmPriceDesc", "floorAsc", "floorDesc", "priceDrop" ], "type": "string", "description": "idealista's own sort orders. Default is the site's relevance ranking. On idealista.com a sort combined with filters is refused by DataDome in every form, so such searches are delivered filtered but in relevance order (the log says so); use Published within for recency instead." }, "extraFilters": { "title": "Extra idealista filters", "type": "array", "description": "Raw filter tokens exactly as they appear in idealista URLs after `con-` (Spain and Italy) or `com-` (Portugal), one per line: `ascensor`, `piscina`, `terraza`, `amueblado_amueblados`, `garaje`, `obra-nueva`, `exterior`, `mascotas`, `aticos`, `chalets`, `eficiencia-energetica-alta`... Italy examples: `ascensori`, `giardino`, `terrazza`, `nuova-costruzione`. Portugal examples: `elevador`, `piscina`, `garagem`, `novo`.", "items": { "type": "string" } }, "scrapeDetails": { "title": "Open every ad for full details", "type": "boolean", "description": "On: full description, feature lists, energy certificate, built year, condition, orientation, heating, coordinates, agency and the full photo gallery. Off: card data only (price, size, rooms, floor, snippet, first photo), faster.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies matched to the site's country (Spain, Italy or Portugal) unless you set a country yourself.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "accessMode": { "title": "Access mode", "enum": [ "auto", "http", "browser" ], "type": "string", "description": "Auto tries plain HTTP first and only starts a stealth browser when DataDome challenges a page (sale listings and ad pages on idealista.com always need it). HTTP-only never starts a browser. Browser-only starts it immediately.", "default": "auto" } } }, "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 } } } } } } } } } }