{
  "openapi": "3.0.1",
  "info": {
    "title": "Idealista Property Listings Scraper",
    "description": "Idealista Property Listings Scraper SD - Idealista Property Listings Scraper is a real estate data tool that extracts public idealista.com and .it listings for sale or rent: price and price drops, size, rooms, floor, lift, address, agency, photos and video, with the site's own filters and sorting.",
    "version": "1.0",
    "x-build-id": "woTrT3k3IOkhQghhN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/neuro-scraper~idealista-property-listings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-neuro-scraper-idealista-property-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/neuro-scraper~idealista-property-listings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-neuro-scraper-idealista-property-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/neuro-scraper~idealista-property-listings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-neuro-scraper-idealista-property-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": {
          "location": {
            "title": "Location",
            "type": "string",
            "description": "The area as Idealista writes it in its search URLs: madrid-madrid, barcelona-barcelona, madrid/barrio-de-salamanca, milano-milano (Italy), lisboa (Portugal). Open idealista, search your area and copy the part after /venta-viviendas/."
          },
          "locations": {
            "title": "More locations",
            "type": "array",
            "description": "Further areas, one per line, same format as Location (e.g. valencia-valencia, sevilla-sevilla). Each is searched with the same filters.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Search URLs",
            "type": "array",
            "description": "Idealista search result pages copied from the browser, e.g. https://www.idealista.com/alquiler-viviendas/barcelona-barcelona/con-terraza/ (filters and sorting in the URL are kept; the filters below are added on top).",
            "items": {
              "type": "string"
            }
          },
          "agency": {
            "title": "Agencies",
            "type": "array",
            "description": "Agency pages on Idealista: the slug after /pro/ (gilmarsalamanca) or the full link https://www.idealista.com/pro/gilmarsalamanca/. Their listings are scraped like a search.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "enum": [
              "es",
              "it"
            ],
            "type": "string",
            "description": "Which Idealista site the Location belongs to (set the proxy country to match: ES or IT). Search URLs carry their own site. Portugal (idealista.pt) is not offered: it answers a Cloudflare check that a plain browser did not pass in our tests.",
            "default": "es"
          },
          "operation": {
            "title": "Operation",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Buy or rent search for the locations.",
            "default": "sale"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "homes",
              "newDevelopments",
              "offices",
              "premises",
              "transfers",
              "garages",
              "lands",
              "storageRooms",
              "buildings",
              "bedrooms",
              "vacationRentals"
            ],
            "type": "string",
            "description": "Idealista's property type tab. Read from the search page's own menu on every run; types the site does not offer for an area or operation are reported as an error.",
            "default": "homes"
          },
          "maxItems": {
            "title": "Max listings per search",
            "minimum": 1,
            "maximum": 1800,
            "type": "integer",
            "description": "Idealista shows 30 listings per page; the Actor follows the page's own next link until this number or the last page (the site stops at page 60 = 1,800). Each page is a fresh browser session.",
            "default": 30
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "lowestPrice",
              "highestPrice",
              "mostRecent",
              "leastRecent",
              "biggestPriceDrop",
              "lowestPricePerSqm",
              "highestPricePerSqm",
              "biggest",
              "smallest",
              "highestFloor",
              "lowestFloor"
            ],
            "type": "string",
            "description": "Idealista's own sort orders (checked against the page's sort menu on every run).",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Minimum price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Rows below this price are left out (applied by the Actor: Idealista links no minimum-price URL). 0 = none.",
            "default": 0
          },
          "maxPrice": {
            "title": "Maximum price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Idealista's maximum-price filter (rent = per month). 0 = none.",
            "default": 0
          },
          "minSize": {
            "title": "Minimum size (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Idealista's minimum-area filter. 0 = none.",
            "default": 0
          },
          "maxSize": {
            "title": "Maximum size (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Idealista's maximum-area filter. 0 = none.",
            "default": 0
          },
          "bedrooms": {
            "title": "Bedrooms",
            "type": "array",
            "description": "Any of these bedroom counts (Idealista's bedroom checkboxes).",
            "items": {
              "type": "string",
              "enum": [
                "0",
                "1",
                "2",
                "3",
                "4"
              ],
              "enumTitles": [
                "Studio",
                "1",
                "2",
                "3",
                "4 or more"
              ]
            }
          },
          "bathrooms": {
            "title": "Bathrooms",
            "type": "array",
            "description": "Any of these bathroom counts.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3"
              ],
              "enumTitles": [
                "1",
                "2",
                "3 or more"
              ]
            }
          },
          "homeType": {
            "title": "Home type",
            "type": "array",
            "description": "Sub-types of Homes (Idealista's home-type checkboxes).",
            "items": {
              "type": "string",
              "enum": [
                "flat",
                "penthouse",
                "duplex",
                "detachedHouse",
                "semiDetachedHouse",
                "terracedHouse",
                "countryHouse",
                "apartment",
                "villa",
                "loft",
                "casaBaja"
              ],
              "enumTitles": [
                "Flats",
                "Penthouses",
                "Duplexes",
                "Detached houses",
                "Semi-detached houses",
                "Terraced houses",
                "Country houses",
                "Apartments",
                "Villas",
                "Lofts",
                "Single-storey houses"
              ]
            }
          },
          "condition": {
            "title": "Condition",
            "type": "array",
            "description": "Idealista's condition filter.",
            "items": {
              "type": "string",
              "enum": [
                "newDevelopment",
                "good",
                "renew"
              ],
              "enumTitles": [
                "New build",
                "Good condition",
                "Needs renovation"
              ]
            }
          },
          "floor": {
            "title": "Floor",
            "type": "array",
            "description": "Idealista's floor filter.",
            "items": {
              "type": "string",
              "enum": [
                "topFloor",
                "intermediateFloor",
                "groundFloor"
              ],
              "enumTitles": [
                "Top floor",
                "Middle floors",
                "Ground floor"
              ]
            }
          },
          "propertyStatus": {
            "title": "Occupation",
            "type": "array",
            "description": "Idealista's occupation filter (sale).",
            "items": {
              "type": "string",
              "enum": [
                "free",
                "tenanted",
                "bareOwnership",
                "illegallyOccupied"
              ],
              "enumTitles": [
                "Available",
                "Rented, with tenants",
                "Bare ownership",
                "Illegally occupied"
              ]
            }
          },
          "energyEfficiency": {
            "title": "Energy certificate",
            "type": "array",
            "description": "Idealista's energy-efficiency filter.",
            "items": {
              "type": "string",
              "enum": [
                "high",
                "medium",
                "low"
              ],
              "enumTitles": [
                "High",
                "Medium",
                "Low"
              ]
            }
          },
          "rentalType": {
            "title": "Rental type",
            "enum": [
              "any",
              "longTerm",
              "seasonal"
            ],
            "type": "string",
            "description": "Rent searches only.",
            "default": "any"
          },
          "furnished": {
            "title": "Furnished",
            "enum": [
              "any",
              "furnished",
              "furnishedKitchen"
            ],
            "type": "string",
            "description": "Rent searches only (Idealista's furnishing filter).",
            "default": "any"
          },
          "airConditioning": {
            "title": "Air conditioning",
            "type": "boolean",
            "description": "Only listings with air conditioning.",
            "default": false
          },
          "builtInWardrobes": {
            "title": "Built-in wardrobes",
            "type": "boolean",
            "description": "Only listings with built-in wardrobes.",
            "default": false
          },
          "elevator": {
            "title": "Lift",
            "type": "boolean",
            "description": "Only listings with a lift.",
            "default": false
          },
          "balcony": {
            "title": "Balcony",
            "type": "boolean",
            "description": "Only listings with a balcony.",
            "default": false
          },
          "terrace": {
            "title": "Terrace",
            "type": "boolean",
            "description": "Only listings with a terrace.",
            "default": false
          },
          "exterior": {
            "title": "Exterior",
            "type": "boolean",
            "description": "Only exterior-facing homes.",
            "default": false
          },
          "garage": {
            "title": "Garage",
            "type": "boolean",
            "description": "Only listings with a parking space.",
            "default": false
          },
          "garden": {
            "title": "Garden",
            "type": "boolean",
            "description": "Only listings with a garden.",
            "default": false
          },
          "swimmingPool": {
            "title": "Swimming pool",
            "type": "boolean",
            "description": "Only listings with a pool.",
            "default": false
          },
          "storeRoom": {
            "title": "Storage room",
            "type": "boolean",
            "description": "Only listings with a storage room.",
            "default": false
          },
          "accessible": {
            "title": "Accessible",
            "type": "boolean",
            "description": "Only accessible homes.",
            "default": false
          },
          "luxury": {
            "title": "Luxury",
            "type": "boolean",
            "description": "Only luxury homes.",
            "default": false
          },
          "seaViews": {
            "title": "Sea views",
            "type": "boolean",
            "description": "Only listings with sea views (offered by Idealista in coastal areas).",
            "default": false
          },
          "petsAllowed": {
            "title": "Pets allowed",
            "type": "boolean",
            "description": "Rent only: pets allowed.",
            "default": false
          },
          "hasPlan": {
            "title": "With floor plan",
            "type": "boolean",
            "description": "Only listings with a floor plan.",
            "default": false
          },
          "virtualTour": {
            "title": "With virtual tour",
            "type": "boolean",
            "description": "Only listings with a virtual tour.",
            "default": false
          },
          "bankOffer": {
            "title": "Bank-owned",
            "type": "boolean",
            "description": "Only listings from banks.",
            "default": false
          },
          "onlyFlats": {
            "title": "Only flats",
            "type": "boolean",
            "description": "Only flats (no penthouses, duplexes or houses).",
            "default": false
          },
          "newDevelopment": {
            "title": "New build only",
            "type": "boolean",
            "description": "Same as Condition = New build.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Idealista (DataDome) answers residential IPs from its own market: keep RESIDENTIAL and pick ES, IT or PT to match the site. Each page uses a new IP.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "ES"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}