{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper - Spain, Italy and Portugal Property Listings", "description": "Collect Idealista houses and flats for sale or rent in Spain, Italy and Portugal: price, price drops, size, rooms, floor, agency and listing URL.", "version": "0.1", "x-build-id": "Dd35KxBgK6elyyefg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ziomixshot~idealista-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ziomixshot-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/ziomixshot~idealista-scraper/runs": { "post": { "operationId": "runs-sync-ziomixshot-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/ziomixshot~idealista-scraper/run-sync": { "post": { "operationId": "run-sync-ziomixshot-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": { "country": { "title": "Country", "enum": [ "es", "it", "pt" ], "type": "string", "description": "The Idealista site to search; the run reads it through a residential proxy of the same country. Leave empty to take it from the location name (Madrid is Spain, Milan is Italy); set it when the name exists in several countries. A location path without a country searches Spain." }, "operation": { "title": "Sale or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Houses and flats for sale or for rent.", "default": "sale" }, "location": { "title": "Location", "type": "string", "description": "A province, municipality, island, coast or region name, for example Madrid, Valencia, Milano, Lisbon, Mallorca, Costa del Sol or Toscana (accents optional), or the location path from the Idealista address bar, for example madrid-madrid or barcelona/eixample for a district. A name used in several places means the provincial capital; a country or province after a comma picks another one, for example Porto, Spain. Show locations lists the names and paths." }, "startUrls": { "title": "Search URLs", "type": "array", "description": "Copied Idealista search URLs (idealista.com, idealista.it, idealista.pt), one per line, with the filters and sort chosen on Idealista. When set, they replace every field of Search, Filters and Sort.", "items": { "type": "string" } }, "filters": { "title": "Filters", "type": "array", "description": "Filter keys of the Idealista search form, for example lift, terrace, flats, bedrooms-2 (Spain, Portugal) or rooms-2 (Italy). Show filters lists the keys each country and operation offers. Keys of one group (for example bedrooms-1 and bedrooms-2) mean either; keys of different groups must all apply.", "items": { "type": "string" } }, "publishedWithin": { "title": "Published within", "enum": [ "24h", "48h", "week", "month" ], "type": "string", "description": "Only listings published in this period." }, "priceFrom": { "title": "Price from", "minimum": 1, "type": "integer", "description": "Minimum price in EUR, inclusive: sale price, or monthly rent for rent." }, "priceTo": { "title": "Price to", "minimum": 1, "type": "integer", "description": "Maximum price in EUR, inclusive." }, "sizeFrom": { "title": "Size from", "minimum": 1, "type": "integer", "description": "Minimum built area in m2, inclusive." }, "sizeTo": { "title": "Size to", "minimum": 1, "type": "integer", "description": "Maximum built area in m2, inclusive." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceAsc", "priceDesc", "newest", "oldest", "biggestPriceDrop", "pricePerM2Asc", "pricePerM2Desc", "sizeDesc", "sizeAsc", "floorDesc", "floorAsc", "privateAdvertisersFirst", "professionalsFirst" ], "type": "string", "description": "Order of the results as Idealista sorts them. A run over 1,800 listings reads the search in price ranges, so the order holds within each range.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard limit of unique listings returned and charged, shared by all Search URLs of the run. Idealista serves 1,800 listings per search; above that the run splits the search into price ranges to read the rest.", "default": 100 }, "enrichDetails": { "title": "Listing details", "type": "boolean", "description": "Also open the page of every listing: full description, features, bathrooms, condition, year built, energy certificate, community costs, address, coordinates, all photos, floor plans, update date and advertiser. Charged as listing-details on top of each listing; a listing removed meanwhile is skipped free of charge.", "default": false }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "Scrape returns every matching listing. Monitor reads the whole search and returns only listings that earlier runs with the same store and key did not report, plus a change record (listing-change) for every reported listing whose price changed since. The first monitor run returns every listing as new. Schedule it to get alerts.", "default": "scrape" }, "seenStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that keeps what monitor runs reported. Leave empty to use a store named after the search (idealista-monitor-...; the run log shows it), so repeating the same search keeps its history. Set a new name (letters, digits and hyphens) to share one history between different runs: the Actor creates that store and keeps access to it. A store created outside this Actor cannot be used (the run stops before any listing is charged)." }, "seenIdsKey": { "title": "Monitor state key", "type": "string", "description": "Record in the store that holds the reported listings and their last prices (up to 500000 newest listings are kept).", "default": "IDEALISTA_SEEN" }, "countOnly": { "title": "Count only", "type": "boolean", "description": "No listing charges, only the run start: return the number of listings Idealista reports for each search. Filters are still verified.", "default": false }, "listLocations": { "title": "Show locations", "type": "boolean", "description": "No listing charges, only the run start: list the provinces and municipalities (name, path, search URL) instead of collecting listings. Country narrows the list; Location narrows it to names or paths containing that text.", "default": false }, "listFilters": { "title": "Show filters", "type": "boolean", "description": "No listing charges, only the run start: list the filter keys and sort orders of each country and operation instead of collecting listings. Country and Sale or rent narrow the list.", "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 }, "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 } } } } } } } } } }