Objelio Immobiliensuche

Search published real estate listings on Objelio. Pass structured criteria (preferred) or the user's request as text. Returns up to 10 listings with price, area, rooms, a fit per criterion (erfuellt = met, abweichend = slightly outside, unbekannt = no information) and a link to the listing page where the user can contact the agent.

{
  "type": "object",
  "properties": {
    "criteria": {
      "description": "Structured search criteria. Leave out fields the user did not mention.",
      "type": "object",
      "properties": {
        "offer_type": {
          "description": "\"kauf\" (buy) or \"miete\" (rent). Currently almost all listings are for sale.",
          "type": "string",
          "enum": [
            "kauf",
            "miete"
          ]
        },
        "property_types": {
          "description": "wohnung (apartment), haus (house), grundstueck (building plot).",
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "wohnung",
              "haus",
              "grundstueck"
            ]
          }
        },
        "property_subtypes": {
          "description": "Only if the user explicitly names a subtype, e.g. doppelhaushaelfte (semi-detached house), reihenhaus, penthouse.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "etage",
              "erdgeschoss",
              "dachgeschoss",
              "maisonette",
              "penthouse",
              "terrassen",
              "souterrain",
              "loft",
              "apartment",
              "einfamilienhaus",
              "doppelhaushaelfte",
              "reihenmittelhaus",
              "reihenendhaus",
              "zweifamilienhaus",
              "mehrfamilienhaus",
              "bungalow",
              "villa",
              "stadthaus",
              "bauernhaus",
              "wohnen",
              "gemischt",
              "freizeit"
            ]
          }
        },
        "locations": {
          "description": "Several locations mean any of them. With umkreis_km, listings around the place are found and each result has entfernung_km.",
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ort": {
                "description": "Town or city, e.g. Paderborn. Also matches district names.",
                "type": "string",
                "maxLength": 80
              },
              "plz": {
                "description": "German postal code or its beginning, e.g. 33104 or 331.",
                "type": "string",
                "pattern": "^\\d{2,5}$"
              },
              "ortsteil": {
                "description": "District, e.g. Schloß Neuhaus. Ignored with umkreis_km.",
                "type": "string",
                "maxLength": 80
              },
              "umkreis_km": {
                "description": "Radius in km around ort or a five-digit plz, for requests like \"within 20 km of Bielefeld\" or \"near Paderborn\" (use 10 km when no number is given). Covers all of Germany.",
                "type": "number",
                "minimum": 1,
                "maximum": 100
              }
            },
            "additionalProperties": false
          }
        },
        "price_max_eur": {
          "description": "Maximum price in EUR.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "price_min_eur": {
          "description": "Minimum price in EUR.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "living_area_min_qm": {
          "description": "Minimum living area in square meters.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "rooms_min": {
          "description": "Minimum number of rooms (German count, kitchen and bath excluded).",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "year_built_min": {
          "description": "Built in or after this year.",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "features_required": {
          "description": "Must-have features. Listings without information stay in the results as unknown.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "balkon",
              "terrasse",
              "garten",
              "aufzug",
              "keller",
              "einbaukueche",
              "gaeste_wc",
              "barrierefrei",
              "stellplatz"
            ]
          }
        },
        "features_preferred": {
          "description": "Nice-to-have features, only affect the order.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "balkon",
              "terrasse",
              "garten",
              "aufzug",
              "keller",
              "einbaukueche",
              "gaeste_wc",
              "barrierefrei",
              "stellplatz"
            ]
          }
        },
        "notes_unmapped": {
          "description": "Wishes that fit no field (e.g. quiet location). They do not filter and are shown back to the user.",
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "additionalProperties": false
    },
    "text": {
      "description": "The user's request in their own words (German or English), used only if criteria is missing.",
      "type": "string",
      "maxLength": 500
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "suche_id": {
      "description": "Pass to get_listing as search_id.",
      "type": [
        "string",
        "null"
      ]
    },
    "kriterien": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The applied criteria in German words."
    },
    "nicht_beruecksichtigt": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Wishes that did not filter."
    },
    "anzahl": {
      "type": "number",
      "description": "Total number of matching listings, demo listings included."
    },
    "anzahl_echt": {
      "type": "number",
      "description": "Number of real listings (without demo listings). Real listings come first in treffer."
    },
    "treffer": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rang": {
            "type": "number"
          },
          "id": {
            "type": "string",
            "description": "Listing id for get_listing."
          },
          "titel": {
            "type": [
              "string",
              "null"
            ]
          },
          "objektart": {
            "type": "string",
            "description": "Property type in German, e.g. Etagenwohnung, Einfamilienhaus."
          },
          "angebot": {
            "type": "string",
            "enum": [
              "kauf",
              "miete"
            ],
            "description": "kauf = for sale, miete = for rent."
          },
          "plz": {
            "type": [
              "string",
              "null"
            ]
          },
          "ort": {
            "type": [
              "string",
              "null"
            ]
          },
          "ortsteil": {
            "type": [
              "string",
              "null"
            ]
          },
          "entfernung_km": {
            "description": "Only for radius searches: straight-line distance in km to the searched place (null = unknown). Not a driving distance.",
            "type": [
              "number",
              "null"
            ]
          },
          "preis_eur": {
            "type": [
              "number",
              "null"
            ]
          },
          "preis_auf_anfrage": {
            "type": "boolean",
            "description": "true = the agent does not publish the price (price on request); preis_eur is then null. Say so and never estimate a price."
          },
          "wohnflaeche_qm": {
            "type": [
              "number",
              "null"
            ]
          },
          "grundstueck_qm": {
            "type": [
              "number",
              "null"
            ]
          },
          "zimmer": {
            "type": [
              "number",
              "null"
            ]
          },
          "demo": {
            "type": "boolean",
            "description": "true = demo listing with invented data, not for sale or rent."
          },
          "link": {
            "description": "Listing page on objelio.de, where the user contacts the agent. Always show it.",
            "type": [
              "string",
              "null"
            ]
          },
          "titelbild": {
            "description": "URL of the main photo.",
            "type": [
              "string",
              "null"
            ]
          },
          "passung": {
            "type": "object",
            "properties": {
              "erfuellt": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Criteria the listing meets."
              },
              "abweichend": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Criteria the listing misses slightly."
              },
              "unbekannt": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Criteria the agent gave no information on."
              }
            },
            "required": [
              "erfuellt",
              "abweichend",
              "unbekannt"
            ],
            "additionalProperties": false,
            "description": "Fit per search criterion, in German."
          }
        },
        "required": [
          "rang",
          "id",
          "titel",
          "objektart",
          "angebot",
          "plz",
          "ort",
          "ortsteil",
          "preis_eur",
          "preis_auf_anfrage",
          "wohnflaeche_qm",
          "grundstueck_qm",
          "zimmer",
          "demo",
          "link",
          "titelbild",
          "passung"
        ],
        "additionalProperties": false
      }
    },
    "vorschlaege": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string"
          },
          "anzahl": {
            "type": "number"
          },
          "link": {
            "type": "string",
            "description": "This wider search on objelio.de."
          }
        },
        "required": [
          "text",
          "anzahl",
          "link"
        ],
        "additionalProperties": false
      },
      "description": "Wider searches with their number of real listings, only when there is no real listing. Offer them to the user."
    },
    "alle_treffer_auf_objelio": {
      "type": "string",
      "description": "The same search on objelio.de."
    },
    "suchauftrag_link": {
      "description": "Page on objelio.de to get new matching listings by e-mail. The user enters the address there, never in the chat.",
      "type": [
        "string",
        "null"
      ]
    },
    "vergleich_link": {
      "description": "Side-by-side comparison of the first three listings on objelio.de, where the user can save them and contact the agents.",
      "type": [
        "string",
        "null"
      ]
    },
    "suchprofil_link": {
      "description": "Short questionnaire on objelio.de (location, size, budget, financing) with budget range, purchase costs, matching listings and a search alert. Offer it when the user's wishes are still vague.",
      "type": "string"
    },
    "hinweis": {
      "type": "string"
    }
  },
  "required": [
    "suche_id",
    "kriterien",
    "nicht_beruecksichtigt",
    "anzahl",
    "anzahl_echt",
    "treffer",
    "vorschlaege",
    "alle_treffer_auf_objelio",
    "suchauftrag_link",
    "vergleich_link",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Full published details of one listing: description, features, energy certificate, commission (Courtage), the offering agent and the link to the listing page.

{
  "type": "object",
  "properties": {
    "listing_id": {
      "type": "string",
      "maxLength": 200,
      "description": "The id from search_listings."
    },
    "search_id": {
      "description": "The suche_id from search_listings, so an inquiry can be linked to the search.",
      "type": "string",
      "maxLength": 36
    }
  },
  "required": [
    "listing_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "link": {
      "description": "Listing page on objelio.de, where the user contacts the agent. Always show it.",
      "type": [
        "string",
        "null"
      ]
    },
    "demo": {
      "type": "boolean"
    },
    "demo_hinweis": {
      "type": "string"
    },
    "titel": {
      "type": [
        "string",
        "null"
      ]
    },
    "objektart": {
      "type": "string"
    },
    "angebot": {
      "type": "string",
      "enum": [
        "kauf",
        "miete"
      ]
    },
    "lage": {
      "type": [
        "string",
        "null"
      ]
    },
    "plz": {
      "type": [
        "string",
        "null"
      ]
    },
    "ort": {
      "type": [
        "string",
        "null"
      ]
    },
    "ortsteil": {
      "type": [
        "string",
        "null"
      ]
    },
    "preis_eur": {
      "type": [
        "number",
        "null"
      ]
    },
    "preis_auf_anfrage": {
      "type": "boolean",
      "description": "true = the agent does not publish the price (price on request); preis_eur is then null. Say so and never estimate a price."
    },
    "merkmale": {
      "type": "object",
      "properties": {
        "Balkon": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Terrasse": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Garten": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Aufzug": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Keller": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Einbauküche": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Gäste-WC": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Barrierefrei": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "Stellplatz": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "additionalProperties": false,
      "description": "Features: true, false or null (no information)."
    },
    "beschreibung": {
      "type": [
        "string",
        "null"
      ]
    },
    "ausstattung": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "energieausweis": {
      "type": "object",
      "properties": {
        "art": {
          "type": [
            "string",
            "null"
          ]
        },
        "kennwert_kwh_qm_jahr": {
          "type": [
            "number",
            "null"
          ]
        },
        "energietraeger": {
          "type": [
            "string",
            "null"
          ]
        },
        "baujahr_laut_ausweis": {
          "description": "Year of construction of the building according to the energy certificate.",
          "type": [
            "number",
            "null"
          ]
        },
        "baujahr_waermeerzeuger": {
          "description": "Year the heating system (heat generator) was built, if stated.",
          "type": [
            "number",
            "null"
          ]
        },
        "energieklasse": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "art",
        "kennwert_kwh_qm_jahr",
        "energietraeger",
        "baujahr_laut_ausweis",
        "baujahr_waermeerzeuger",
        "energieklasse"
      ],
      "additionalProperties": false
    },
    "courtage": {
      "type": "object",
      "properties": {
        "prozent": {
          "type": [
            "number",
            "null"
          ]
        },
        "hinweis": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "prozent",
        "hinweis"
      ],
      "additionalProperties": false,
      "description": "Buyer's commission."
    },
    "anbieter": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "firma": {
              "type": [
                "string",
                "null"
              ]
            },
            "ansprechpartner": {
              "type": [
                "string",
                "null"
              ]
            },
            "anschrift": {
              "type": [
                "string",
                "null"
              ]
            },
            "telefon": {
              "type": [
                "string",
                "null"
              ]
            },
            "handelsregister": {
              "type": [
                "string",
                "null"
              ]
            },
            "ust_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "aufsichtsbehoerde": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "firma",
            "ansprechpartner",
            "anschrift",
            "telefon",
            "handelsregister",
            "ust_id",
            "aufsichtsbehoerde"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "The offering agent."
    },
    "titelbild": {
      "type": [
        "string",
        "null"
      ]
    },
    "bilder": {
      "description": "URLs of up to 8 photos in the agent's order; the first is titelbild.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "veroeffentlicht_am": {
      "type": [
        "string",
        "null"
      ]
    },
    "bestaetigt_am": {
      "description": "When the agent last confirmed that the listing and its details are current.",
      "type": [
        "string",
        "null"
      ]
    },
    "hinweis": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "link",
    "demo",
    "titel",
    "objektart",
    "angebot",
    "lage",
    "plz",
    "ort",
    "ortsteil",
    "preis_eur",
    "preis_auf_anfrage",
    "merkmale",
    "beschreibung",
    "ausstattung",
    "energieausweis",
    "courtage",
    "anbieter",
    "titelbild",
    "veroeffentlicht_am",
    "bestaetigt_am",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Shows how Objelio understands a search request in words, as structured criteria the user can check and correct before searching. Does not search.

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "The user's request in their own words."
    }
  },
  "required": [
    "text"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "kriterien": {
      "type": "object",
      "properties": {
        "criteria_version": {},
        "offer_type": {},
        "property_types": {},
        "property_subtypes": {},
        "locations": {},
        "price_max_eur": {},
        "price_min_eur": {},
        "living_area_min_qm": {},
        "rooms_min": {},
        "year_built_min": {},
        "features_required": {},
        "features_preferred": {},
        "notes_unmapped": {}
      },
      "additionalProperties": false,
      "description": "Structured criteria, can be passed as criteria to search_listings (leave out null and empty fields)."
    },
    "in_worten": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The criteria in German words."
    },
    "nicht_beruecksichtigt": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "hinweis": {
      "type": "string"
    }
  },
  "required": [
    "kriterien",
    "in_worten",
    "nicht_beruecksichtigt",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Compares two or three listings from search_listings side by side: price, price per square meter, estimated purchase costs, area, rooms, building, energy certificate, features and agent. Only stored data; missing information is "unbekannt". Returns a link to the same comparison on objelio.de, where the user can save the listings and contact the agents.

{
  "type": "object",
  "properties": {
    "listing_ids": {
      "minItems": 2,
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 36
      },
      "description": "Two or three ids from search_listings."
    }
  },
  "required": [
    "listing_ids"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "objekte": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "titel": {
            "type": "string"
          },
          "objektart": {
            "type": "string"
          },
          "demo": {
            "type": "boolean",
            "description": "true = demo listing with invented data."
          },
          "link": {
            "description": "Listing page on objelio.de, where the user contacts the agent.",
            "type": [
              "string",
              "null"
            ]
          },
          "titelbild": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "titel",
          "objektart",
          "demo",
          "link",
          "titelbild"
        ],
        "additionalProperties": false
      },
      "description": "The compared listings, in the order of the columns."
    },
    "zeilen": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Row name in German, e.g. Preis, Wohnfläche, Energiekennwert."
          },
          "gruppe": {
            "type": "string"
          },
          "werte": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "One value per listing; \"unbekannt\" = no information, \"entfällt\" = does not apply to this property type."
          },
          "beste": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "Column indexes (0-based) with the best value of the row, e.g. lowest price; empty if not comparable."
          },
          "geschaetzt": {
            "type": "boolean",
            "description": "true = estimate (purchase costs), not given by the agent."
          }
        },
        "required": [
          "name",
          "gruppe",
          "werte",
          "beste",
          "geschaetzt"
        ],
        "additionalProperties": false
      },
      "description": "Comparison rows. Only stored data; price per m² is calculated, purchase costs are estimated."
    },
    "nicht_verfuegbar": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Ids that are no longer published."
    },
    "vergleich_link": {
      "type": "string",
      "description": "The same comparison on objelio.de. Show it to the user."
    },
    "hinweis": {
      "type": "string"
    }
  },
  "required": [
    "objekte",
    "zeilen",
    "nicht_verfuegbar",
    "vergleich_link",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Estimates the additional costs of buying a property in Germany (Kaufnebenkosten): real estate transfer tax of the federal state, notary and land register as a usual range, and the buyer's commission. Pass a listing_id from search_listings to use its price, postal code and commission, or pass price and state. An estimate, not tax or legal advice.

{
  "type": "object",
  "properties": {
    "listing_id": {
      "description": "A listing for sale from search_listings; fills price, state and commission.",
      "type": "string",
      "maxLength": 200
    },
    "price_eur": {
      "description": "Purchase price in EUR.",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "commission_percent": {
      "description": "Buyer's commission in percent of the price, if any.",
      "type": "number",
      "minimum": 0,
      "maximum": 10
    },
    "state": {
      "description": "German federal state, code or name, e.g. NW, Bayern.",
      "type": "string",
      "maxLength": 40
    },
    "plz": {
      "description": "Five-digit postal code, used to derive the state if state is missing.",
      "type": "string",
      "pattern": "^\\d{5}$"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "kaufpreis_eur": {
      "type": "number"
    },
    "bundesland": {
      "type": "string"
    },
    "bundesland_aus_plz": {
      "type": "boolean",
      "description": "true = state derived from the postal code; ask the user to confirm."
    },
    "grunderwerbsteuer": {
      "type": "object",
      "properties": {
        "prozent": {
          "type": "number"
        },
        "eur": {
          "type": "number"
        }
      },
      "required": [
        "prozent",
        "eur"
      ],
      "additionalProperties": false,
      "description": "Real estate transfer tax of the state."
    },
    "notar_grundbuch": {
      "type": "object",
      "properties": {
        "prozent_von": {
          "type": "number"
        },
        "prozent_bis": {
          "type": "number"
        },
        "eur_von": {
          "type": "number"
        },
        "eur_bis": {
          "type": "number"
        }
      },
      "required": [
        "prozent_von",
        "prozent_bis",
        "eur_von",
        "eur_bis"
      ],
      "additionalProperties": false,
      "description": "Notary and land register as a usual range."
    },
    "courtage": {
      "type": "object",
      "properties": {
        "prozent": {
          "type": "number"
        },
        "eur": {
          "type": "number"
        },
        "hinweis_makler": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "prozent",
        "eur",
        "hinweis_makler"
      ],
      "additionalProperties": false,
      "description": "Buyer's commission as given."
    },
    "nebenkosten_eur": {
      "type": "object",
      "properties": {
        "von": {
          "type": "number"
        },
        "bis": {
          "type": "number"
        }
      },
      "required": [
        "von",
        "bis"
      ],
      "additionalProperties": false,
      "description": "All purchase costs together (range)."
    },
    "gesamt_eur": {
      "type": "object",
      "properties": {
        "von": {
          "type": "number"
        },
        "bis": {
          "type": "number"
        }
      },
      "required": [
        "von",
        "bis"
      ],
      "additionalProperties": false,
      "description": "Price plus purchase costs (range)."
    },
    "objekt_link": {
      "description": "Listing page, if a listing was given.",
      "type": [
        "string",
        "null"
      ]
    },
    "rechner_link": {
      "type": "string",
      "description": "The calculator on objelio.de."
    },
    "partner_link": {
      "description": "Optional page on objelio.de where the user can send a request to an Objelio partner (financing or short valuation), marked as a partner offer. Mention it only if the user asks about financing or valuation; never collect contact data in the chat.",
      "type": [
        "string",
        "null"
      ]
    },
    "quellen": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "hinweis": {
      "type": "string",
      "description": "Estimate, no tax, legal or financing advice. Tell the user."
    }
  },
  "required": [
    "kaufpreis_eur",
    "bundesland",
    "bundesland_aus_plz",
    "grunderwerbsteuer",
    "notar_grundbuch",
    "courtage",
    "nebenkosten_eur",
    "gesamt_eur",
    "objekt_link",
    "rechner_link",
    "partner_link",
    "quellen",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Estimates which purchase price a user can afford from equity and the monthly loan rate, after purchase costs of the federal state. Ask the user for equity, monthly rate and, if known, interest rate and repayment; otherwise suggested values are used and marked. Returns a link to an Objelio search with this price as maximum. An estimate, not financing advice.

{
  "type": "object",
  "properties": {
    "equity_eur": {
      "type": "number",
      "minimum": 0,
      "description": "Own capital in EUR."
    },
    "monthly_rate_eur": {
      "type": "number",
      "minimum": 0,
      "description": "Monthly rate for interest and repayment in EUR."
    },
    "interest_percent": {
      "description": "Annual interest rate in percent. Leave out if the user does not know it.",
      "type": "number",
      "minimum": 0,
      "maximum": 20
    },
    "repayment_percent": {
      "description": "Initial annual repayment in percent.",
      "type": "number",
      "minimum": 0.5,
      "maximum": 20
    },
    "commission_percent": {
      "description": "Buyer's commission in percent, if expected.",
      "type": "number",
      "minimum": 0,
      "maximum": 10
    },
    "ort": {
      "description": "Town for the search link, e.g. Paderborn.",
      "type": "string",
      "maxLength": 80
    },
    "property_type": {
      "description": "wohnung, haus or grundstueck, for the search link.",
      "type": "string",
      "enum": [
        "wohnung",
        "haus",
        "grundstueck"
      ]
    },
    "state": {
      "description": "German federal state, code or name, e.g. NW, Bayern.",
      "type": "string",
      "maxLength": 40
    },
    "plz": {
      "description": "Five-digit postal code, used to derive the state if state is missing.",
      "type": "string",
      "pattern": "^\\d{5}$"
    }
  },
  "required": [
    "equity_eur",
    "monthly_rate_eur"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "moeglicher_kaufpreis_eur": {
      "type": "number",
      "description": "Affordable purchase price after purchase costs, rounded down to 1,000 EUR."
    },
    "darlehen_eur": {
      "type": "number",
      "description": "Loan from monthly rate, interest and repayment."
    },
    "gesamtbudget_eur": {
      "type": "number",
      "description": "Equity plus loan."
    },
    "nebenkosten_eur": {
      "type": "number"
    },
    "nebenkosten_prozent": {
      "type": "number"
    },
    "annahmen": {
      "type": "object",
      "properties": {
        "eigenkapital_eur": {
          "type": "number"
        },
        "rate_monat_eur": {
          "type": "number"
        },
        "zins_prozent": {
          "type": "number"
        },
        "zins_ist_vorschlag": {
          "type": "boolean"
        },
        "tilgung_prozent": {
          "type": "number"
        },
        "tilgung_ist_vorschlag": {
          "type": "boolean"
        },
        "bundesland": {
          "type": "string"
        },
        "courtage_prozent": {
          "type": "number"
        }
      },
      "required": [
        "eigenkapital_eur",
        "rate_monat_eur",
        "zins_prozent",
        "zins_ist_vorschlag",
        "tilgung_prozent",
        "tilgung_ist_vorschlag",
        "bundesland",
        "courtage_prozent"
      ],
      "additionalProperties": false,
      "description": "Inputs used. Values marked as suggestion should be confirmed with the user."
    },
    "suche_link": {
      "type": "string",
      "description": "Objelio search with this price as maximum. Offer it to the user."
    },
    "rechner_link": {
      "type": "string"
    },
    "partner_link": {
      "description": "Optional page on objelio.de where the user can send a request to an Objelio partner (financing or short valuation), marked as a partner offer. Mention it only if the user asks about financing or valuation; never collect contact data in the chat.",
      "type": [
        "string",
        "null"
      ]
    },
    "quellen": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "hinweis": {
      "type": "string",
      "description": "Estimate, no financing advice. Tell the user."
    }
  },
  "required": [
    "moeglicher_kaufpreis_eur",
    "darlehen_eur",
    "gesamtbudget_eur",
    "nebenkosten_eur",
    "nebenkosten_prozent",
    "annahmen",
    "suche_link",
    "rechner_link",
    "partner_link",
    "quellen",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Read-only. Returns a link to a page on objelio.de where the user can subscribe to e-mail alerts for these criteria: new matching listings and price reductions, at most one e-mail a day, unsubscribe with one click. Pass the same criteria as in search_listings (at least one, e.g. a location). The user enters the e-mail address on that page and confirms it by e-mail; do not ask for it in the chat. Nothing is saved until the user does so.

{
  "type": "object",
  "properties": {
    "criteria": {
      "type": "object",
      "properties": {
        "offer_type": {
          "description": "\"kauf\" (buy) or \"miete\" (rent). Currently almost all listings are for sale.",
          "type": "string",
          "enum": [
            "kauf",
            "miete"
          ]
        },
        "property_types": {
          "description": "wohnung (apartment), haus (house), grundstueck (building plot).",
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "wohnung",
              "haus",
              "grundstueck"
            ]
          }
        },
        "property_subtypes": {
          "description": "Only if the user explicitly names a subtype, e.g. doppelhaushaelfte (semi-detached house), reihenhaus, penthouse.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "etage",
              "erdgeschoss",
              "dachgeschoss",
              "maisonette",
              "penthouse",
              "terrassen",
              "souterrain",
              "loft",
              "apartment",
              "einfamilienhaus",
              "doppelhaushaelfte",
              "reihenmittelhaus",
              "reihenendhaus",
              "zweifamilienhaus",
              "mehrfamilienhaus",
              "bungalow",
              "villa",
              "stadthaus",
              "bauernhaus",
              "wohnen",
              "gemischt",
              "freizeit"
            ]
          }
        },
        "locations": {
          "description": "Several locations mean any of them. With umkreis_km, listings around the place are found and each result has entfernung_km.",
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ort": {
                "description": "Town or city, e.g. Paderborn. Also matches district names.",
                "type": "string",
                "maxLength": 80
              },
              "plz": {
                "description": "German postal code or its beginning, e.g. 33104 or 331.",
                "type": "string",
                "pattern": "^\\d{2,5}$"
              },
              "ortsteil": {
                "description": "District, e.g. Schloß Neuhaus. Ignored with umkreis_km.",
                "type": "string",
                "maxLength": 80
              },
              "umkreis_km": {
                "description": "Radius in km around ort or a five-digit plz, for requests like \"within 20 km of Bielefeld\" or \"near Paderborn\" (use 10 km when no number is given). Covers all of Germany.",
                "type": "number",
                "minimum": 1,
                "maximum": 100
              }
            },
            "additionalProperties": false
          }
        },
        "price_max_eur": {
          "description": "Maximum price in EUR.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "price_min_eur": {
          "description": "Minimum price in EUR.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "living_area_min_qm": {
          "description": "Minimum living area in square meters.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "rooms_min": {
          "description": "Minimum number of rooms (German count, kitchen and bath excluded).",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "year_built_min": {
          "description": "Built in or after this year.",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "features_required": {
          "description": "Must-have features. Listings without information stay in the results as unknown.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "balkon",
              "terrasse",
              "garten",
              "aufzug",
              "keller",
              "einbaukueche",
              "gaeste_wc",
              "barrierefrei",
              "stellplatz"
            ]
          }
        },
        "features_preferred": {
          "description": "Nice-to-have features, only affect the order.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "balkon",
              "terrasse",
              "garten",
              "aufzug",
              "keller",
              "einbaukueche",
              "gaeste_wc",
              "barrierefrei",
              "stellplatz"
            ]
          }
        },
        "notes_unmapped": {
          "description": "Wishes that fit no field (e.g. quiet location). They do not filter and are shown back to the user.",
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "additionalProperties": false,
      "description": "Structured search criteria, as in search_listings."
    }
  },
  "required": [
    "criteria"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "link": {
      "type": "string",
      "description": "Page on objelio.de where the user enters an e-mail address and confirms it. Show it to the user."
    },
    "kriterien": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The saved criteria in German words."
    },
    "hinweis": {
      "type": "string"
    }
  },
  "required": [
    "link",
    "kriterien",
    "hinweis"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}