{
  "openapi": "3.0.1",
  "info": {
    "title": "Immowelt Property Search Scraper",
    "description": "Professional Immowelt.de Real Estate Data Extraction Solution automates property data collection from Germany’s 2nd largest real estate platform. It extracts prices, sizes, locations, and images, enabling market analysis and faster investment decisions.",
    "version": "0.0",
    "x-build-id": "cQWd5QEHz61DwBab4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ecomscrape~immowelt-property-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ecomscrape-immowelt-property-search-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/ecomscrape~immowelt-property-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-ecomscrape-immowelt-property-search-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/ecomscrape~immowelt-property-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-ecomscrape-immowelt-property-search-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": {
          "urls": {
            "title": "URLs of the Property list page urls to scrape",
            "type": "array",
            "description": "Add the URLs of the Property list page urls you want to scrape. You can paste URLs one by one, or use the Bulk edit section to add a prepared list.",
            "items": {
              "type": "string"
            }
          },
          "ignore_url_failures": {
            "title": "Ignore URL failures",
            "type": "boolean",
            "description": "If true, the scraper will continue running even if some URLs fail to be scraped after the maximum number of retries is reached."
          },
          "location": {
            "title": "Location to search, ensure location is valid",
            "type": "string",
            "description": "Enter the Location to search for items, Goto website, choose location and start search, copy location value from url (locations param) and paste here. (e.g. https://www.immowelt.de/classified-search?locations=AD04DE3&distributionTypes=Buy%2CBuy_Auction%2CCompulsory_Auction&estateTypes=House%2CApartment -> location=AD04DE3)"
          },
          "operation_type": {
            "title": "Filter Items by Operation Type",
            "enum": [
              "Buy,Buy_Auction,Compulsory_Auction",
              "Rent"
            ],
            "type": "string",
            "description": "Filter items by Operation Type"
          },
          "property_type": {
            "title": "Filter Items by Property Type",
            "enum": [
              "House,Apartment",
              "House",
              "Apartment",
              "Senior",
              "Building",
              "Plot",
              "Parking",
              "Miscellaneous"
            ],
            "type": "string",
            "description": "Filter items by Property Type"
          },
          "min_price": {
            "title": "Min price",
            "type": "integer",
            "description": "Min price"
          },
          "max_price": {
            "title": "Max price",
            "type": "integer",
            "description": "Max price"
          },
          "min_space": {
            "title": "Min space",
            "type": "integer",
            "description": "Min space"
          },
          "max_space": {
            "title": "Max space",
            "type": "integer",
            "description": "Max space"
          },
          "min_rooms": {
            "title": "Min rooms",
            "enum": [
              "",
              "1",
              "1.5",
              "2",
              "2.5",
              "3",
              "3.5",
              "4",
              "4.5",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12",
              "13",
              "14",
              "15"
            ],
            "type": "string",
            "description": "Min rooms"
          },
          "max_rooms": {
            "title": "Max rooms",
            "enum": [
              "",
              "1",
              "1.5",
              "2",
              "2.5",
              "3",
              "3.5",
              "4",
              "4.5",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12",
              "13",
              "14",
              "15"
            ],
            "type": "string",
            "description": "Max rooms"
          },
          "min_plot_space": {
            "title": "Min plot space",
            "type": "integer",
            "description": "Min plot space"
          },
          "max_plot_space": {
            "title": "Max plot space",
            "type": "integer",
            "description": "Max plot space"
          },
          "sort_by": {
            "title": "Sort by",
            "enum": [
              "",
              "DateDesc",
              "PriceAsc",
              "PriceDesc",
              "PricePerSquareMeterAsc",
              "PricePerSquareMeterDesc",
              "NumberOfRoomsAsc",
              "NumberOfRoomsDesc",
              "SpaceAsc",
              "SpaceDesc"
            ],
            "type": "string",
            "description": "Sort by"
          },
          "page": {
            "title": "Page start",
            "type": "integer",
            "description": "Specify the page number to start scraping from"
          },
          "max_items_per_url": {
            "title": "Limit the number of items per URL or search filters",
            "type": "integer",
            "description": "Limit the number of items per URL or search filters you want to scrape"
          },
          "max_retries_per_url": {
            "title": "Limit the number of retries",
            "type": "integer",
            "description": "Limit the number of retries for each URL or search filters if the scrape is detected as a bot or the page fails to load"
          },
          "proxy": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Select proxies to be used by your scraper."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}