{ "openapi": "3.0.1", "info": { "title": "WG-Gesucht Scraper - Rental Listings & Housing Requests", "description": "Search rooms, apartments, houses, and housing requests on wg-gesucht.de across Germany and nearby European countries by location, rent, dates, size, amenities, and flatshare preferences. Export JSON, CSV, or Excel data, connect through the API or MCP, compare markets, and find your next home faster.", "version": "0.0", "x-build-id": "e2FnBWLJBJW8YdEop" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~wg-gesucht-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-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/igolaizola~wg-gesucht-scraper/runs": { "post": { "operationId": "runs-sync-igolaizola-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/igolaizola~wg-gesucht-scraper/run-sync": { "post": { "operationId": "run-sync-igolaizola-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", "required": [ "type" ], "properties": { "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Maximum listings to return; 0 collects every available result.", "default": 100 }, "location": { "title": "Location", "type": "string", "description": "Location name to search, such as Berlin or Munich. The actor resolves it automatically. Leave empty when using coordinates." }, "country": { "title": "Country", "enum": [ "", "de", "at", "be", "ch", "cz", "dk", "fr", "lu", "nl", "pl" ], "type": "string", "description": "Limit location matching to a country when a name exists in multiple countries.", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "", "newest", "oldest", "lowest-rent", "highest-rent", "smallest-size", "largest-size" ], "type": "string", "description": "Sort listings by newest, oldest, lowest rent, highest rent, smallest size, or largest size.", "default": "" }, "fetchDetails": { "title": "Fetch full details", "type": "boolean", "description": "Fetch one additional detail record per result and store it in _details. This increases run time and PPE cost.", "default": false }, "type": { "title": "Listing type", "enum": [ "offers", "requests" ], "type": "string", "description": "Search available listings or housing requests.", "default": "offers" }, "propertyType": { "title": "Property type", "enum": [ "shared-room", "one-room-apartment", "apartment", "house" ], "type": "string", "description": "Primary home type to search for.", "default": "shared-room" }, "rentalPeriod": { "title": "Rental period", "enum": [ "any", "long-term", "short-term", "daily" ], "type": "string", "description": "Preferred rental period.", "default": "any" }, "language": { "title": "Listing language", "enum": [ "de", "en" ], "type": "string", "description": "Language for translated listing text where available.", "default": "de" }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Center latitude for a coordinate search, from -90 to 90. Use together with longitude and radiusKm. Coordinates take precedence over Location." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Center longitude for a coordinate search, from -180 to 180. Use together with latitude and radiusKm." }, "radiusKm": { "title": "Search radius (km)", "minimum": 1, "type": "integer", "description": "Search radius around the latitude/longitude point, in kilometres. Use with both coordinates." }, "includeDeactivated": { "title": "Include inactive listings", "type": "boolean", "description": "Include listings marked inactive by the platform.", "default": false }, "minRent": { "title": "Minimum rent", "minimum": 0, "type": "integer", "description": "Minimum advertised rent or total monthly cost, depending on listing type." }, "maxRent": { "title": "Maximum rent", "minimum": 0, "type": "integer", "description": "Maximum advertised rent or total monthly cost, depending on listing type." }, "minRooms": { "title": "Minimum rooms", "minimum": 2, "maximum": 9.5, "type": "number", "description": "Minimum number of rooms from 2 to 9.5; half-room values are supported." }, "maxRooms": { "title": "Maximum rooms", "minimum": 2, "maximum": 9.5, "type": "number", "description": "Maximum number of rooms from 2 to 9.5; half-room values are supported." }, "minSize": { "title": "Minimum size", "minimum": 0, "type": "integer", "description": "Minimum property size in square metres." }, "maxSize": { "title": "Maximum size", "minimum": 0, "type": "integer", "description": "Maximum property size in square metres." }, "ageMin": { "title": "Minimum household age", "minimum": 0, "type": "integer", "description": "Minimum age requested by the flatshare or listing." }, "ageMax": { "title": "Maximum household age", "minimum": 0, "type": "integer", "description": "Maximum age requested by the flatshare or listing." }, "dateFrom": { "title": "Available from", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Earliest desired move-in date (YYYY-MM-DD)." }, "dateTo": { "title": "Available to", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Latest desired move-out date (YYYY-MM-DD)." }, "dateFromDeviation": { "title": "Move-in date flexibility (days)", "minimum": 0, "type": "integer", "description": "Optional number of days of flexibility around the start date." }, "dateToDeviation": { "title": "Move-out date flexibility (days)", "minimum": 0, "type": "integer", "description": "Optional number of days of flexibility around the end date." }, "newOffersSince": { "title": "New offers since", "enum": [ "", "last-3-days", "last-week", "last-2-weeks", "last-3-weeks", "last-month", "last-2-months", "last-3-months" ], "type": "string", "description": "Only include listings added within the selected recent period.", "default": "" }, "furnished": { "title": "Furnishing", "enum": [ "", "furnished", "unfurnished", "partly-furnished" ], "type": "string", "description": "Preferred furnishing state.", "default": "" }, "kitchen": { "title": "Kitchen", "enum": [ "", "yes", "no" ], "type": "string", "description": "Whether a kitchen is present.", "default": "" }, "hasBalcony": { "title": "Balcony or terrace", "type": "boolean", "description": "Only listings with a balcony or terrace.", "default": false }, "hasGarden": { "title": "Garden", "type": "boolean", "description": "Only listings with a garden.", "default": false }, "hasKitchen": { "title": "Kitchen (legacy toggle)", "type": "boolean", "description": "Only listings with a kitchen. Use Kitchen for an explicit yes or no choice.", "default": false }, "accessible": { "title": "Handicapped accessible", "type": "boolean", "description": "Only listings with accessibility features.", "default": false }, "imagesOnly": { "title": "Listings with images", "type": "boolean", "description": "Only listings that include images.", "default": false }, "onlineViewing": { "title": "Online viewing", "type": "boolean", "description": "Only listings offering online viewing.", "default": false }, "excludeContacted": { "title": "Exclude contacted", "type": "boolean", "description": "Exclude listings already contacted by the account.", "default": false }, "swap": { "title": "Swap preference", "enum": [ "", "available", "not-available" ], "type": "string", "description": "Filter listings by apartment-swap availability.", "default": "" }, "swapOnly": { "title": "Apartment swap (legacy toggle)", "type": "boolean", "description": "Only listings available for an apartment swap. Use Swap preference for an explicit choice.", "default": false }, "flatshareSuitability": { "title": "Flatshare suitability", "enum": [ "", "suitable", "not-suitable" ], "type": "string", "description": "Whether the listing is marked as suitable for a flatshare.", "default": "" }, "flatshareFriendly": { "title": "Flatshare friendly (legacy toggle)", "type": "boolean", "description": "Only listings marked as flatshare friendly. Use Flatshare suitability for an explicit choice.", "default": false }, "petsAllowed": { "title": "Pets allowed (legacy toggle)", "type": "boolean", "description": "Only listings that allow pets. Use Pet policy for an explicit choice.", "default": false }, "petPolicy": { "title": "Pet policy", "enum": [ "", "allowed", "not-allowed" ], "type": "string", "description": "Filter whether pets are allowed.", "default": "" }, "petsPresent": { "title": "Pets already present", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filter whether pets are already present in the household.", "default": "" }, "floorLevel": { "title": "Floor level", "enum": [ "", "ground", "1st", "2nd", "3rd", "4th", "5th", "higher-than-5th", "cellar", "basement", "raised-ground-floor", "loft-attic" ], "type": "string", "description": "Choose a platform floor category: ground, 1st, 2nd, 3rd, 4th, 5th, higher-than-5th, cellar, basement, raised-ground-floor, or loft-attic.", "default": "" }, "gender": { "title": "Preferred renter genders", "type": "array", "description": "Select one or more genders the listing is seeking: female, male, diverse, or unspecified.", "items": { "type": "string", "enum": [ "female", "male", "diverse", "unspecified" ], "enumTitles": [ "Female", "Male", "Diverse", "Unspecified" ] } }, "flatmateGender": { "title": "Existing flatmate gender", "enum": [ "", "any", "female", "male", "diverse", "unspecified" ], "type": "string", "description": "Filter by the gender of the flatmates already living in the household.", "default": "" }, "smoking": { "title": "Smoking preference", "enum": [ "", "smoker", "non-smoker" ], "type": "string", "description": "For housing requests, choose whether the applicant smokes.", "default": "" }, "flatshareSmoking": { "title": "Existing flatshare smoking", "enum": [ "", "anywhere", "in-own-room", "on-balcony", "not-at-all" ], "type": "string", "description": "Where smoking is acceptable in the existing flatshare: anywhere, in own room, on balcony, or not at all.", "default": "" }, "flatshareTypes": { "title": "Flatshare suitability tags", "type": "array", "description": "Select one or more flatshare tags exposed by WG-Gesucht.", "items": { "type": "string", "enum": [ "students-only", "female-only", "male-only", "business-people", "fraternity", "workers-only", "trainee", "seniors-only", "with-children", "residential-home", "communal", "mixed-gender", "varied-age", "fifty-plus", "vegetarian-vegan", "lgbtqia-friendly", "room-for-help", "single-parents-only", "internationals-welcome", "inclusive", "functional", "new-flatshare", "not-specified", "non-communal" ], "enumTitles": [ "Students only", "Female only", "Male only", "Business people", "Fraternity", "Workers only", "Trainee", "Seniors only", "With children", "Residential home", "Communal", "Mixed gender", "Varied age", "50+", "Vegetarian / vegan", "LGBTQIA-friendly", "Room for help", "Single parents only", "International residents welcome", "Inclusive", "Functional", "New flatshare", "Not specified", "Non-communal" ] } }, "myAge": { "title": "Your age", "minimum": 0, "type": "integer", "description": "Your age for flatshare matching." }, "myGender": { "title": "Your gender", "enum": [ "", "female", "male", "diverse", "unspecified" ], "type": "string", "description": "Your gender for flatshare matching.", "default": "" }, "minFlatshareSize": { "title": "Minimum current flatmates", "minimum": 0, "type": "integer", "description": "Minimum number of people already living in the flatshare." }, "maxFlatshareSize": { "title": "Maximum current flatmates", "minimum": 0, "type": "integer", "description": "Maximum number of people already living in the flatshare." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }