{
  "openapi": "3.0.1",
  "info": {
    "title": "Immowelt Scraper — Germany Property Data & API",
    "description": "Immowelt.de scraper & real estate data API for Germany's #2 property portal. Sale & rent listings: price, Kaltmiete/Warmmiete, deposit, size, rooms, floor, address, GPS, photos, agent, energy class & build year — clean JSON/CSV. Fast overview or full detail. No-code, no API key.",
    "version": "1.1",
    "x-build-id": "uDxEw19Q3ynzhr0jL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~immowelt-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-immowelt-property-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/sian.agency~immowelt-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-immowelt-property-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/sian.agency~immowelt-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-immowelt-property-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": {
          "scrapeMode": {
            "title": "⚡ Scrape mode",
            "enum": [
              "overview",
              "detail"
            ],
            "type": "string",
            "description": "⚡ **OVERVIEW** — fast & cheap. Pulls ~30 fully-populated listing cards per search page (price, rooms, area, floor, address, zip, energy class, agent, photos, teaser).\n\n🔍 **DETAIL** — full fields per listing (price breakdown: Kaltmiete/Warmmiete/Nebenkosten/Kaution, GPS coordinates, build year (Baujahr), condition, complete feature list, agent vs. private, reference number, full description, hi-res photos). Slower and priced higher per result.\n\n**TIP:** Start with Overview — upgrade to Detail only when you need the extra fields.",
            "default": "overview"
          },
          "searchMode": {
            "title": "🧭 Search by",
            "enum": [
              "byQuery",
              "bySearchUrl"
            ],
            "type": "string",
            "description": "🧭 How to tell the scraper what to fetch:\n\n- **By query** — pick contract (rent/sale), property type and a geo token, then narrow with the filters below.\n- **By search URL** — paste an immowelt.de search-results URL; every on-page filter in the URL is honored.",
            "default": "byQuery"
          },
          "contract": {
            "title": "🏷️ Contract",
            "enum": [
              "rent",
              "sale"
            ],
            "type": "string",
            "description": "🏷️ **Rent** (mieten) or **Sale** (kaufen). Applies to By query searches.",
            "default": "rent"
          },
          "propertyType": {
            "title": "🏠 Property type",
            "enum": [
              "wohnung",
              "haus"
            ],
            "type": "string",
            "description": "🏠 Filter By query searches by typology.",
            "default": "wohnung"
          },
          "geoId": {
            "title": "🗺️ Region token (geoId)",
            "type": "string",
            "description": "🗺️ The AVIV geo token immowelt.de uses for a region, e.g. `ad02de1` = all of Germany. City/region tokens come from immowelt's location autosuggest.\n\n**TIP:** The easiest path is **Search by URL** — build any search on immowelt.de and paste the URL; then you never need this token. For By query, `ad02de1` (whole Germany) is the safe default."
          },
          "geoPath": {
            "title": "🏙️ Region slug (optional, cosmetic)",
            "type": "string",
            "description": "🏙️ Human-readable region slug for the URL, e.g. `deutschland`, `hamburg`, `berlin`. Cosmetic — the geoId above decides the actual region."
          },
          "searchUrls": {
            "title": "🔗 Search URLs",
            "type": "array",
            "description": "🔗 immowelt.de search-results URLs to scrape. Used when **Search by = By search URL**.\n\n**TIP:** Build any search on immowelt.de (set your filters, sort order, region), then copy the URL from the address bar — every on-page filter is honored.\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "🔢 Max results",
            "minimum": 1,
            "type": "integer",
            "description": "🔢 Maximum listings to extract this run.\n\n- **FREE tier:** capped at 25 listings per run.\n- **PAID tier:** unlimited — set as high as you need.\n\nNote: immowelt's pager caps a single query at ~10,000 results (333 pages × 30). For more, split by region/price bands.",
            "default": 100
          },
          "maxPages": {
            "title": "📄 Max search pages (optional)",
            "minimum": 1,
            "type": "integer",
            "description": "📄 Optional hard cap on how many search-result pages to walk per query (each page ≈ 30 listings). Leave empty to let Max results decide."
          },
          "priceMin": {
            "title": "💶 Min price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "💶 Optional. Minimum price filter (By query mode). Kaltmiete for rent, Kaufpreis for sale."
          },
          "priceMax": {
            "title": "💶 Max price (€)",
            "minimum": 0,
            "type": "integer",
            "description": "💶 Optional. Maximum price filter (By query mode)."
          },
          "roomsMin": {
            "title": "🚪 Min rooms",
            "minimum": 0,
            "type": "number",
            "description": "🚪 Optional. Minimum number of rooms (By query mode). Half-rooms allowed, e.g. 2.5."
          },
          "roomsMax": {
            "title": "🚪 Max rooms",
            "minimum": 0,
            "type": "number",
            "description": "🚪 Optional. Maximum number of rooms (By query mode)."
          },
          "areaMin": {
            "title": "📐 Min living area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "📐 Optional. Minimum living area in m² (By query mode)."
          },
          "areaMax": {
            "title": "📐 Max living area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "📐 Optional. Maximum living area in m² (By query mode)."
          },
          "sortOrder": {
            "title": "↕️ Sort order (optional)",
            "type": "string",
            "description": "↕️ Optional immowelt sort key, e.g. `DateDesc` (newest first). Leave empty for the site default."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}