Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"lat": {
"type": "number",
"description": "Latitude for nearby search; must be provided with lng (+ radiusKm). Do not mix with areas."
},
"lng": {
"type": "number",
"description": "Longitude for nearby search; must be provided with lat (+ radiusKm). Do not mix with areas."
},
"page": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Page number (default 1).",
"exclusiveMinimum": 0
},
"areas": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Canonical Berlin area IDs from list_areas (e.g. berlin:ortsteil:prenzlauer-berg). Up to 20 IDs; multiple IDs are combined with OR. District / Ortsteil mode — do not mix with lat/lng/radiusKm. When the user names an area, call list_areas first. Pass only canonical IDs returned by list_areas. Never construct, translate, normalize, or guess IDs."
},
"limit": {
"type": "integer",
"maximum": 20,
"description": "Results per page (default 10, max 20).",
"exclusiveMinimum": 0
},
"rooms": {
"type": "array",
"items": {
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"studio"
],
"type": "string"
},
"maxItems": 10,
"description": "Exact room counts (OR). Allowed values only: \"studio\", \"1\", \"2\", …, \"10\" (strings, not numbers). Prefer over roomsMin/roomsMax for \"1–2 rooms\": [\"1\",\"2\"] or [\"studio\",\"1\"]."
},
"sortBy": {
"enum": [
"rank",
"price",
"squareMeters",
"createdAt",
"availableFrom"
],
"type": "string",
"description": "Sort field (default rank). sortOrder is ignored when sortBy=rank. Cheaper first → price+asc; larger area → squareMeters+desc."
},
"postCode": {
"type": "string",
"description": "Exact Berlin post code (PLZ), e.g. 10115."
},
"priceMax": {
"type": "number",
"minimum": 0,
"description": "Maximum monthly price in EUR."
},
"priceMin": {
"type": "number",
"minimum": 0,
"description": "Minimum monthly price in EUR."
},
"radiusKm": {
"type": "number",
"maximum": 25,
"minimum": 0.1,
"description": "Search radius in km around lat/lng (min 0.1, max 25). Nearby mode — do not mix with areas."
},
"roomType": {
"enum": [
"private",
"shared"
],
"type": "string",
"description": "Room occupancy: private = one private bedroom in shared housing; shared = a bed in a shared bedroom. Omit to include both. housingType=room remains the broad backwards-compatible filter."
},
"roomsMax": {
"type": "number",
"minimum": 0,
"description": "Maximum rooms. Prefer rooms[] for exact OR lists."
},
"roomsMin": {
"type": "number",
"minimum": 0,
"description": "Minimum rooms (studio = 0). Prefer rooms[] for exact OR lists."
},
"providers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "Restrict to specific housing providers (ids from the providers catalog)."
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default desc). Ignored when sortBy=rank."
},
"depositMax": {
"type": "number",
"minimum": 0,
"description": "Maximum deposit (Kaution) in EUR."
},
"amenityTags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 10,
"description": "Canonical amenity tags (AND). Backend filters listings that have ALL of these tags. Catalog (snake_case only): wifi, parking, bike_parking, wheelchair, dishwasher, washing_machine, dryer, elevator, balcony, desk, tv, oven, heating, furnished, fridge, microwave, cooktop, coffee_machine, iron, hair_dryer, closet, wardrobe, bed, bathtub, shower, garden, basement, air_conditioning, parking_street, workspace, fitness, concierge, laundry, pets_friendly. Do not invent aliases (wiFi, hasWifi, Waschmaschine)."
},
"availableTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Available until / not later than (YYYY-MM-DD)."
},
"bedroomsMin": {
"type": "number",
"minimum": 0,
"description": "Minimum number of bedrooms (from provider extra data when available)."
},
"housingType": {
"enum": [
"room",
"apartment"
],
"type": "string",
"description": "Type of housing. Studios map to apartment; room includes both private and shared rooms unless roomType narrows it."
},
"petsAllowed": {
"type": "boolean",
"description": "true = pets explicitly allowed."
},
"availableFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Available from / not earlier than (YYYY-MM-DD), e.g. \"2026-08-01\"."
},
"personsMaxMin": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Minimum capacity (personsMax). Use 2 for couples, 1 for solo — filters listings that can accommodate at least this many people.",
"exclusiveMinimum": 0
},
"noSchufaLikely": {
"type": "boolean",
"description": "true = Schufa likely not required (broader). Prefer for \"without Schufa\"."
},
"schufaRequired": {
"type": "boolean",
"description": "true = Schufa required."
},
"smokingAllowed": {
"type": "boolean",
"description": "false = non-smokers only / smoking not allowed."
},
"anmeldungLikely": {
"type": "boolean",
"description": "true = Anmeldung likely (broader). Prefer for \"with Anmeldung\" unless the user needs a hard guarantee."
},
"squareMetersMax": {
"type": "number",
"minimum": 0,
"description": "Maximum living area in m²."
},
"squareMetersMin": {
"type": "number",
"minimum": 0,
"description": "Minimum living area in m². \"from 40 m²\" → 40. Filter on the backend — do not paginate to drop small listings."
},
"noSchufaRequired": {
"type": "boolean",
"description": "true = Schufa explicitly not required (strict)."
},
"studentsFriendly": {
"type": "boolean",
"description": "true = student-oriented housing (broader)."
},
"onlyStudentsAllowed": {
"type": "boolean",
"description": "true = students-only listings."
},
"registrationPossible": {
"type": "boolean",
"description": "true = Anmeldung / registration explicitly possible (strict)."
}
}
}