Input schema (JSON)
{
"type": "object",
"properties": {
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Where — a city (\"München\", \"Frankfurt am Main\") or a postcode (\"80331\")."
},
"page": {
"type": "integer",
"default": 1,
"description": "Result page, starting at 1."
},
"vacant": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Only listings that are vacant (bezugsfrei)."
},
"roi_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum gross rental yield in percent, e.g. 5 for 5 %. Purchases only."
},
"features": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"balcony",
"garden",
"elevator",
"parking",
"kitchen",
"new_building"
],
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"description": "Required amenities. \"new_building\" keeps only new builds\n(Neubau, Erstbezug, or built within the last 3 years)."
},
"per_page": {
"type": "integer",
"default": 20,
"description": "Results per page, at most 50."
},
"property": {
"enum": [
"wohnung",
"haus"
],
"type": "string",
"default": "wohnung",
"description": "\"wohnung\" (apartment) or \"haus\" (house)."
},
"size_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum living space in m²."
},
"size_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum living space in m²."
},
"year_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Built before this year."
},
"year_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Built in or after this year."
},
"price_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum price in EUR; monthly cold rent when transaction is \"mieten\"."
},
"price_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum price in EUR; monthly cold rent when transaction is \"mieten\"."
},
"rooms_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum number of rooms."
},
"rooms_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum number of rooms (German count, e.g. 2.5)."
},
"transaction": {
"enum": [
"kaufen",
"mieten"
],
"type": "string",
"default": "kaufen",
"description": "\"kaufen\" to buy, \"mieten\" to rent."
},
"energy_class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Energy efficiency classes, e.g. \"A+,A,B\"."
},
"price_change": {
"anyOf": [
{
"enum": [
"reduced",
"increased",
"any"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only listings whose price changed while listed: \"reduced\",\n\"increased\" or \"any\"."
},
"price_per_sqm_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum price per m² in EUR; cold rent per m² when\ntransaction is \"mieten\"."
},
"price_per_sqm_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum price per m² in EUR; cold rent per m² when\ntransaction is \"mieten\"."
},
"renovation_needed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Only listings that need renovation (renovierungsbedürftig)."
},
"price_below_market": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Only listings priced below Somantic's valuation."
},
"exclude_erbbaurecht": {
"type": "boolean",
"default": false,
"description": "Leave out leasehold (Erbbaurecht) properties."
},
"exclude_foreclosures": {
"type": "boolean",
"default": false,
"description": "Leave out foreclosure auctions (Zwangsversteigerungen)."
}
},
"additionalProperties": false
}