{
  "openapi": "3.0.1",
  "info": {
    "title": "ImmobilienScout24 Scraper - Germany Real Estate",
    "description": "ImmobilienScout24 scraper & API for German real estate: search apartments & houses for rent & buy and export price, m², rooms, energy class, address, GPS, agent-vs-private and price drops. Germany property market data and real-estate lead generation — fast, no login.",
    "version": "0.1",
    "x-build-id": "MDovBIGlvQraUOvAl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/haketa~immobilienscout24-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-haketa-immobilienscout24-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/haketa~immobilienscout24-scraper/runs": {
      "post": {
        "operationId": "runs-sync-haketa-immobilienscout24-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/haketa~immobilienscout24-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-haketa-immobilienscout24-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": {
          "region": {
            "title": "City / Region",
            "enum": [
              "/de/berlin/berlin",
              "/de/hamburg/hamburg",
              "/de/bayern/muenchen",
              "/de/nordrhein-westfalen/koeln",
              "/de/hessen/frankfurt-am-main",
              "/de/baden-wuerttemberg/stuttgart",
              "/de/nordrhein-westfalen/duesseldorf",
              "/de/nordrhein-westfalen/dortmund",
              "/de/nordrhein-westfalen/essen",
              "/de/sachsen/leipzig",
              "/de/sachsen/dresden",
              "/de/niedersachsen/hannover",
              "/de/bremen/bremen",
              "/de/nordrhein-westfalen/duisburg",
              "/de/nordrhein-westfalen/bochum",
              "/de/nordrhein-westfalen/wuppertal",
              "/de/nordrhein-westfalen/bielefeld",
              "/de/nordrhein-westfalen/bonn",
              "/de/nordrhein-westfalen/muenster",
              "/de/baden-wuerttemberg/karlsruhe",
              "/de/baden-wuerttemberg/mannheim",
              "/de/baden-wuerttemberg/freiburg-im-breisgau",
              "/de/baden-wuerttemberg/heidelberg",
              "/de/bayern/nuernberg",
              "/de/bayern/augsburg",
              "/de/rheinland-pfalz/mainz",
              "/de/schleswig-holstein/kiel",
              "/de/schleswig-holstein/luebeck",
              "/de/thueringen/erfurt",
              "/de/sachsen-anhalt/magdeburg",
              "/de/sachsen-anhalt/halle-saale",
              "/de/mecklenburg-vorpommern/rostock",
              "/de/saarland/saarbruecken",
              "/de/brandenburg/potsdam"
            ],
            "type": "string",
            "description": "Pick the German city or region you want listings from. This is the easiest way to start — just choose a location and run. To scrape a very specific search, use the optional Start URLs field below instead."
          },
          "transactionType": {
            "title": "Rent or Buy",
            "enum": [
              "rent",
              "buy"
            ],
            "type": "string",
            "description": "Choose whether you want listings for rent or for sale."
          },
          "propertyType": {
            "title": "Apartment or House",
            "enum": [
              "apartment",
              "house"
            ],
            "type": "string",
            "description": "Choose the type of property you want to scrape."
          },
          "startUrls": {
            "title": "Start URLs (advanced, optional)",
            "type": "array",
            "description": "Power-user option. Paste one or more immobilienscout24.de search-result URLs from your browser (e.g. https://www.immobilienscout24.de/Suche/de/berlin/berlin/wohnung-mieten). The region and listing type are read straight from each URL, letting you combine several cities or filters in one run. When provided, the City/Region, Rent/Buy and Apartment/House selectors above are ignored. Leave empty to just use the dropdowns.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings to scrape across all searches. Use 0 for no limit (large cities can have thousands). A run with no filters returns a fast, mixed sample of about 100 listings.",
            "default": 0
          },
          "includeDetails": {
            "title": "Scrape full listing details",
            "type": "boolean",
            "description": "Fetch each listing's detail page (one extra request per listing) to add Warmmiete/Nebenkosten, year built, condition, heating, full feature list, description, agent contact and PRICE-DROP detection. Disable for a faster, cheaper, search-only run.",
            "default": true
          },
          "onlyPrivate": {
            "title": "Only private sellers (skip agencies)",
            "type": "boolean",
            "description": "Save only listings from private owners (privater Anbieter), skipping real-estate agents (Makler). Ideal for off-market lead generation.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Rotating Apify proxies keep large runs smooth and avoid rate limits. The default works out of the box.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum parallel requests.",
            "default": 8
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}