{ "openapi": "3.0.1", "info": { "title": "Idealista Scraper: Spain, Italy & Portugal Property Listings", "description": "Scrape Idealista property listings from Spain, Italy and Portugal by place name or search link: price, rent per month, price per m², price drops, rooms, size, floor, parking, description, tags, agency and photos. Only new listings mode for alerts. No login.", "version": "0.1", "x-build-id": "2NhUkxbL7mH5ixjOm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~idealista-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-idealista-listings-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/themineworks~idealista-listings-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-idealista-listings-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/themineworks~idealista-listings-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-idealista-listings-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": { "locations": { "title": "Places", "type": "array", "description": "Place names, one per line: a town, district or province as you would type it on Idealista (for example Madrid, Marbella, Chamberí, Milano, Bergamo, Lisboa). Searched on the country site below, for homes for sale or for rent. In Spain and Italy Idealista's own text search finds the place; in Portugal the name is used as the place part of the link (lisboa, porto, cascais). You can also paste Idealista search links here.", "default": [ "Madrid" ], "items": { "type": "string" } }, "country": { "title": "Country site for place names", "enum": [ "es", "it", "pt" ], "type": "string", "description": "Which Idealista site the place names are searched on. Links always use their own site.", "default": "es" }, "operation": { "title": "For sale or for rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Homes for sale or for rent, for place names. Links keep their own.", "default": "sale" }, "startUrls": { "title": "Idealista search links", "type": "array", "description": "Optional. Search results links from idealista.com, idealista.it or idealista.pt, copied from your browser after choosing filters and order there, for example https://www.idealista.com/alquiler-viviendas/barcelona-barcelona/con-precio-hasta_2000/ or https://www.idealista.pt/arrendar-casas/porto/. Any property type (homes, rooms, offices, premises, garages, land, new builds). A link to page 3 starts at page 3.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Listings per search", "minimum": 30, "maximum": 1800, "type": "integer", "description": "Most listings to return for each place or link, 30 to 1,800. Idealista shows 30 listings a page. You pay per listing delivered.", "default": 90 }, "onlyNewListings": { "title": "Only listings not delivered before", "type": "boolean", "description": "For alerts on a schedule: skip listings an earlier run with the same searches already delivered, so each run returns and charges only new ones.", "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 } } } } } } } } } }