{ "openapi": "3.0.1", "info": { "title": "WG-Gesucht Scraper — German Flatshares & Rentals", "description": "Scrape WG-Gesucht.de, Germany's biggest flatshare and rental portal. Get offers (WG rooms, apartments, houses) with rent, size, district, availability, and flatmate details — or switch to seeker mode (Gesuche) for unique demand-side data. Optional cost breakdown per listing. No login, no cookies.", "version": "0.1", "x-build-id": "v91R7GOv56kdhBu6f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studio-amba~wg-gesucht-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studio-amba-wg-gesucht-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/studio-amba~wg-gesucht-scraper/runs": { "post": { "operationId": "runs-sync-studio-amba-wg-gesucht-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/studio-amba~wg-gesucht-scraper/run-sync": { "post": { "operationId": "run-sync-studio-amba-wg-gesucht-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": { "city": { "title": "City", "type": "string", "description": "City name in Germany, Austria, or Switzerland (e.g. 'Berlin', 'München', 'Hamburg', 'Wien', 'Zürich'). Umlauts and 'ue/oe/ae' spellings both work. Cities in other countries (Amsterdam, Barcelona, ...) are resolved live from the WG-Gesucht sitemaps. You can also pass a numeric WG-Gesucht city ID or a WG-Gesucht listing URL.", "default": "Berlin" }, "adType": { "title": "Ad Type", "enum": [ "offers", "requests" ], "type": "string", "description": "'Offers' scrapes available rooms and apartments. 'Requests' scrapes the Gesuche side instead: ads by people SEARCHING for a room, with their maximum budget and minimum size — demand-side data that no listing scraper offers.", "default": "offers" }, "categories": { "title": "Categories", "type": "array", "description": "Property categories to include. Defaults to all four.", "items": { "type": "string", "enum": [ "WG-Zimmer", "1-Zimmer-Wohnung", "Wohnung", "Haus" ], "enumTitles": [ "WG-Zimmer (flatshare room)", "1-Zimmer-Wohnung (studio)", "Wohnung (apartment)", "Haus (house)" ] }, "default": [ "WG-Zimmer", "1-Zimmer-Wohnung", "Wohnung", "Haus" ] }, "maxRent": { "title": "Max Rent (€)", "minimum": 1, "type": "integer", "description": "Only return listings with total rent up to this amount (for requests mode: seekers with a budget up to this amount). Leave empty for no limit." }, "fetchDetails": { "title": "Fetch Cost Breakdown", "type": "boolean", "description": "Also open each offer's detail page to extract the cost breakdown: base rent (Kaltmiete), utilities (Nebenkosten), other costs, deposit (Kaution), and contact name. One extra request per listing — slower and more expensive. Offers mode only.", "default": false }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of listings to return.", "default": 100 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Default Apify datacenter proxies work fine for WG-Gesucht; switch to RESIDENTIAL (country DE) only if you see blocks on sustained high-volume runs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }