{
  "openapi": "3.0.1",
  "info": {
    "title": "ImmoScout24 Scraper: Germany Property Listings & Rent Data",
    "description": "ImmoScout24 scraper for Germany: apartments, houses and plots for rent or sale in any city, district or postcode. Cold rent or price in EUR, m², rooms, address, map point, private or agency, photos; warm rent and deposit on request. Up to 10,000 listings per run.",
    "version": "0.1",
    "x-build-id": "LJyuNhxpaf1k62CP2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automatic~immoscout24-de-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automatic-immoscout24-de-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/automatic~immoscout24-de-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automatic-immoscout24-de-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/automatic~immoscout24-de-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automatic-immoscout24-de-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": "Cities, districts or postcodes",
            "maxItems": 10,
            "type": "array",
            "description": "Up to 10 German places, one search each: a city (Berlin, München), a district or quarter (Leipzig Plagwitz, Hamburg Altona), a state (Bayern) or a five-digit postcode (10115). A place that ImmoScout24 does not know, for example a typo, is skipped and listed in the run summary; the other places still run. Leave empty and fill Search links instead to reuse searches from the website. An empty run input returns a sample of the newest Berlin rentals.",
            "items": {
              "type": "string"
            }
          },
          "operation": {
            "title": "Rent or buy",
            "enum": [
              "rent",
              "buy"
            ],
            "type": "string",
            "description": "Listings for rent or for sale. Applies to the places above.",
            "default": "rent"
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "apartment",
              "house",
              "plot"
            ],
            "type": "string",
            "description": "Apartments, houses or building plots (plots are for sale only). Applies to the places above.",
            "default": "apartment"
          },
          "priceMin": {
            "title": "Minimum price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest cold rent per month (rent; warm rent with Rent prices set to warm) or purchase price (buy) in euros. Empty or 0 means no minimum."
          },
          "priceMax": {
            "title": "Maximum price (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Highest cold rent per month (rent; warm rent with Rent prices set to warm) or purchase price (buy) in euros. Empty or 0 means no maximum."
          },
          "priceType": {
            "title": "Rent prices are",
            "enum": [
              "cold",
              "warm"
            ],
            "type": "string",
            "description": "Whether the price range above means cold rent (Kaltmiete, the ImmoScout24 default) or warm rent (Gesamtmiete: cold rent plus service and heating costs). Warm rent works for apartments for rent only. Purchase prices are not affected.",
            "default": "cold"
          },
          "roomsMin": {
            "title": "Minimum rooms",
            "minimum": 0,
            "type": "number",
            "description": "Fewest rooms (German count: living rooms and bedrooms, half rooms allowed, e.g. 2.5)."
          },
          "roomsMax": {
            "title": "Maximum rooms",
            "minimum": 0,
            "type": "number",
            "description": "Most rooms."
          },
          "areaMin": {
            "title": "Minimum area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Smallest living area, or plot area for plots, in square metres."
          },
          "areaMax": {
            "title": "Maximum area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Largest living area, or plot area for plots, in square metres."
          },
          "sortBy": {
            "title": "Order",
            "enum": [
              "newest",
              "relevance",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Newest first suits scheduled monitoring: each run starts with the latest listings.",
            "default": "newest"
          },
          "includeNewHomeBuilderOffers": {
            "title": "Include house-building offers",
            "type": "boolean",
            "description": "House searches on ImmoScout24 also show catalogue houses from builders (Hausbauangebote, \"Bauen mit ...\"), which are not existing properties. They are left out unless you turn this on.",
            "default": false
          },
          "includeDetails": {
            "title": "Include listing details",
            "type": "boolean",
            "description": "Add warm rent, service charges, heating costs and deposit from each delivered listing's own page, plus its full description, every labelled attribute (floor, year built, heating, energy certificate), the advertiser's name and company, and the whole photo gallery. Off by default. Each listing whose page was read adds a small extra charge (see Pricing); a listing whose page could not be opened is still delivered with its search-result fields. Runs about one second slower per listing.",
            "default": false
          },
          "startUrls": {
            "title": "Search links",
            "maxItems": 10,
            "type": "array",
            "description": "Up to 10 search result links copied from immobilienscout24.de (https://www.immobilienscout24.de/Suche/de/...), with all their filters. When links are given, the place, rent/buy, type and filter fields above are not used. Links for investment property, garages, shared rooms, short stays or drawn map areas are skipped and listed in the run summary.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Maximum listings",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Upper limit of listings saved across all searches (up to 10,000). Listings are saved as they are found; about 30 seconds per 1,000 listings. Raise the run timeout for very large runs.",
            "default": 50
          },
          "maxPages": {
            "title": "Maximum pages per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Safety cap on result pages per search (up to 100 listings per page).",
            "default": 120
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}