# WG-Gesucht Flatshare & Room Listings Scraper (`crawlerbros/wg-gesucht-scraper`) Actor

Scrape WG-Zimmer, apartment and room rental listings from WG-Gesucht.de, Germany's largest flatshare platform. Get price, size, rooms, district, availability, photo and listing URL for major German cities.

- **URL**: https://apify.com/crawlerbros/wg-gesucht-scraper.md
- **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community)
- **Categories:** Real estate, Automation, Integrations
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## WG-Gesucht Flatshare & Room Listings Scraper

Scrape shared-flat rooms, apartments and single-room listings from **WG-Gesucht.de** — Germany's largest platform for flatshares (Wohngemeinschaften), room rentals and apartment listings. Get price, size, room count, district, availability date, photo and direct listing URL for 14 major German cities.

### What does it scrape?

This actor scrapes WG-Gesucht's public search-results pages, returning:

- **Listing identity**: listing ID, title, direct listing URL
- **Pricing**: monthly rent in EUR
- **Layout**: living space in m², room count (or WG flatmate count for shared-flat rooms)
- **Location**: city, district/neighborhood, street
- **Availability**: move-in date as published
- **Media**: primary listing photo URL
- **Poster info**: verification status, poster/agency name, last-online status
- **Flatmates**: current flatmate gender composition (for shared-flat rooms)
- **Badges**: listing perks such as "Online-Besichtigung" (virtual tour available)

### Input

| Field | Type | Description |
|-------|------|-------------|
| `city` | string | German city to search (required) — see dropdown below |
| `listingType` | string | `wg_zimmer` (shared flat room), `wohnungen` (apartments), or `einzelzimmer` (1-room apartment) |
| `maxRentEur` | integer | Only return listings at or below this monthly rent in EUR |
| `minRooms` | integer | Only return listings with at least this many rooms / WG slots |
| `maxItems` | integer | Max listings to return (default 25, max 100) |

#### Supported cities

Berlin, München, Hamburg, Köln, Frankfurt am Main, Stuttgart, Düsseldorf, Leipzig, Dortmund, Essen, Nürnberg, Dresden, Hannover, Bremen.

### Output

Each record contains:

```json
{
  "listingId": "10056647",
  "title": "URBANELITE.COM // No deposit! // Friedrichshain prime location // furnished luxury room",
  "city": "Berlin",
  "neighborhood": "Friedrichshain",
  "street": "Revaler Straße",
  "price": 799,
  "sizeSqm": 15,
  "rooms": 6,
  "roomType": "6er WG",
  "availableFrom": "01.08.2026",
  "imageUrl": "https://img.wg-gesucht.de/media/up/2023/19/a6789ac82ed5f06e188adf06f19de8a3d5c9dc709750134670ecbd87fa0c7ee9_WhatsApp_Image_2023_05_03_at_11.32.31_AM.small.jpeg",
  "listingUrl": "https://www.wg-gesucht.de/wg-zimmer-in-Berlin-Friedrichshain.10056647.html",
  "sourceUrl": "https://www.wg-gesucht.de/wg-zimmer-in-Berlin.8.0.1.0.html",
  "scrapedAt": "2026-07-01T01:00:00+00:00",
  "recordType": "wg_zimmer",
  "isVerified": true,
  "posterName": "Urban Elite",
  "lastOnlineText": "Online: 10 Minuten",
  "flatmateGenderComposition": {"female": 1, "male": 1},
  "badges": ["Online-Besichtigung"]
}
````

`isVerified` is always present (`true`/`false`). `posterName`, `lastOnlineText`, `flatmateGenderComposition` and `badges` are included whenever WG-Gesucht's listing card exposes that data (gender composition only applies to shared-flat rooms with visible flatmate counts; badges only appear when the listing has a perk like a virtual tour).

### FAQs

**Does it require a WG-Gesucht account, login or cookies?**
No. This actor scrapes WG-Gesucht's public listing search pages without any authentication, cookies, or paid proxy.

**How many listings can I get per run?**
Up to 100 listings per run. WG-Gesucht shows roughly 20-30 listings per page and the actor paginates automatically until `maxItems` is reached.

**Can I filter by price or room count?**
Yes. Use `maxRentEur` to cap the monthly rent in EUR, and `minRooms` to require a minimum number of rooms (for apartments) or flatmate slots (for shared-flat rooms).

**What does `rooms` mean for a WG-Zimmer (shared flat room) listing?**
WG-Gesucht labels shared flats by total flatmate count (e.g. "6er WG" = a 6-person shared flat). The `rooms` field reflects that count so filtering behaves consistently across listing types; the original label is preserved in `roomType`.

**What's the difference between `Wohnungen` and `Einzelzimmer`?**
`Wohnungen` returns whole apartments of any size. `Einzelzimmer` returns WG-Gesucht's "1-Zimmer-Wohnung" category — self-contained single-room apartments, typically for one person.

**Which cities are supported?**
14 major German cities including Berlin, München, Hamburg, Köln and Frankfurt am Main. Select from the dropdown in the input schema.

**Are utilities included in the price?**
The price shown is the listed monthly rent from WG-Gesucht — utilities (Nebenkosten) may or may not be included depending on the individual listing's own description.

**Is the scraper affected by bot detection?**
WG-Gesucht occasionally shows a one-time human-verification page to IPs that request pages unusually fast. The actor detects this automatically and retries through Apify's free datacenter proxy pool, so runs stay reliable without any paid proxy.

# Actor input Schema

## `city` (type: `string`):

German city to search for listings.

## `listingType` (type: `string`):

Type of listing to search for: shared-flat room, whole apartment, or single-room apartment.

## `maxRentEur` (type: `integer`):

Only return listings at or below this monthly rent in EUR. Leave empty for no limit.

## `minRooms` (type: `integer`):

Only return listings with at least this many rooms (or WG flatmate slots). Leave empty for no limit.

## `maxItems` (type: `integer`):

Maximum number of listings to return (1-100, default 25).

## `proxyConfiguration` (type: `object`):

Used only as an automatic fallback if WG-Gesucht's rate-based bot check blocks the direct request. The free AUTO datacenter group is used by default; no paid proxy is required.

## Actor input object example

```json
{
  "city": "berlin",
  "listingType": "wg_zimmer",
  "maxItems": 25,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# Actor output Schema

## `listings` (type: `string`):

Dataset containing all scraped WG-Gesucht listings.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "city": "berlin",
    "listingType": "wg_zimmer",
    "maxItems": 25,
    "proxyConfiguration": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("crawlerbros/wg-gesucht-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "city": "berlin",
    "listingType": "wg_zimmer",
    "maxItems": 25,
    "proxyConfiguration": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("crawlerbros/wg-gesucht-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "city": "berlin",
  "listingType": "wg_zimmer",
  "maxItems": 25,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}' |
apify call crawlerbros/wg-gesucht-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=crawlerbros/wg-gesucht-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "WG-Gesucht Flatshare & Room Listings Scraper",
        "description": "Scrape WG-Zimmer, apartment and room rental listings from WG-Gesucht.de, Germany's largest flatshare platform. Get price, size, rooms, district, availability, photo and listing URL for major German cities.",
        "version": "1.0",
        "x-build-id": "hCiTd9hJN2uzvaiUF"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/crawlerbros~wg-gesucht-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~wg-gesucht-scraper/runs": {
            "post": {
                "operationId": "runs-sync-crawlerbros-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/crawlerbros~wg-gesucht-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-crawlerbros-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": [
                    "city"
                ],
                "properties": {
                    "city": {
                        "title": "City",
                        "enum": [
                            "berlin",
                            "muenchen",
                            "hamburg",
                            "koeln",
                            "frankfurt",
                            "stuttgart",
                            "duesseldorf",
                            "leipzig",
                            "dortmund",
                            "essen",
                            "nuernberg",
                            "dresden",
                            "hannover",
                            "bremen"
                        ],
                        "type": "string",
                        "description": "German city to search for listings.",
                        "default": "berlin"
                    },
                    "listingType": {
                        "title": "Listing Type",
                        "enum": [
                            "wg_zimmer",
                            "wohnungen",
                            "einzelzimmer"
                        ],
                        "type": "string",
                        "description": "Type of listing to search for: shared-flat room, whole apartment, or single-room apartment.",
                        "default": "wg_zimmer"
                    },
                    "maxRentEur": {
                        "title": "Maximum Rent (EUR/month)",
                        "minimum": 1,
                        "maximum": 20000,
                        "type": "integer",
                        "description": "Only return listings at or below this monthly rent in EUR. Leave empty for no limit."
                    },
                    "minRooms": {
                        "title": "Minimum Rooms",
                        "minimum": 0,
                        "maximum": 20,
                        "type": "integer",
                        "description": "Only return listings with at least this many rooms (or WG flatmate slots). Leave empty for no limit."
                    },
                    "maxItems": {
                        "title": "Max Listings",
                        "minimum": 1,
                        "maximum": 100,
                        "type": "integer",
                        "description": "Maximum number of listings to return (1-100, default 25).",
                        "default": 25
                    },
                    "proxyConfiguration": {
                        "title": "Proxy configuration",
                        "type": "object",
                        "description": "Used only as an automatic fallback if WG-Gesucht's rate-based bot check blocks the direct request. The free AUTO datacenter group is used by default; no paid proxy is required.",
                        "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
