# Inberlinwohnen — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse affordable apartment listings from Berlin's state-owned housing companies, view detailed property information, and access company profiles and tenant guides. Find your next home in Berlin with comprehensive data on available rentals and housing provider information in one place.

**Category:** Real Estate | **Website:** [inberlinwohnen.de/](https://inberlinwohnen.de/) | **Docs:** [parse.bot/marketplace/6dcd2ac5-1e51-4ee5-8cb4-276a14295399/inberlinwohnen-de-api](https://parse.bot/marketplace/6dcd2ac5-1e51-4ee5-8cb4-276a14295399/inberlinwohnen-de-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get all listings

Extract all available apartment listings from the Wohnungsfinder. Paginates through Livewire pages server-side and returns the full set of currently advertised apartments. Each apartment includes address, rent, rooms, area, company, and energy data. Typically 10-50 listings total across all pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit_pages` | integer | No | Maximum number of pages to scrape. Each page contains ~10 apartments. If omitted, scrapes all available pages. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/get-all-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit_pages":"<integer>"}'
```

### Get gut zu wissen

Retrieve informational articles and guides from the 'Gut zu wissen' navigation section. Returns article titles and their URLs on inberlinwohnen.de covering topics like WBS, energy saving, tenant rights, housing subsidies, and living situations.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/get-gut-zu-wissen \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get landeseigene companies

Retrieve information about Berlin's seven state-owned housing companies (landeseigene Wohnungsbaugesellschaften). Returns the company names. These are the companies whose apartments appear in the Wohnungsfinder listings.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/get-landeseigene-companies \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get listing detail

Get detailed information for a specific apartment by its internal numeric ID. Fetches all listings and returns the matching one. Returns the full apartment object with address, rent, rooms, area, energy data, and company information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `apartment_id` | string | Yes | The apartment's internal numeric ID (e.g. '17790') or object ID string (e.g. 'ESQ 1950/33559/85'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/get-listing-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"apartment_id":"<string>"}'
```

### Search listings

Search and filter apartment listings by various criteria. Fetches all listings from the Wohnungsfinder and applies client-side filters for district, company, rooms, area, and rent. All filters are optional and combine with AND logic. Returns only apartments matching all specified criteria.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `area_min` | number | No | Minimum apartment area in sqm. |
| `company` | string | No | Filter by housing company name (case-insensitive partial match). Examples: 'degewo', 'Gewobag', 'HOWOGE', 'GESOBAU', 'STADT UND LAND', 'WBM', 'berlinovo'. |
| `district` | string | No | Filter by Berlin district name (case-insensitive partial match). Examples: 'Spandau', 'Mitte', 'Lichtenberg', 'Marzahn-Hellersdorf'. |
| `rent_max` | number | No | Maximum cold rent in EUR. |
| `rooms_max` | integer | No | Maximum number of rooms. |
| `rooms_min` | integer | No | Minimum number of rooms. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/inberlinwohnen/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"area_min":"<number>","company":"<string>","district":"<string>","rent_max":"<number>","rooms_max":"<integer>","rooms_min":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.