{
  "openapi": "3.0.1",
  "info": {
    "title": "Wohnungsbörse Scraper — Germany Property Data & API",
    "description": "Wohnungsbörse scraper & real estate data API for wohnungsboerse.net. Rent & sale listings in every German city: price, size, rooms, deposit, floor, address, GPS, energy, photos — clean JSON/CSV. Fast overview or full detail. No-code, no API key needed.",
    "version": "1.0",
    "x-build-id": "7td3aCtUfMx3YZAjK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~wohnungsboerse-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-wohnungsboerse-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~wohnungsboerse-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-wohnungsboerse-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~wohnungsboerse-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-wohnungsboerse-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": "⚡ **Choose the depth of data per listing.**\n\n- **overview** — fast card-level scrape from the search result list (id, title, price, rooms, area, location, thumbnail). Cheapest, highest volume.\n- **detail** — opens every listing's full page for richer fields (deposit, extra costs, energy, GPS, floor, construction year, description, all photos).\n\n💡 **TIP:** Start with overview to size a market, then switch to detail for the listings you care about.",
            "default": "overview"
          },
          "searchMode": {
            "title": "🎯 Search mode",
            "enum": [
              "byCity",
              "bySearchUrl",
              "byListingUrl"
            ],
            "type": "string",
            "description": "🔍 **How to tell the scraper which listings to fetch.**\n\n- **byCity** — give one or more German city names + a contract type.\n- **bySearchUrl** — paste a wohnungsboerse.net search URL (all your filters preserved).\n- **byListingUrl** — give specific listing URLs or IDs (detail mode only).",
            "default": "byCity"
          },
          "cities": {
            "title": "📍 Cities",
            "uniqueItems": true,
            "type": "array",
            "description": "📍 **CITY SEARCH:** German city names to scrape, e.g. `Frankfurt`, `Berlin`, `München`.\n\n💡 **TIP:** Add several cities to compare markets in one run.\n\nUsed when **Search mode = byCity**.",
            "items": {
              "type": "string"
            }
          },
          "contract": {
            "title": "🏷️ Contract type",
            "enum": [
              "rent",
              "sale"
            ],
            "type": "string",
            "description": "🏷️ **Rent or buy.** `rent` (Miete) returns rentals; `sale` (Kauf) returns properties for sale.\n\nUsed with **byCity** search.",
            "default": "rent"
          },
          "estateType": {
            "title": "🏘️ Property type id (optional)",
            "type": "string",
            "description": "🏘️ **wohnungsboerse `estate_types` id** — leave empty for all residential types (recommended).\n\n`1` = Wohnung (apartment). For **rent**, the scraper defaults to `1` automatically (it returns the most apartment listings). For **sale**, leave empty — id `1` returns zero sale results on this site. Used with **byCity** search."
          },
          "searchUrls": {
            "title": "🔗 Search URLs",
            "uniqueItems": true,
            "type": "array",
            "description": "🔗 **SEARCH-URL MODE:** Paste wohnungsboerse.net search URLs — every filter you set on the site (price, rooms, area, commission-free, sort) is preserved.\n\n✅ **SUPPORTED:** the canonical `/searches/index?...` URL and the pretty `/{City}/{mieten|kaufen}/{wohnungen|haeuser}` URL.\n\n💡 **BULK EDIT:** Click \"Bulk edit\" to paste one URL per line.\n\nUsed when **Search mode = bySearchUrl**.",
            "items": {
              "type": "string"
            }
          },
          "listingUrls": {
            "title": "🆔 Listing URLs or IDs",
            "uniqueItems": true,
            "type": "array",
            "description": "🆔 **DETAIL-BY-URL MODE:** Specific listing detail URLs (`https://www.wohnungsboerse.net/immodetail/40066766`) or bare numeric IDs (`40066766`).\n\n💡 **BULK EDIT:** Click \"Bulk edit\" to paste one per line.\n\nUsed when **Search mode = byListingUrl** (requires **Scrape mode = detail**).",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "🔢 Max results",
            "minimum": 1,
            "type": "integer",
            "description": "🔢 **Maximum listings per run.**\n\n- **FREE users:** capped at 25 listings/run.\n- **PAID users:** unlimited.\n\nThe scraper stops paginating once this many listings are collected.",
            "default": 100
          },
          "commissionFree": {
            "title": "✅ Commission-free only",
            "type": "boolean",
            "description": "✅ Only return commission-free listings (`provisionsfrei`). Applied to **byCity** searches.",
            "default": false
          },
          "privateOnly": {
            "title": "✅ Private sellers only",
            "type": "boolean",
            "description": "✅ Only return listings from private sellers, no agents (`private_offer`). Applied to **byCity** searches.",
            "default": false
          },
          "sort": {
            "title": "↕️ Sort by",
            "enum": [
              "",
              "estates.rent_cold",
              "estates.size"
            ],
            "type": "string",
            "description": "↕️ Sort the result list. `estates.rent_cold` = price, `estates.size` = area. Leave empty for site relevance. Applied to **byCity** searches.",
            "default": ""
          },
          "direction": {
            "title": "↕️ Sort direction",
            "enum": [
              "",
              "ASC",
              "DESC"
            ],
            "type": "string",
            "description": "↕️ Ascending or descending, paired with **Sort by**.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}