{
  "openapi": "3.0.1",
  "info": {
    "title": "Idealista Scraper - Spain, Italy & Portugal Listings, Prices",
    "description": "Scrape idealista.com, .it and .pt listings for sale or rent: price, price drops, €/m², m², rooms, floor, lift, GPS, photos and agency. Optional listing-page details: baths, features, energy certificate, address, update date. Search by place, URL or postal code, past the 1,800 cap, monitor mode.",
    "version": "0.1",
    "x-build-id": "3beUGoCelRDREWBPr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~idealista-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-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/scrapersdelight~idealista-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-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/scrapersdelight~idealista-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-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": "Which idealista site to search: Spain (idealista.com), Italy (idealista.it) or Portugal (idealista.pt). Search URLs you paste below pick their own site.",
            "default": "es"
          },
          "locations": {
            "title": "📍 Locations",
            "type": "array",
            "description": "Place names as you would type them on idealista, e.g. \"Madrid\", \"Getafe\", \"Milano\", \"Lisboa\". The site's own location search picks the best match (logged). A URL slug such as \"madrid-madrid\" is used as is.",
            "items": {
              "type": "string"
            }
          },
          "operation": {
            "title": "🏷️ Operation",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Buy (sale) or rent.",
            "default": "sale"
          },
          "propertyType": {
            "title": "🏠 Property type",
            "enum": [
              "homes",
              "newDevelopments",
              "rooms",
              "holidayRentals",
              "offices",
              "premises",
              "garages",
              "lands",
              "storageRooms",
              "buildings",
              "transfers"
            ],
            "type": "string",
            "description": "The site's own property menu. Rooms and holiday rentals exist for rent only (holiday rentals: Spain and Portugal).",
            "default": "homes"
          },
          "startUrls": {
            "title": "🔗 Search or listing URLs",
            "type": "array",
            "description": "Paste any idealista.com/.it/.pt search URL (all its filters and sort are kept) or listing URL (e.g. https://www.idealista.com/inmueble/111955729/). Listing URLs return the full listing page.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "postalCodes": {
            "title": "📮 Postal codes",
            "type": "array",
            "description": "Postal codes of the chosen country, e.g. \"28045\". Read as the site's postal-code search shows them (the form filters below apply to locations).",
            "items": {
              "type": "string"
            }
          },
          "propertyCodes": {
            "title": "🆔 Property codes",
            "type": "array",
            "description": "Listing ids of the chosen country (the number in /inmueble/<id>/). Each returns the full listing page and is charged as a listing with details.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest price in euros (monthly rent for rentals)."
          },
          "maxPrice": {
            "title": "Max price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "Highest price in euros (monthly rent for rentals)."
          },
          "minSize": {
            "title": "Min size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Smallest built area in square metres."
          },
          "maxSize": {
            "title": "Max size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Largest built area in square metres."
          },
          "bedrooms": {
            "title": "Bedrooms",
            "type": "array",
            "description": "Any of these. Spain/Portugal: 0 = studio. Italy counts rooms (locali): 1 = monolocale ... 5+ = 5 or more.",
            "items": {
              "type": "string",
              "enum": [
                "0",
                "1",
                "2",
                "3",
                "4",
                "4+",
                "5+"
              ],
              "enumTitles": [
                "0 / studio (ES, PT)",
                "1",
                "2",
                "3",
                "4 (Italy)",
                "4 or more",
                "5 or more (Italy)"
              ]
            }
          },
          "bathrooms": {
            "title": "Bathrooms",
            "type": "array",
            "description": "Any of these.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3+"
              ],
              "enumTitles": [
                "1",
                "2",
                "3 or more"
              ]
            }
          },
          "homeTypes": {
            "title": "Home type",
            "type": "array",
            "description": "Any of these (homes only). Not every type exists in every country; an unknown one stops the run before anything is charged.",
            "items": {
              "type": "string",
              "enum": [
                "flat",
                "apartment",
                "penthouse",
                "duplex",
                "atticStudio",
                "loft",
                "detachedHouse",
                "semiDetachedHouse",
                "terracedHouse",
                "countryHouse",
                "villa",
                "bungalow",
                "farmhouse",
                "manorHouse"
              ],
              "enumTitles": [
                "Flat",
                "Apartment (ES)",
                "Penthouse",
                "Duplex",
                "Attic / studio (IT, PT)",
                "Loft",
                "Detached house",
                "Semi-detached house",
                "Terraced house",
                "Country house",
                "Villa (ES, IT)",
                "Single-storey house (ES, PT)",
                "Farmhouse (IT, PT)",
                "Manor house (PT)"
              ]
            }
          },
          "condition": {
            "title": "Condition",
            "type": "array",
            "description": "Any of these.",
            "items": {
              "type": "string",
              "enum": [
                "new",
                "good",
                "toRenovate"
              ],
              "enumTitles": [
                "New build",
                "Good condition",
                "To renovate"
              ]
            }
          },
          "floorTypes": {
            "title": "Floor",
            "type": "array",
            "description": "Any of these.",
            "items": {
              "type": "string",
              "enum": [
                "top",
                "middle",
                "ground"
              ],
              "enumTitles": [
                "Top floor",
                "Middle floors",
                "Ground floor"
              ]
            }
          },
          "features": {
            "title": "Must have",
            "type": "array",
            "description": "All of these. Exterior and bank-owned are Spain/Portugal; auction is Italy; pets allowed is rent only.",
            "items": {
              "type": "string",
              "enum": [
                "airConditioning",
                "fittedWardrobes",
                "lift",
                "balcony",
                "terrace",
                "exterior",
                "parking",
                "garden",
                "swimmingPool",
                "storageRoom",
                "accessible",
                "luxury",
                "seaViews",
                "floorPlan",
                "virtualTour",
                "bankOffer",
                "petsAllowed",
                "auction"
              ],
              "enumTitles": [
                "Air conditioning",
                "Fitted wardrobes",
                "Lift",
                "Balcony",
                "Terrace",
                "Exterior (ES)",
                "Parking / garage",
                "Garden",
                "Swimming pool",
                "Storage room",
                "Accessible",
                "Luxury",
                "Sea views",
                "Floor plan",
                "Virtual tour",
                "Bank-owned (ES, PT)",
                "Pets allowed (rent; ES, IT)",
                "Court auction (IT)"
              ]
            }
          },
          "energyEfficiency": {
            "title": "Energy efficiency",
            "type": "array",
            "description": "Any of these energy-certificate bands.",
            "items": {
              "type": "string",
              "enum": [
                "high",
                "medium",
                "low"
              ],
              "enumTitles": [
                "High (A-B)",
                "Medium (C-D)",
                "Low (E-G)"
              ]
            }
          },
          "occupation": {
            "title": "Occupation",
            "type": "array",
            "description": "Any of these (sale). Bare ownership: ES, IT. Illegally occupied: ES.",
            "items": {
              "type": "string",
              "enum": [
                "free",
                "tenanted",
                "bareOwnership",
                "illegallyOccupied"
              ],
              "enumTitles": [
                "Vacant",
                "With tenants",
                "Bare ownership",
                "Illegally occupied (ES)"
              ]
            }
          },
          "rentalTypes": {
            "title": "Rental type",
            "type": "array",
            "description": "Rent only: long-term or seasonal.",
            "items": {
              "type": "string",
              "enum": [
                "longTerm",
                "seasonal"
              ],
              "enumTitles": [
                "Long-term",
                "Seasonal / temporary"
              ]
            }
          },
          "furnished": {
            "title": "Furnished",
            "enum": [
              "",
              "furnished",
              "kitchenOnly"
            ],
            "type": "string",
            "description": "Rent only.",
            "default": ""
          },
          "publicationDate": {
            "title": "Published within",
            "enum": [
              "",
              "last48h",
              "lastWeek",
              "lastMonth"
            ],
            "type": "string",
            "description": "Only listings published in this window. Pairs well with a daily or weekly schedule.",
            "default": ""
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "cheapest",
              "mostExpensive",
              "newest",
              "oldest",
              "biggestPriceDrop",
              "cheapestPerM2",
              "mostExpensivePerM2",
              "biggest",
              "smallest",
              "highestFloor",
              "lowestFloor",
              "privateFirst",
              "agenciesFirst"
            ],
            "type": "string",
            "description": "The site's own sort orders. \"Newest first\" pages are refused by idealista's bot check on residential exits and are read through the Unblocker (slower).",
            "default": "relevance"
          },
          "sellerType": {
            "title": "Seller",
            "enum": [
              "all",
              "private",
              "professional"
            ],
            "type": "string",
            "description": "Keep only private sellers or only professionals (agencies, developers, banks).",
            "default": "all"
          },
          "onlyPriceDrops": {
            "title": "Only price drops",
            "type": "boolean",
            "description": "Keep only listings showing a reduced price (original price + drop %).",
            "default": false
          },
          "minPriceDropPercent": {
            "title": "Min price drop (%)",
            "minimum": 0,
            "maximum": 99,
            "type": "integer",
            "description": "Keep only listings whose price dropped at least this much, e.g. 5."
          },
          "includeDetails": {
            "title": "➕ Listing-page details",
            "type": "boolean",
            "description": "Also read each listing's own page: bathrooms, every feature, energy certificate, street / neighbourhood / district, last update date, reference, advertiser name and the full photo list. One page per listing, charged as the listing-details add-on.",
            "default": false
          },
          "monitorMode": {
            "title": "🔁 Monitor mode",
            "type": "boolean",
            "description": "Deliver only listings that are new or changed price since the previous run with the same inputs (marked changeType new / priceDrop / priceRise; with listing details on, a listing delivered earlier without them comes back once as details). Pairs with a daily schedule.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor name",
            "type": "string",
            "description": "Optional name for this monitor's memory, so two schedules with the same inputs stay apart. Empty = derived from the inputs."
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many listings in total. idealista shows at most 1,800 listings per search (60 pages); bigger searches are split into price bands when \"Go past 1,800\" is on.",
            "default": 100
          },
          "maxItemsPerSearch": {
            "title": "Max listings per search",
            "minimum": 0,
            "type": "integer",
            "description": "Cap for each location / URL / postal code. 0 = only the total cap applies.",
            "default": 0
          },
          "splitLargeSearches": {
            "title": "Go past 1,800 per search",
            "type": "boolean",
            "description": "When a search lists more than the 1,800 the site shows, split it into price bands and read each one to its end.",
            "default": true
          },
          "descriptionMaxLength": {
            "title": "Description max length",
            "minimum": 0,
            "type": "integer",
            "description": "Cut descriptions to this many characters. 0 = keep the full text.",
            "default": 0
          },
          "compact": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "Core fields only (id, url, price, drop, m², rooms, baths, floor, coordinates, agency, thumbnail) - lighter for AI/MCP pipelines.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "idealista serves residential exits only: each page goes out on a fresh residential exit in the searched site's own country (Spain, Italy or Portugal, whatever country is set here). You may give your own proxy URLs instead.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "ES"
            }
          },
          "useUnblockerFallback": {
            "title": "Unblocker fallback",
            "type": "boolean",
            "description": "When two fresh exits are refused, read the page through Apify's Unblocker (slower, 60-80 s a page). Capped per run.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Parallel pages",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Pages read at the same time.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}