{ "openapi": "3.0.1", "info": { "title": "WG-Gesucht Scraper - German Flatshare & Rentals", "description": "WG-Gesucht API alternative: scrape German flatshare & apartment rental listings without login and export to CSV, JSON or Excel. No API key.", "version": "1.0", "x-build-id": "8SBCuA7udMHaULWu1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~wg-gesucht-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-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/logiover~wg-gesucht-scraper/runs": { "post": { "operationId": "runs-sync-logiover-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/logiover~wg-gesucht-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-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": { "searchUrls": { "title": "Search URLs (advanced)", "type": "array", "description": "OPTIONAL. Paste full WG-Gesucht search URLs copied straight from the site to reuse every filter you set there (price, district, WG size, etc.). Examples: https://www.wg-gesucht.de/wohnungen-in-Berlin.8.2.1.0.html (apartments) or https://www.wg-gesucht.de/wg-zimmer-in-Muenchen.90.0.1.0.html (flatshare rooms). Leave empty to use the City + Property type pickers below instead.", "default": [], "items": { "type": "string" } }, "city": { "title": "City", "enum": [ "Berlin", "Muenchen", "Hamburg", "Koeln", "Frankfurt-am-Main", "Stuttgart", "Duesseldorf", "Leipzig", "Dortmund", "Essen", "Dresden", "Bremen", "Hannover", "Nuernberg", "Bonn", "Mannheim", "Karlsruhe", "Freiburg-im-Breisgau", "Muenster", "Aachen", "Heidelberg", "Wuerzburg", "Augsburg", "Bielefeld", "Wiesbaden", "Kiel", "Mainz", "Kassel", "Regensburg", "Darmstadt" ], "type": "string", "description": "Used only when no Search URLs are given. Which German city to pull listings for.", "default": "Berlin" }, "category": { "title": "Property type", "enum": [ "apartments", "wg-rooms", "1-room-flats", "houses" ], "type": "string", "description": "Used only when no Search URLs are given. What kind of place to look for.", "default": "apartments" }, "rentType": { "title": "Rental period", "enum": [ "any", "permanent", "temporary" ], "type": "string", "description": "Used only when no Search URLs are given. Long-term or limited/temporary (befristet) rentals.", "default": "any" }, "sortBy": { "title": "Sort order", "enum": [ "newest", "price-asc", "price-desc", "size-desc", "rooms-desc" ], "type": "string", "description": "Used only when no Search URLs are given. How to order the search results.", "default": "newest" }, "maxResults": { "title": "Max results (total)", "minimum": 0, "type": "integer", "description": "Stop after this many listings across all search URLs. 0 = no limit (a single city search can span 50+ pages / 1,000+ listings).", "default": 200 }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 0, "type": "integer", "description": "Cap listings per individual search URL. 0 = no per-search cap.", "default": 0 }, "useProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through Apify Proxy. Residential is recommended and is the default for a German site.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Residential gives the highest success rate on WG-Gesucht.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Max concurrent searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many search URLs to process in parallel.", "default": 3 } } }, "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 } } } } } } } } } }