{
  "openapi": "3.0.1",
  "info": {
    "title": "ImmobilienScout24 Scraper - ImmoScout24 German Real Estate",
    "description": "[Limited Launch Offer $1/1K] ImmoScout24 scraper: rent and buy listings by city, district or URL with price, size, rooms, coordinates and full details. No result limit. No login.",
    "version": "0.1",
    "x-build-id": "6aWuX6DITxR5ucpzA"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kalilfagundes.w~immoscout24-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kalilfagundes.w-immoscout24-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/kalilfagundes.w~immoscout24-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kalilfagundes.w-immoscout24-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/kalilfagundes.w~immoscout24-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kalilfagundes.w-immoscout24-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": {
          "regions": {
            "title": "Regions (regions)",
            "type": "array",
            "description": "One per line: a city, district or state such as \"Berlin\", \"München\", \"Hamburg Altona\", \"Bayern\", or a geo path like /de/bayern/muenchen. Each region is searched for every listing type below.",
            "items": {
              "type": "string"
            }
          },
          "listingTypes": {
            "title": "Listing types (listingTypes)",
            "type": "array",
            "description": "What to search for. Default: apartments for rent.",
            "items": {
              "type": "string",
              "enum": [
                "apartment_rent",
                "apartment_buy",
                "house_rent",
                "house_buy",
                "flatshare_room",
                "garage_rent",
                "garage_buy",
                "investment",
                "industry",
                "trade_site"
              ],
              "enumTitles": [
                "Apartments for rent",
                "Apartments for sale",
                "Houses for rent",
                "Houses for sale",
                "Flat share rooms",
                "Garages for rent",
                "Garages for sale",
                "Investment properties",
                "Commercial / industrial",
                "Trade sites"
              ]
            },
            "default": [
              "apartment_rent"
            ]
          },
          "searchUrls": {
            "title": "ImmoScout24 search URLs (searchUrls)",
            "type": "array",
            "description": "Optional. Search pages copied from your browser, e.g. https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten?price=-1200. City, district and state searches are supported (not radius or map searches). Used together with the regions above.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerSearch": {
            "title": "Max listings per search (maxResultsPerSearch)",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many listings for each region and listing type (0 = all of them). The API pages through every result: a big city can have thousands.",
            "default": 100
          },
          "maxItems": {
            "title": "Max listings in total (maxItems)",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap for the whole run (0 = no cap). Keeps the cost predictable.",
            "default": 1000
          },
          "includeDetails": {
            "title": "Full details (includeDetails)",
            "type": "boolean",
            "description": "Open every listing for its description, equipment, location text, costs, building and energy data, all images and the provider (company, phones, address). Charged as an extra event per listing. Private sellers' names and phones are left out.",
            "default": false
          },
          "priceFrom": {
            "title": "Price from, EUR (priceFrom)",
            "minimum": 0,
            "type": "number",
            "description": "Minimum rent (total rent for rentals) or purchase price in EUR."
          },
          "priceTo": {
            "title": "Price to, EUR (priceTo)",
            "minimum": 0,
            "type": "number",
            "description": "Maximum rent or purchase price in EUR."
          },
          "roomsFrom": {
            "title": "Rooms from (roomsFrom)",
            "minimum": 0,
            "type": "number",
            "description": "Minimum number of rooms (2.5 is allowed)."
          },
          "roomsTo": {
            "title": "Rooms to (roomsTo)",
            "minimum": 0,
            "type": "number",
            "description": "Maximum number of rooms."
          },
          "livingSpaceFrom": {
            "title": "Living space from, m² (livingSpaceFrom)",
            "minimum": 0,
            "type": "number",
            "description": "Minimum living space in square metres."
          },
          "livingSpaceTo": {
            "title": "Living space to, m² (livingSpaceTo)",
            "minimum": 0,
            "type": "number",
            "description": "Maximum living space in square metres."
          },
          "extraParameters": {
            "title": "Extra API parameters (extraParameters)",
            "type": "object",
            "description": "Advanced: more ImmoScout24 filter parameters as key-value pairs, e.g. {\"constructionyear\": \"2015-\", \"equipment\": \"balcony\"}. Unknown parameters make the search fail with a clear message."
          },
          "maxConcurrency": {
            "title": "Pages in parallel (maxConcurrency)",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "How many result pages (or detail pages) are fetched at the same time. Keep it low: ImmoScout24 blocks heavy traffic.",
            "default": 3
          },
          "proxyConfiguration": {
            "title": "Proxy (proxyConfiguration)",
            "type": "object",
            "description": "Default: no proxy, fastest and cheapest. If ImmobilienScout24 refuses requests the scraper switches to Apify residential proxies by itself. Choose a proxy group to use it from the start.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}