Aller au contenu
immoriver
immoriver
Se connecter Créer un compte

Aide · Contact · Mentions légales · Confidentialité

API immobilière API pour agences immobilières et promoteurs

Avec l'API immobilière d'immoriver.com, agences immobilières et promoteurs peuvent transmettre des annonces depuis leur site, leur CRM ou un script et récupérer des demandes par la même voie. Pour cela, une clé et du JSON suffisent. La documentation technique continue en anglais.

Last updated

curl -X PUT "https://api.immoriver.com/v1/objekte/DOKU-4711?warten=20" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data @objekt.json

Overview

The API is a delivery channel like FTP, just without agency software: you send a listing as JSON, we validate it immediately, import it and publish it as soon as all required details are present and your plan has room. Enquiries from prospects are fetched as a change feed, and you report back how you handled them.

Base URLhttps://api.immoriver.com/v1
FormatJSON (UTF-8), numbers with a dot, dates YYYY-MM-DD, times ISO 8601
AuthenticationAuthorization: Bearer ir_live_…
RequirementAn active agency or developer plan and an approved company
Message languageAccept-Language: en for English, German otherwise. Field names and codes are the same in both.
OpenAPI 3.1Download openapi.json (also at https://api.immoriver.com/v1/openapi.json)

If you have ever built an OpenImmo file, the field names will look familiar; the field reference shows where each field sits in an OpenImmo document. Your JSON then takes the same route as an FTP delivery.

Quick start

  1. Create a key: in your account under Transfer, section “Interface (API)”. For trying things out use a test key; listings created with it stay drafts. Go to account
  2. Check the connection:
curl -X GET "https://api.immoriver.com/v1" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"

Response

HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 120
RateLimit-Remaining: 119
RateLimit-Reset: 22

{
    "api": "immoriver",
    "version": "v1",
    "feldkatalog": "1.0",
    "firma": {
        "name": "Beispiel Immobilien GmbH",
        "firmennummer": 2010099,
        "anbieterkennung": "IR-2010099"
    },
    "schluessel": {
        "name": "Website",
        "praefix": "ir_live_3f9a1c77",
        "modus": "live",
        "rechte": [
            "objekte:schreiben",
            "objekte:lesen",
            "anfragen:lesen",
            "anfragen:schreiben"
        ]
    },
    "kontingent": {
        "paket": "makler_business",
        "grenze": 50,
        "aktiv": 37,
        "frei": 13
    },
    "grenzen": {
        "je_minute": {
            "lesen": 120,
            "schreiben": 60,
            "medien": 30
        },
        "je_tag": 20000
    },
    "doku": "https://immoriver.com/entwickler"
}
  1. Deliver your first listing. The ID in the path (here DOKU-4711) is your own permanent ID for the listing. With ?warten=20 the call waits for the result:

objekt.json

{
    "status": "aktiv",
    "objektkategorie": {
        "nutzungsart": [
            "WOHNEN"
        ],
        "vermarktungsart": [
            "KAUF"
        ],
        "objektart": {
            "typ": "wohnung",
            "untertyp": "ETAGE"
        }
    },
    "geo": {
        "plz": "50667",
        "ort": "Köln",
        "strasse": "Domkloster",
        "hausnummer": "4",
        "land": "DEU",
        "regionaler_zusatz": "Altstadt-Nord",
        "etage": 2,
        "anzahl_etagen": 5
    },
    "kontaktperson": {
        "anrede": "Frau",
        "vorname": "Anna",
        "name": "Berger",
        "email_zentrale": "info@beispiel-immobilien.de",
        "tel_durchw": "+49 221 123456-12"
    },
    "preise": {
        "kaufpreis": 489000,
        "waehrung": "EUR",
        "hausgeld": 310,
        "provisionspflichtig": true,
        "aussen_courtage": "3,57 %",
        "aussen_courtage_mit_mwst": true,
        "stellplaetze": [
            {
                "art": "TIEFGARAGE",
                "anzahl": 1,
                "kaufpreis": 25000
            }
        ]
    },
    "flaechen": {
        "wohnflaeche": 92.5,
        "anzahl_zimmer": 3,
        "anzahl_schlafzimmer": 2,
        "anzahl_badezimmer": 1,
        "anzahl_balkone": 1
    },
    "ausstattung": {
        "ausstatt_kategorie": "GEHOBEN",
        "heizungsart": [
            "ZENTRAL",
            "FUSSBODEN"
        ],
        "befeuerung": [
            "GAS"
        ],
        "kueche": [
            "EBK"
        ],
        "boden": [
            "PARKETT",
            "FLIESEN"
        ],
        "fahrstuhl": [
            "PERSONEN"
        ],
        "unterkellert": "JA",
        "gaestewc": true,
        "ausricht_balkon_terrasse": [
            "SUEDWEST"
        ]
    },
    "zustand_angaben": {
        "baujahr": 1998,
        "zustand": "GEPFLEGT",
        "energiepass": {
            "epart": "VERBRAUCH",
            "jahrgang": "2014",
            "gebaeudeart": "wohn",
            "energieverbrauchkennwert": 98.4,
            "primaerenergietraeger": "GAS",
            "wertklasse": "C",
            "mitwarmwasser": true,
            "gueltig_bis": "2031-05-01"
        }
    },
    "freitexte": {
        "objekttitel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer",
        "objektbeschreibung": "Die Wohnung liegt im zweiten Obergeschoss eines gepflegten Hauses von 1998.\n\nWohnzimmer und Küche öffnen sich zum Südwestbalkon.",
        "lage": "Dom, Rheinufer und Hauptbahnhof erreichen Sie zu Fuß."
    },
    "anhaenge": [
        {
            "gruppe": "TITELBILD",
            "titel": "Ansicht",
            "url": "https://immoriver.com/assets/bilder/teilen.jpg"
        }
    ],
    "verwaltung_objekt": {
        "verfuegbar_ab": "nach Vereinbarung",
        "objektadresse_freigeben": false
    },
    "verwaltung_techn": {
        "objektnr_extern": "W-4711"
    }
}
curl -X PUT "https://api.immoriver.com/v1/objekte/DOKU-4711?warten=20" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data @objekt.json

Response

HTTP 200
Content-Type: application/json; charset=UTF-8
Content-Location: /v1/lieferungen/65799886
RateLimit-Limit: 60
RateLimit-Remaining: 58
RateLimit-Reset: 20

{
    "lieferung": "65799886",
    "status": "erfolgreich",
    "kanal": "api",
    "erstellt": "2026-09-26T01:02:38+02:00",
    "beendet": "2026-09-26T01:02:40+02:00",
    "objekte_gesamt": 1,
    "medien": 1,
    "fehler": null,
    "objekte": [
        {
            "obid": "DOKU-4711",
            "objektnr_extern": "W-4711",
            "expose_nr": 112173,
            "ergebnis": "neu",
            "status": "aktiv",
            "freigabe": "aktiv",
            "fehlend": [],
            "meldung": null,
            "url": "https://immoriver.com/expose/112173"
        }
    ],
    "hinweise": [],
    "testmodus": false
}

The listing is now online at the address in url. Sending the same PUT again changes nothing (ergebnis “unveraendert”); a changed PUT fully replaces the listing.

Keys and authentication

Every request carries the key as a bearer token. Where a proxy drops the Authorization header, X-Api-Key: ir_live_… works too. Keys belong to the company, not to a person. We only store a checksum: the plain key is shown once when it is created.

PermissionAllows
objekte:schreibenCreate, update, delete listings, set status
objekte:lesenRead own listings and deliveries
anfragen:lesenRead enquiries for own listings
anfragen:schreibenReport the handling status of enquiries
  • ir_live_…: listings go online as through the portal.
  • ir_test_…: everything works the same, but listings stay drafts and are never published. Status “aktiv” is rejected with 403.
  • Optionally a key can be restricted to IP addresses or networks.
  • A revoked key stops working immediately. After 20 invalid keys within ten minutes we block the IP for ten minutes.
curl -X GET "https://api.immoriver.com/v1"
Show response (HTTP 401)
HTTP 401
Content-Type: application/problem+json; charset=UTF-8

{
    "type": "https://immoriver.com/entwickler#fehler-schluessel_fehlt",
    "title": "Schlüssel fehlt",
    "status": 401,
    "code": "schluessel_fehlt",
    "detail": "Senden Sie Ihren Schlüssel als „Authorization: Bearer ir_live_…“.",
    "anfrage_id": "00MUHKGBGLD75B44A742E9609C"
}

Delivering listings

PUT /v1/objekte/{obid} creates a listing or fully replaces it. You choose the obid yourself (letters, digits, dot, hyphen, underscore, up to 100 characters) and keep it for the lifetime of the listing. Whatever is missing from the body is empty in the listing afterwards.

What is checked immediately

Types, lengths, ranges, allowed values, required fields and unknown fields. All errors come back at once, with path and code. An unknown field is an error and is not silently ignored: a typo should show up on the first call.

curl -X PUT "https://api.immoriver.com/v1/objekte/DOKU-4711" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data '{"objektkategorie":{"vermarktungsart":["KAUF"],"objektart":{"typ":"wohnung","untertyp":"VILLA"}},"geo":{"plz":"50667","ort":"Köln"},"preise":{"kaufpreis":"489.000 €","provisionspflichtig":true},"flaechen":{"wohnflaech":92.5},"freitexte":{"objekttitel":"Helle 3-Zimmer-Wohnung"}}'
Show response (HTTP 422)
HTTP 422
Content-Type: application/problem+json; charset=UTF-8
RateLimit-Limit: 60
RateLimit-Remaining: 59
RateLimit-Reset: 22

{
    "type": "https://immoriver.com/entwickler#fehler-pruefung_fehlgeschlagen",
    "title": "Prüfung fehlgeschlagen",
    "status": 422,
    "code": "pruefung_fehlgeschlagen",
    "detail": "Mindestens ein Feld ist fehlerhaft, siehe fehler.",
    "anfrage_id": "00MUHKGBHI0F48A65C9EFC6F30",
    "fehler": [
        {
            "pfad": "preise.kaufpreis",
            "code": "typ_zahl",
            "meldung": "Erwartet wird eine Zahl (Punkt als Dezimalzeichen, ohne Tausendertrenner)."
        },
        {
            "pfad": "flaechen.wohnflaech",
            "code": "unbekanntes_feld",
            "meldung": "Unbekanntes Feld. Die erlaubten Felder stehen unter GET /v1/feldkatalog."
        },
        {
            "pfad": "objektkategorie.nutzungsart",
            "code": "pflichtfeld",
            "meldung": "Pflichtfeld fehlt."
        },
        {
            "pfad": "objektkategorie.objektart.untertyp",
            "code": "unbekannter_wert",
            "meldung": "Unbekannter Wert. Erlaubt: DACHGESCHOSS, MAISONETTE, LOFT-STUDIO-ATELIER, PENTHOUSE, TERRASSEN, ETAGE, ERDGESCHOSS, SOUTERRAIN, APARTMENT, FERIENWOHNUNG, GALERIE, ROHDACHBODEN, ATTIKAWOHNUNG, KEINE_ANGABE"
        }
    ],
    "hinweise": [
        {
            "pfad": "preise.kaufpreis",
            "code": "preis_fehlt",
            "meldung": "Ohne Preis (oder kaufpreis_auf_anfrage) bleibt das Objekt Entwurf."
        },
        {
            "pfad": "anhaenge",
            "code": "ohne_bild",
            "meldung": "Ohne Bild bleibt das Objekt Entwurf."
        }
    ]
}

Always required

objektkategorie.nutzungsart, objektkategorie.vermarktungsart, objektkategorie.objektart.typ, geo.plz, geo.ort, preise.provisionspflichtig, freitexte.objekttitel. provisionspflichtig is required because otherwise “commission-free” could not be told apart from “not specified”.

Numbers, texts, lists

  • Numbers as JSON numbers: 489000 and 92.5, not “489.000 €”. More decimals than the field holds are rounded.
  • Yes/no as true or false. null or an empty string means “not specified”.
  • Multiple values (e.g. heizungsart) as a list: ["ZENTRAL", "FUSSBODEN"]. The first value is the main one. The OpenImmo notation {"ZENTRAL": true} is understood as well.
  • Texts without HTML. Separate paragraphs with a blank line (\n\n).
  • Enumeration values are case-insensitive; they come back in the spelling of the value lists.

Processed asynchronously

After validation the API responds with 202 and the delivery status. Geocoding and image fetching follow, usually within one to three seconds. With ?warten=N (up to 25 seconds) the call waits and responds with 200 and the result. Otherwise query the status at the address in Content-Location.

The same listing via FTP and API

If your company also delivers a listing via FTP, the same openimmo_obid refers to the same listing: the second delivery updates it. Matching by objektnr_extern only counts as the same listing if property type, marketing type and postcode agree; otherwise a new listing is created.

Contact person

Enquiries for a listing go to the contact person’s e-mail (email_direkt, otherwise email_zentrale), without a contact person to your company address. If there is no account for that address yet, we add a pending team member which you confirm or decline under Account › Team. This is the same behaviour as with FTP.

Deleting

DELETE /v1/objekte/{obid} takes the listing offline immediately and archives it; images are removed from the CDN. Enquiries for it are kept. A later PUT with the same obid reinstates it.

curl -X DELETE "https://api.immoriver.com/v1/objekte/DOKU-4711" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 60
RateLimit-Remaining: 51
RateLimit-Reset: 17

{
    "obid": "DOKU-4711",
    "status": {
        "id": 26007,
        "code": "archiviert",
        "text": "Archiviert"
    },
    "vorher": {
        "id": 26002,
        "code": "aktiv",
        "text": "Aktiv"
    }
}

Images and documents

anhaenge is the complete list in display order. Anything missing from the next delivery is removed. If an image cannot be fetched, the previous one stays and the next delivery tries again.

  • By URL: {"gruppe": "BILD", "url": "https://…"}. We download the image (up to 20 MB, 15 seconds, public addresses over http/https only).
  • By upload, if your images are not public: POST /v1/medien, then {"medien_id": "med_…"}. Unused uploads expire after seven days.
  • JPEG, PNG, WebP and PDF are allowed, images from 200 × 150 pixels. The type is detected from the content.
  • Groups: TITELBILD, BILD, INNENANSICHTEN, AUSSENANSICHTEN, GRUNDRISS, KARTEN_LAGEPLAN, DOKUMENTE, PANORAMA, FILMLINK, LINKS. TITELBILD is the lead image; without it the first image is used. Virtual tours (Matterport, Ogulo etc.) and videos as PANORAMA or FILMLINK with url.
curl -X POST "https://api.immoriver.com/v1/medien" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "X-Dateiname: wohnzimmer.jpg" \
  --data-binary @wohnzimmer.jpg

Response

HTTP 201
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 30
RateLimit-Remaining: 29
RateLimit-Reset: 19

{
    "medien_id": "med_0f5e7a5e4f72fafb60daa1da",
    "dateiname": "wohnzimmer.jpg",
    "typ": "image/jpeg",
    "groesse": 84055,
    "breite": 1200,
    "hoehe": 630,
    "verfaellt_ungenutzt": "2026-10-03T01:02:41+02:00"
}

miete.json

{
    "status": "entwurf",
    "objektkategorie": {
        "nutzungsart": [
            "WOHNEN"
        ],
        "vermarktungsart": [
            "MIETE_PACHT"
        ],
        "objektart": {
            "typ": "wohnung",
            "untertyp": "DACHGESCHOSS"
        }
    },
    "geo": {
        "plz": "40213",
        "ort": "Düsseldorf",
        "land": "DEU"
    },
    "preise": {
        "kaltmiete": 1180,
        "nebenkosten": 240,
        "kaution": 3540,
        "provisionspflichtig": false
    },
    "flaechen": {
        "wohnflaeche": 71.4,
        "anzahl_zimmer": 2.5
    },
    "freitexte": {
        "objekttitel": "Dachgeschoss mit Blick über die Altstadt"
    },
    "anhaenge": [
        {
            "gruppe": "TITELBILD",
            "medien_id": "med_0f5e7a5e4f72fafb60daa1da"
        }
    ],
    "verwaltung_objekt": {
        "haustiere": true,
        "verfuegbar_ab": "ab 1. November"
    }
}
curl -X PUT "https://api.immoriver.com/v1/objekte/DOKU-4712?warten=20" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data @miete.json
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
Content-Location: /v1/lieferungen/65572137
RateLimit-Limit: 60
RateLimit-Remaining: 56
RateLimit-Reset: 19

{
    "lieferung": "65572137",
    "status": "erfolgreich",
    "kanal": "api",
    "erstellt": "2026-09-26T01:02:41+02:00",
    "beendet": "2026-09-26T01:02:41+02:00",
    "objekte_gesamt": 1,
    "medien": 1,
    "fehler": null,
    "objekte": [
        {
            "obid": "DOKU-4712",
            "objektnr_extern": "DOKU-4712",
            "expose_nr": 112174,
            "ergebnis": "neu",
            "status": "entwurf",
            "freigabe": "entwurf",
            "fehlend": [],
            "meldung": null,
            "url": null
        }
    ],
    "hinweise": [],
    "testmodus": false
}

Status and publishing

With "status": "aktiv" (default) a listing goes online as soon as everything is in order; with "status": "entwurf" it stays offline. Later you change the status with POST /v1/objekte/{obid}/status: aktiv, entwurf, pausiert, verkauft, vermietet or archiviert.

What “aktiv” requires

  • Title, town, price (or kaufpreis_auf_anfrage), an area, rooms for residential listings, at least one image.
  • In Germany the details required by § 87 GModG where an energy certificate is needed: year of construction, certificate type, energy value, main energy source. Not needed for plots, listed buildings (verwaltung_objekt.denkmalgeschuetzt) and below 50 m². Austria (§ 3 EAVG): HWB plus either fGEE or – for certificates under the new rules – final energy demand with class (energieeffizienzklasse).
  • Room in your plan: at most as many listings may be active at the same time as your plan allows. If it is full, the API rejects another active listing with 409 kontingent_erschoepft and stores nothing. As a draft it always works.

If details are missing, the listing is stored anyway and stays a draft; the delivery lists what is missing in fehlend. A status change to “aktiv” without them returns 409:

curl -X POST "https://api.immoriver.com/v1/objekte/DOKU-4712/status" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data '{"status":"aktiv"}'

Response

HTTP 409
Content-Type: application/problem+json; charset=UTF-8
RateLimit-Limit: 60
RateLimit-Remaining: 55
RateLimit-Reset: 18

{
    "type": "https://immoriver.com/entwickler#fehler-pflichtangaben_fehlen",
    "title": "Pflichtangaben fehlen",
    "status": 409,
    "code": "pflichtangaben_fehlen",
    "detail": "Das Objekt kann so nicht online gehen, siehe fehlend.",
    "anfrage_id": "00MUHKGDY27D3B9AC0D020E5E0",
    "fehlend": [
        "Baujahr",
        "Art des Energieausweises",
        "Energiekennwert",
        "Wesentlicher Energieträger"
    ]
}
curl -X POST "https://api.immoriver.com/v1/objekte/DOKU-4711/status" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Idempotency-Key: 6f1c2d9e-pause-4711" \
  -H "Content-Type: application/json" \
  --data '{"status":26003}'
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 60
RateLimit-Remaining: 54
RateLimit-Reset: 18

{
    "obid": "DOKU-4711",
    "status": {
        "id": 26003,
        "code": "pausiert",
        "text": "Pausiert"
    },
    "vorher": {
        "id": 26002,
        "code": "aktiv",
        "text": "Aktiv"
    },
    "url": null
}

Idempotency-Key: with POST you can send your own key. If the same request arrives again within 24 hours (e.g. after a network error), we return the first response again (header Idempotent-Replayed: true) instead of executing it a second time. PUT and DELETE are repeatable by design.

Deliveries and results

Every delivery has a number. GET /v1/lieferungen/{number} shows its status, GET /v1/lieferungen the most recent ones, including FTP.

FieldValues
statuswartet (queued), laeuft (running), erfolgreich (done), teilweise (partly), fehler (failed), abgelehnt (rejected)
objekte[].ergebnisneu (new), aktualisiert (updated), unveraendert (unchanged), geloescht (deleted), uebersprungen (skipped), fehler (error)
objekte[].freigabeaktiv, entwurf, pflichtangaben_fehlen, kontingent_erschoepft, kein_paket, laufzeit_abgelaufen, als_verkauft_gemeldet
objekte[].fehlendWhat is missing for publishing, in plain text
curl -X GET "https://api.immoriver.com/v1/lieferungen/65799886" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 120
RateLimit-Remaining: 116
RateLimit-Reset: 18

{
    "lieferung": "65799886",
    "status": "erfolgreich",
    "kanal": "api",
    "erstellt": "2026-09-26T01:02:38+02:00",
    "beendet": "2026-09-26T01:02:40+02:00",
    "objekte_gesamt": 1,
    "medien": 1,
    "fehler": null,
    "objekte": [
        {
            "obid": "DOKU-4711",
            "objektnr_extern": "W-4711",
            "expose_nr": 112173,
            "ergebnis": "neu",
            "status": "aktiv",
            "freigabe": "aktiv",
            "fehlend": [],
            "meldung": null,
            "url": "https://immoriver.com/expose/112173"
        }
    ]
}

Reading listings

GET /v1/objekte lists your company’s listings (including those from FTP or created in the portal), 50 per page, up to 200 with ?anzahl=. Page on with ?nach= and the value from weiter. Filters: status and geaendert_seit (ISO 8601).

GET /v1/objekte/{obid} shows the portal state (exposé number, address, status, missing required details, enquiries) and under daten the same JSON that PUT accepts. Listings created by hand in the portal have no obid and cannot be changed through the API.

curl -X GET "https://api.immoriver.com/v1/objekte/DOKU-4711" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 120
RateLimit-Remaining: 118
RateLimit-Reset: 19

{
    "obid": "DOKU-4711",
    "objektnr_extern": "W-4711",
    "expose_nr": 112173,
    "url": "https://immoriver.com/expose/112173",
    "status": {
        "id": 26002,
        "code": "aktiv",
        "text": "Aktiv"
    },
    "sichtbarkeit": {
        "id": 27001,
        "code": "public",
        "text": "Öffentlich"
    },
    "kanal": "api",
    "titel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer",
    "vermarktungsart": {
        "id": 25001,
        "code": "KAUF",
        "text": "Kauf"
    },
    "objektart": {
        "id": 10001,
        "code": "wohnung",
        "text": "Wohnung"
    },
    "plz": "50667",
    "ort": "Köln",
    "preis": 489000,
    "preis_auf_anfrage": false,
    "waehrung": "EUR",
    "bilder": 1,
    "anfragen": 0,
    "erstellt": "2026-09-26T01:02:39+02:00",
    "geaendert": "2026-09-26T01:02:39+02:00",
    "veroeffentlicht_am": "2026-09-26T01:02:39+02:00",
    "laeuft_ab_am": null,
    "fehlende_pflichtangaben": [],
    "daten": {
        "objektkategorie": {
            "nutzungsart": [
                {
                    "id": 24001,
                    "code": "WOHNEN",
                    "text": "Wohnen"
                }
            ],
            "vermarktungsart": [
                {
                    "id": 25001,
                    "code": "KAUF",
                    "text": "Kauf"
                }
            ],
            "objektart": {
                "typ": {
                    "id": 10001,
                    "code": "wohnung",
                    "text": "Wohnung"
                },
                "untertyp": {
                    "id": 12006,
                    "code": "ETAGE",
                    "text": "Etagenwohnung"
                }
            }
        },
        "geo": {
            "plz": "50667",
            "ort": "Köln",
            "strasse": "Domkloster",
            "hausnummer": "4",
            "land": "DEU",
            "regionaler_zusatz": "Altstadt-Nord",
            "etage": 2,
            "anzahl_etagen": 5
        },
        "kontaktperson": {
            "anrede": "Frau",
            "vorname": "Anna",
            "name": "Berger",
            "email_zentrale": "info@beispiel-immobilien.de",
            "tel_durchw": "+49 221 123456-12"
        },
        "preise": {
            "kaufpreis": 489000,
            "hausgeld": 310,
            "waehrung": "EUR",
            "provisionspflichtig": true,
            "aussen_courtage": "3,57 %",
            "aussen_courtage_mit_mwst": true,
            "stellplaetze": [
                {
                    "art": "TIEFGARAGE",
                    "anzahl": 1,
                    "kaufpreis": 25000
                }
            ]
        },
        "flaechen": {
            "wohnflaeche": 92.5,
            "anzahl_zimmer": 3,
            "anzahl_schlafzimmer": 2,
            "anzahl_badezimmer": 1,
            "anzahl_balkone": 1
        },
        "ausstattung": {
            "ausstatt_kategorie": {
                "id": 52002,
                "code": "GEHOBEN",
                "text": "Gehoben"
            },
            "heizungsart": [
                {
                    "id": 32003,
                    "code": "ZENTRAL",
                    "text": "Zentralheizung"
                },
                {
                    "id": 32005,
                    "code": "FUSSBODEN",
                    "text": "Fußbodenheizung"
                }
            ],
            "befeuerung": [
                {
                    "id": 33002,
                    "code": "GAS",
                    "text": "Erdgas"
                }
            ],
            "kueche": [
                {
                    "id": 41001,
                    "code": "EBK",
                    "text": "Einbauküche"
                }
            ],
            "boden": [
                {
                    "id": 42004,
                    "code": "PARKETT",
                    "text": "Parkett"
                },
                {
                    "id": 42001,
                    "code": "FLIESEN",
                    "text": "Fliesen"
                }
            ],
            "fahrstuhl": [
                {
                    "id": 44001,
                    "code": "PERSONEN",
                    "text": "Personenaufzug"
                }
            ],
            "ausricht_balkon_terrasse": [
                {
                    "id": 45008,
                    "code": "SUEDWEST",
                    "text": "Südwest"
                }
            ],
            "unterkellert": {
                "id": 50001,
                "code": "JA",
                "text": "Unterkellert"
            },
            "gaestewc": true
        },
        "zustand_angaben": {
            "baujahr": 1998,
            "zustand": {
                "id": 29012,
                "code": "GEPFLEGT",
                "text": "Gepflegt"
            },
            "energiepass": {
                "epart": {
                    "id": 35002,
                    "code": "VERBRAUCH",
                    "text": "Verbrauchsausweis"
                },
                "jahrgang": {
                    "id": 36002,
                    "code": "2014",
                    "text": "Fassung 2014"
                },
                "gebaeudeart": {
                    "id": 37001,
                    "code": "wohn",
                    "text": "Wohngebäude"
                },
                "gueltig_bis": "2031-05-01",
                "energieverbrauchkennwert": 98.4,
                "primaerenergietraeger": {
                    "id": 34001,
                    "code": "GAS",
                    "text": "Erdgas"
                },
                "wertklasse": "C",
                "mitwarmwasser": true
            }
        },
        "freitexte": {
            "objekttitel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer",
            "objektbeschreibung": "Die Wohnung liegt im zweiten Obergeschoss eines gepflegten Hauses von 1998.\n\nWohnzimmer und Küche öffnen sich zum Südwestbalkon.",
            "lage": "Dom, Rheinufer und Hauptbahnhof erreichen Sie zu Fuß."
        },
        "anhaenge": [
            {
                "gruppe": "TITELBILD",
                "titel": "Ansicht",
                "url": "https://immoriver.com/assets/bilder/teilen.jpg"
            }
        ],
        "verwaltung_objekt": {
            "objektadresse_freigeben": false,
            "verfuegbar_ab": "nach Vereinbarung"
        },
        "verwaltung_techn": {
            "objektnr_extern": "W-4711"
        }
    }
}
curl -X GET "https://api.immoriver.com/v1/objekte?status=aktiv&anzahl=1&geaendert_seit=2026-09-26T01%3A02%3A38%2B02%3A00" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 120
RateLimit-Remaining: 117
RateLimit-Reset: 19

{
    "objekte": [
        {
            "obid": "DOKU-4711",
            "objektnr_extern": "W-4711",
            "expose_nr": 112173,
            "url": "https://immoriver.com/expose/112173",
            "status": {
                "id": 26002,
                "code": "aktiv",
                "text": "Aktiv"
            },
            "sichtbarkeit": {
                "id": 27001,
                "code": "public",
                "text": "Öffentlich"
            },
            "kanal": "api",
            "titel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer",
            "vermarktungsart": {
                "id": 25001,
                "code": "KAUF",
                "text": "Kauf"
            },
            "objektart": {
                "id": 10001,
                "code": "wohnung",
                "text": "Wohnung"
            },
            "plz": "50667",
            "ort": "Köln",
            "preis": 489000,
            "preis_auf_anfrage": false,
            "waehrung": "EUR",
            "bilder": 1,
            "anfragen": 0,
            "erstellt": "2026-09-26T01:02:39+02:00",
            "geaendert": "2026-09-26T01:02:39+02:00",
            "veroeffentlicht_am": "2026-09-26T01:02:39+02:00",
            "laeuft_ab_am": null
        }
    ],
    "weiter": null
}

Fetching enquiries

GET /v1/anfragen returns enquiries in the order of their last change, together with a cursor weiter. Store it and pass it as ?nach= on the next call: you will only get what is new or has changed since. Polling every five minutes is enough.

curl -X GET "https://api.immoriver.com/v1/anfragen?nach=MjAyNi0wOS0yNiAwMTowMjozN3ww" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"

Response

HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 120
RateLimit-Remaining: 115
RateLimit-Reset: 18

{
    "anfragen": [
        {
            "anfragenummer": 4013130,
            "erstellt": "2026-09-26T01:02:42+02:00",
            "geaendert": "2026-09-26T01:02:42+02:00",
            "status": {
                "id": 84001,
                "code": "new",
                "text": "Neu"
            },
            "abschlussgrund": null,
            "anonymisiert": false,
            "objekt": {
                "obid": "DOKU-4711",
                "expose_nr": 112173,
                "objektnr_extern": "W-4711",
                "titel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer"
            },
            "projekt": null,
            "interessent": {
                "anrede": {
                    "id": 65002,
                    "code": "herr",
                    "text": "Herr"
                },
                "vorname": "Jonas",
                "nachname": "Weber",
                "firma": null,
                "email": "doku@immoriver.invalid",
                "telefon": "+49 170 1234567",
                "strasse": null,
                "plz": "50823",
                "ort": "Köln",
                "land": "DE"
            },
            "nachricht": "Guten Tag, ist die Wohnung noch frei? Ich würde sie gern am Samstag besichtigen.",
            "wuensche": {
                "rueckruf": false,
                "besichtigung": true,
                "finanzierung": true,
                "unterlagen": false
            },
            "mietangaben": null,
            "einwilligung": {
                "am": "2026-09-26T01:02:42+02:00",
                "fassung": "2026-08"
            }
        }
    ],
    "weiter": "MjAyNi0wOS0yNiAwMTowMjo0Mnw1Nw",
    "mehr": false
}

GET /v1/anfragen/{anfragenummer} additionally shows the message history. Report the handling status with POST /v1/anfragen/{anfragenummer}/status: opened, contacted, qualified, appointment or closed (with abschlussgrund vergeben, zurueckgezogen, vom_markt or erledigt). This keeps your response rate in the portal correct and stops the reminder e-mails.

curl -X POST "https://api.immoriver.com/v1/anfragen/4013130/status" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  --data '{"status":"contacted"}'
Show response (HTTP 200)
HTTP 200
Content-Type: application/json; charset=UTF-8
RateLimit-Limit: 60
RateLimit-Remaining: 52
RateLimit-Reset: 17

{
    "anfragenummer": 4013130,
    "erstellt": "2026-09-26T01:02:42+02:00",
    "geaendert": "2026-09-26T01:02:43+02:00",
    "status": {
        "id": 84003,
        "code": "contacted",
        "text": "Kontaktiert"
    },
    "abschlussgrund": null,
    "anonymisiert": false,
    "objekt": {
        "obid": "DOKU-4711",
        "expose_nr": 112173,
        "objektnr_extern": "W-4711",
        "titel": "Helle 3-Zimmer-Wohnung mit Balkon nahe Rheinufer"
    },
    "projekt": null,
    "interessent": {
        "anrede": {
            "id": 65002,
            "code": "herr",
            "text": "Herr"
        },
        "vorname": "Jonas",
        "nachname": "Weber",
        "firma": null,
        "email": "doku@immoriver.invalid",
        "telefon": "+49 170 1234567",
        "strasse": null,
        "plz": "50823",
        "ort": "Köln",
        "land": "DE"
    },
    "nachricht": "Guten Tag, ist die Wohnung noch frei? Ich würde sie gern am Samstag besichtigen.",
    "wuensche": {
        "rueckruf": false,
        "besichtigung": true,
        "finanzierung": true,
        "unterlagen": false
    },
    "mietangaben": null,
    "einwilligung": {
        "am": "2026-09-26T01:02:42+02:00",
        "fassung": "2026-08"
    }
}

Data protection

You receive what the enquiry transmits to you anyway: name, contact details, message, requests and, for rental enquiries, the voluntary household details. The prospect’s consent (time, version) is included. If a prospect has their data erased, the enquiry reappears in the change feed with anonymisiert: true and without personal data. Please erase the data on your side too (Art. 17 and 19 GDPR). Every retrieval is logged.

Values and IDs

Every field with a fixed set of values (property type, heating, condition, status …) has a permanent ID for each value. The ID never changes, even if a text or an OpenImmo code changes; it is the safe choice for your software. The IDs are listed in the field reference below and machine-readable in GET /v1/feldkatalog (wertetabelle).

Responses return every value as an object with ID, code and text in the language of your request (Accept-Language: de or en):

"objektart": { "id": 10001, "code": "wohnung", "text": "Apartment" },
"heizungsart": [
  { "id": 32003, "code": "ZENTRAL", "text": "Central heating" },
  { "id": 32005, "code": "FUSSBODEN", "text": "Underfloor heating" }
]

In requests (PUT, POST) we accept any of three forms — the code as before, the ID, or the object from a response (id takes precedence over code). A GET response can therefore be sent back unchanged.

"heizungsart": ["ZENTRAL", "FUSSBODEN"]
"heizungsart": [32003, 32005]
"heizungsart": [{ "id": 32003 }, { "code": "FUSSBODEN" }]

Not a value list in this sense and therefore plain codes: country (ISO 3166-1 alpha-3), currency (ISO 4217) and energy efficiency class.

Currencies: EUR, USD, GBP, CHF, AED and GEL — via the API as well as in OpenImmo deliveries (preise/waehrung@iso_waehrung). If omitted, the local currency of the property applies (CHF in Switzerland, GBP in the UK, AED in the UAE, GEL in Georgia, otherwise EUR). The API rejects other codes; an FTP delivery ignores them and uses the local currency. Search and price filters convert to euros at the daily rate.

Field reference

All 298 fields. Required “immer” means: 422 without the field. “aktiv” means: needed for the listing to go online. The list is machine-readable at GET /v1/feldkatalog.

Property category

Field Type Description
objektkategorie.nutzungsart immer mehrfach Type of use, several allowed
Values (ID code): 24001 WOHNEN, 24002 GEWERBE, 24003 ANLAGE, 24004 WAZ
OpenImmo: objektkategorie/nutzungsart@*
objektkategorie.vermarktungsart immer mehrfach Marketing type. KAUF (sale) or MIETE_PACHT (rent/lease) is required; ERBPACHT and LEASING may be added
Values (ID code): 25001 KAUF, 25002 MIETE_PACHT, 25003 ERBPACHT, 25004 LEASING
OpenImmo: objektkategorie/vermarktungsart@*
objektkategorie.objektart.typ immer auswahl Property type (element under <objektart>)
Values (ID code): 10001 wohnung, 10002 haus, 10003 grundstueck, 10004 zimmer, 10005 buero_praxen, 10006 einzelhandel, 10007 gastgewerbe, 10008 hallen_lager_prod, 10009 land_und_forstwirtschaft, 10010 parken, 10011 sonstige, 10012 freizeitimmobilie_gewerblich, 10013 zinshaus_renditeobjekt
OpenImmo: objektkategorie/objektart/*
objektkategorie.objektart.untertyp auswahl Subtype depending on the property type (e.g. wohnungtyp, haustyp). Allowed values: /v1/wertelisten
Values per property type
OpenImmo: objektkategorie/objektart/*@*_typ

Location and address

Field Type Description
geo.plz immer text
up to 12 characters
Postcode
OpenImmo: geo/plz
geo.ort immer text
up to 120 characters
Town or city
OpenImmo: geo/ort
geo.strasse text
up to 150 characters
Street
OpenImmo: geo/strasse
geo.hausnummer text
up to 20 characters
House number
OpenImmo: geo/hausnummer
geo.land auswahl Country (ISO 3166-1 alpha-3; alpha-2 is converted)
Values: DEU, AUT, CHE, ESP, CYP, GEO, FRA
OpenImmo: geo/land@iso_land
geo.bundesland text
up to 80 characters
Federal state
OpenImmo: geo/bundesland
geo.regionaler_zusatz text
up to 120 characters
District
OpenImmo: geo/regionaler_zusatz
geo.lage_gebiet text
up to 191 characters
Location name (area, estate)
OpenImmo: geo/lage_gebiet
geo.breitengrad zahl
-90 … 90, 7 decimals
Latitude (WGS 84). If omitted we geocode the address
OpenImmo: geo/geokoordinaten@breitengrad
geo.laengengrad zahl
-180 … 180, 7 decimals
Longitude (WGS 84)
OpenImmo: geo/geokoordinaten@laengengrad
geo.etage ganzzahl
-5 … 200
Floor (0 = ground floor, negative = basement)
OpenImmo: geo/etage
geo.anzahl_etagen ganzzahl
0 … 200
Number of floors in the building
OpenImmo: geo/anzahl_etagen
geo.wohnungsnr text
up to 40 characters
Flat number
OpenImmo: geo/wohnungsnr
geo.flur text
up to 60 characters
Cadastral district
OpenImmo: geo/flur
geo.flurstueck text
up to 60 characters
Cadastral parcel
OpenImmo: geo/flurstueck
geo.gemarkung text
up to 120 characters
Cadastral area
OpenImmo: geo/gemarkung
geo.gemeindecode text
up to 20 characters
Official municipality code
OpenImmo: geo/gemeindecode
geo.lage_gebiet_gebiete auswahl Area type
Values (ID code): 90001 WOHN, 90002 GEWERBE, 90003 INDUSTRIE, 90004 MISCH, 90005 NEUBAU, 90006 ORTSLAGE, 90007 SIEDLUNG, 90008 STADTRAND, 90009 STADTTEIL, 90010 STADTZENTRUM, 90011 NEBENZENTRUM, 90012 1A, 90013 1B
OpenImmo: geo/lage_gebiet@gebiete
geo.lage_im_bau mehrfach Position in building
Values (ID code): 97001 LINKS, 97002 RECHTS, 97003 VORNE, 97004 HINTEN
OpenImmo: geo/lage_im_bau@*

Contact person

Field Type Description
kontaktperson.anrede text
up to 40 characters
Salutation
OpenImmo: kontaktperson/anrede
kontaktperson.vorname text
up to 100 characters
First name
OpenImmo: kontaktperson/vorname
kontaktperson.name text
up to 100 characters
Last name
OpenImmo: kontaktperson/name
kontaktperson.firma text
up to 191 characters
Company
OpenImmo: kontaktperson/firma
kontaktperson.email_direkt text
up to 191 characters
Personal e-mail of the agent in charge. Enquiries for this listing go there. If there is no account for it yet, we add a pending team member to your company, which you confirm or decline under /konto/team
OpenImmo: kontaktperson/email_direkt
kontaktperson.email_zentrale text
up to 191 characters
Office e-mail. Without email_direkt it counts as the agent’s address (with the same effect). Without either, enquiries go to your company address
OpenImmo: kontaktperson/email_zentrale
kontaktperson.tel_durchw text
up to 60 characters
Phone (direct line)
OpenImmo: kontaktperson/tel_durchw
kontaktperson.tel_zentrale text
up to 60 characters
Phone (office)
OpenImmo: kontaktperson/tel_zentrale
kontaktperson.tel_handy text
up to 60 characters
Mobile phone
OpenImmo: kontaktperson/tel_handy
kontaktperson.strasse text
up to 150 characters
Office street
OpenImmo: kontaktperson/strasse
kontaktperson.plz text
up to 12 characters
Office postcode
OpenImmo: kontaktperson/plz
kontaktperson.ort text
up to 120 characters
Office town
OpenImmo: kontaktperson/ort
kontaktperson.url text
up to 255 characters
Website
OpenImmo: kontaktperson/url
kontaktperson.personennummer text
up to 100 characters
Your internal ID of the person (helps with shared office addresses)
OpenImmo: kontaktperson/personennummer

Prices and commission

Field Type Description
preise.kaufpreis aktiv zahl
0 … 999999999999.99, 2 decimals
Purchase price
OpenImmo: preise/kaufpreis
preise.kaufpreis_auf_anfrage bool Price on request. Replaces the purchase price for publishing
OpenImmo: preise/kaufpreis@auf_anfrage
preise.kaufpreisnetto zahl
0 … 999999999999.99, 2 decimals
Purchase price net
OpenImmo: preise/kaufpreisnetto
preise.kaufpreis_pro_qm zahl
0 … 9999999999.99, 2 decimals
Purchase price per m²
OpenImmo: preise/kaufpreis_pro_qm
preise.kaltmiete aktiv zahl
0 … 9999999999.99, 2 decimals
Basic rent per month
OpenImmo: preise/kaltmiete
preise.warmmiete zahl
0 … 9999999999.99, 2 decimals
Total rent per month
OpenImmo: preise/warmmiete
preise.nettokaltmiete zahl
0 … 9999999999.99, 2 decimals
Net basic rent
OpenImmo: preise/nettokaltmiete
preise.nebenkosten zahl
0 … 9999999999.99, 2 decimals
Service charges per month
OpenImmo: preise/nebenkosten
preise.heizkosten zahl
0 … 9999999999.99, 2 decimals
Heating costs per month
OpenImmo: preise/heizkosten
preise.heizkosten_enthalten bool Heating included in service charges
OpenImmo: preise/heizkosten_enthalten
preise.mietpreis_pro_qm zahl
0 … 99999999.99, 2 decimals
Rent per m²
OpenImmo: preise/mietpreis_pro_qm
preise.pauschalmiete zahl
0 … 9999999999.99, 2 decimals
All-inclusive rent
OpenImmo: preise/pauschalmiete
preise.mietzuschlaege zahl
0 … 9999999999.99, 2 decimals
Rent surcharges
OpenImmo: preise/mietzuschlaege
preise.hausgeld zahl
0 … 9999999999.99, 2 decimals
Owners’ association fee per month
OpenImmo: preise/hausgeld
preise.kaution zahl
0 … 9999999999.99, 2 decimals
Deposit
OpenImmo: preise/kaution
preise.kaution_text text
up to 255 characters
Deposit as text (e.g. “3 months’ rent”)
OpenImmo: preise/kaution_text
preise.pacht zahl
0 … 9999999999.99, 2 decimals
Lease
OpenImmo: preise/pacht
preise.erbpacht zahl
0 … 9999999999.99, 2 decimals
Ground rent per year
OpenImmo: preise/erbpacht
preise.erschliessungskosten zahl
0 … 9999999999.99, 2 decimals
Development costs
OpenImmo: preise/erschliessungskosten
preise.waehrung auswahl Currency (if omitted: the local currency — CHF in CH, GBP in GB, AED in AE, GEL in GE, otherwise EUR)
Values: EUR, USD, GBP, CHF, AED, GEL
OpenImmo: preise/waehrung@iso_waehrung
preise.preis_zeiteinheit auswahl Price period (short-term letting)
Values (ID code): 58001 TAG, 58002 WOCHE, 58003 MONAT, 58004 JAHR
OpenImmo: preise/preis_zeiteinheit@zeiteinheit
preise.provisionspflichtig immer bool Does the buyer or tenant pay a commission? Required, otherwise “commission-free” cannot be told apart
OpenImmo: preise/provisionspflichtig
preise.aussen_courtage text
up to 120 characters
Buyer’s commission
OpenImmo: preise/aussen_courtage
preise.aussen_courtage_mit_mwst bool Buyer’s commission incl. VAT
OpenImmo: preise/aussen_courtage@mit_mwst
preise.innen_courtage text
up to 120 characters
Seller’s commission
OpenImmo: preise/innen_courtage
preise.innen_courtage_mit_mwst bool Seller’s commission incl. VAT
OpenImmo: preise/innen_courtage@mit_mwst
preise.courtage_hinweis text
up to 500 characters
Commission note
OpenImmo: preise/courtage_hinweis
preise.provision_teilen text
up to 120 characters
Commission split (value)
OpenImmo: preise/provision_teilen
preise.provision_teilen_wert auswahl Type of commission split
Values (ID code): 59001 absolut, 59002 prozent, 59003 text
OpenImmo: preise/provision_teilen@wert
preise.provisionbrutto zahl
0 … 999999999999.99, 2 decimals
Commission gross (amount)
OpenImmo: preise/provisionbrutto
preise.provisionnetto zahl
0 … 999999999999.99, 2 decimals
Commission net (amount)
OpenImmo: preise/provisionnetto
preise.freitext_preis text
up to 2000 characters
Free text on price
OpenImmo: preise/freitext_preis
preise.mwst_satz zahl
0 … 100, 2 decimals
VAT rate in %
OpenImmo: preise/mwst_satz
preise.mwst_gesamt zahl
0 … 9999999999.99, 2 decimals
Total VAT
OpenImmo: preise/mwst_gesamt
preise.zzg_mehrwertsteuer bool Plus VAT (commercial)
OpenImmo: preise/zzg_mehrwertsteuer
preise.richtpreis zahl
0 … 9999999999.99, 2 decimals
Guide price
OpenImmo: preise/richtpreis
preise.x_fache zahl
0 … 999999.99, 2 decimals
Price multiplier (times annual rent)
OpenImmo: preise/x_fache
preise.nettorendite zahl
-100 … 9999.99, 2 decimals
Net yield in %
OpenImmo: preise/nettorendite
preise.nettorendite_soll zahl
-100 … 9999.99, 2 decimals
Target net yield in %
OpenImmo: preise/nettorendite_soll
preise.nettorendite_ist zahl
-100 … 9999.99, 2 decimals
Actual net yield in %
OpenImmo: preise/nettorendite_ist
preise.mieteinnahmen_ist zahl
0 … 999999999999.99, 2 decimals
Actual rental income (per year)
OpenImmo: preise/mieteinnahmen_ist
preise.mieteinnahmen_soll zahl
0 … 999999999999.99, 2 decimals
Target rental income (per year)
OpenImmo: preise/mieteinnahmen_soll
preise.stellplaetze liste Parking spaces: list of {art, anzahl, kaufpreis, miete}. art: GARAGE, TIEFGARAGE, CARPORT, FREIPLATZ, DUPLEX, PARKHAUS
OpenImmo: preise/stp_*
preise.kaufpreisbrutto zahl
0 … 999999999999.99, 2 decimals
Purchase price (gross)
OpenImmo: preise/kaufpreisbrutto
preise.hauptmietzinsnetto zahl
0 … 999999999999.99, 2 decimals
Main rent (net)
OpenImmo: preise/hauptmietzinsnetto
preise.hauptmietzinsnetto_hauptmietzinsust zahl
0 … 999999999999.99, 2 decimals
VAT on main rent
OpenImmo: preise/hauptmietzinsnetto@hauptmietzinsust
preise.betriebskostennetto zahl
0 … 999999999999.99, 2 decimals
Operating costs (net)
OpenImmo: preise/betriebskostennetto
preise.betriebskostennetto_betriebskostenust zahl
0 … 999999999999.99, 2 decimals
VAT on operating costs
OpenImmo: preise/betriebskostennetto@betriebskostenust
preise.evbnetto zahl
0 … 999999999999.99, 2 decimals
Maintenance and improvement contribution (net)
OpenImmo: preise/evbnetto
preise.evbnetto_evbust zahl
0 … 999999999999.99, 2 decimals
VAT on maintenance contribution
OpenImmo: preise/evbnetto@evbust
preise.gesamtmietenetto zahl
0 … 999999999999.99, 2 decimals
Total rent (net)
OpenImmo: preise/gesamtmietenetto
preise.gesamtmietenetto_gesamtmieteust zahl
0 … 999999999999.99, 2 decimals
VAT on total rent
OpenImmo: preise/gesamtmietenetto@gesamtmieteust
preise.gesamtmietebrutto zahl
0 … 999999999999.99, 2 decimals
Total rent (gross)
OpenImmo: preise/gesamtmietebrutto
preise.gesamtbelastungnetto zahl
0 … 999999999999.99, 2 decimals
Total charges (net)
OpenImmo: preise/gesamtbelastungnetto
preise.gesamtbelastungnetto_gesamtbelastungust zahl
0 … 999999999999.99, 2 decimals
VAT on total charges
OpenImmo: preise/gesamtbelastungnetto@gesamtbelastungust
preise.gesamtbelastungbrutto zahl
0 … 999999999999.99, 2 decimals
Total charges (gross)
OpenImmo: preise/gesamtbelastungbrutto
preise.gesamtkostenprom2von zahl
0 … 999999999999.99, 2 decimals
Total cost per m² from
OpenImmo: preise/gesamtkostenprom2von
preise.gesamtkostenprom2von_gesamtkostenprom2bis zahl
0 … 999999999999.99, 2 decimals
Total cost per m² to
OpenImmo: preise/gesamtkostenprom2von@gesamtkostenprom2bis
preise.heizkostennetto zahl
0 … 999999999999.99, 2 decimals
Heating costs (net)
OpenImmo: preise/heizkostennetto
preise.heizkostennetto_heizkostenust zahl
0 … 999999999999.99, 2 decimals
VAT on heating costs
OpenImmo: preise/heizkostennetto@heizkostenust
preise.monatlichekostennetto zahl
0 … 999999999999.99, 2 decimals
Monthly costs (net)
OpenImmo: preise/monatlichekostennetto
preise.monatlichekostennetto_monatlichekostenust zahl
0 … 999999999999.99, 2 decimals
VAT on monthly costs
OpenImmo: preise/monatlichekostennetto@monatlichekostenust
preise.monatlichekostenbrutto zahl
0 … 999999999999.99, 2 decimals
Monthly costs (gross)
OpenImmo: preise/monatlichekostenbrutto
preise.nebenkostenprom2von zahl
0 … 999999999999.99, 2 decimals
Service charges per m² from
OpenImmo: preise/nebenkostenprom2von
preise.nebenkostenprom2von_nebenkostenprom2bis zahl
0 … 999999999999.99, 2 decimals
Service charges per m² to
OpenImmo: preise/nebenkostenprom2von@nebenkostenprom2bis
preise.ruecklagenetto zahl
0 … 999999999999.99, 2 decimals
Maintenance reserve (net)
OpenImmo: preise/ruecklagenetto
preise.ruecklagenetto_ruecklageust zahl
0 … 999999999999.99, 2 decimals
VAT on reserve
OpenImmo: preise/ruecklagenetto@ruecklageust
preise.sonstigekostennetto zahl
0 … 999999999999.99, 2 decimals
Other costs (net)
OpenImmo: preise/sonstigekostennetto
preise.sonstigekostennetto_sonstigekostenust zahl
0 … 999999999999.99, 2 decimals
VAT on other costs
OpenImmo: preise/sonstigekostennetto@sonstigekostenust
preise.sonstigemietenetto zahl
0 … 999999999999.99, 2 decimals
Other rent (net)
OpenImmo: preise/sonstigemietenetto
preise.sonstigemietenetto_sonstigemieteust zahl
0 … 999999999999.99, 2 decimals
VAT on other rent
OpenImmo: preise/sonstigemietenetto@sonstigemieteust
preise.summemietenetto zahl
0 … 999999999999.99, 2 decimals
Rent total (net)
OpenImmo: preise/summemietenetto
preise.summemietenetto_summemieteust zahl
0 … 999999999999.99, 2 decimals
VAT on rent total
OpenImmo: preise/summemietenetto@summemieteust
preise.nettomieteprom2von zahl
0 … 999999999999.99, 2 decimals
Net rent per m² from
OpenImmo: preise/nettomieteprom2von
preise.nettomieteprom2von_nettomieteprom2bis zahl
0 … 999999999999.99, 2 decimals
Net rent per m² to
OpenImmo: preise/nettomieteprom2von@nettomieteprom2bis
preise.abstand zahl
0 … 999999999999.99, 2 decimals
Transfer fee
OpenImmo: preise/abstand
preise.preis_zeitraum_von datum Price valid from
OpenImmo: preise/preis_zeitraum_von
preise.preis_zeitraum_bis datum Price valid until
OpenImmo: preise/preis_zeitraum_bis
preise.geschaeftsguthaben zahl
0 … 999999999999.99, 2 decimals
Cooperative shares
OpenImmo: preise/geschaeftsguthaben
preise.richtpreisprom2 zahl
0 … 999999999999.99, 2 decimals
Guide price per m²
OpenImmo: preise/richtpreisprom2
preise.mieteinnahmen_ist_periode auswahl Period of actual rental income
Values (ID code): 58001 TAG, 58002 WOCHE, 58003 MONAT, 58004 JAHR
OpenImmo: preise/mieteinnahmen_ist@periode
preise.mieteinnahmen_soll_periode auswahl Period of target rental income
Values (ID code): 58001 TAG, 58002 WOCHE, 58003 MONAT, 58004 JAHR
OpenImmo: preise/mieteinnahmen_soll@periode

Bidding procedure

Field Type Description
bieterverfahren.beginn_angebotsphase datum Start of offer phase
OpenImmo: bieterverfahren/beginn_angebotsphase
bieterverfahren.besichtigungstermin datum Viewing date
OpenImmo: bieterverfahren/besichtigungstermin
bieterverfahren.besichtigungstermin_2 datum Second viewing date
OpenImmo: bieterverfahren/besichtigungstermin_2
bieterverfahren.beginn_bietzeit zeitpunkt Bidding starts (ISO 8601 with time)
OpenImmo: bieterverfahren/beginn_bietzeit
bieterverfahren.ende_bietzeit datum Bidding ends
OpenImmo: bieterverfahren/ende_bietzeit
bieterverfahren.mindestpreis zahl
0 … 999999999999.99, 2 decimals
Minimum price
OpenImmo: bieterverfahren/mindestpreis
bieterverfahren.hoechstgebot_zeigen bool Highest bid visible
OpenImmo: bieterverfahren/hoechstgebot_zeigen

Auction

Field Type Description
versteigerung.zwangsversteigerung bool Foreclosure auction
OpenImmo: versteigerung/zwangsversteigerung
versteigerung.aktenzeichen text
up to 255 characters
Case number
OpenImmo: versteigerung/aktenzeichen
versteigerung.amtsgericht text
up to 255 characters
Local court
OpenImmo: versteigerung/amtsgericht
versteigerung.zvtermin zeitpunkt Auction date (ISO 8601 with time)
OpenImmo: versteigerung/zvtermin
versteigerung.zusatztermin zeitpunkt Additional date (ISO 8601 with time)
OpenImmo: versteigerung/zusatztermin
versteigerung.verkehrswert zahl
0 … 999999999999.99, 2 decimals
Market value
OpenImmo: versteigerung/verkehrswert

Areas and rooms

Field Type Description
flaechen.wohnflaeche aktiv zahl
0 … 99999999.99, 2 decimals
Living area in m²
OpenImmo: flaechen/wohnflaeche
flaechen.nutzflaeche zahl
0 … 99999999.99, 2 decimals
Usable area in m²
OpenImmo: flaechen/nutzflaeche
flaechen.gesamtflaeche zahl
0 … 9999999999.99, 2 decimals
Total area in m²
OpenImmo: flaechen/gesamtflaeche
flaechen.grundstuecksflaeche zahl
0 … 9999999999.99, 2 decimals
Plot area in m²
OpenImmo: flaechen/grundstuecksflaeche
flaechen.bueroflaeche zahl
0 … 99999999.99, 2 decimals
Office area in m²
OpenImmo: flaechen/bueroflaeche
flaechen.lagerflaeche zahl
0 … 99999999.99, 2 decimals
Storage area in m²
OpenImmo: flaechen/lagerflaeche
flaechen.verkaufsflaeche zahl
0 … 99999999.99, 2 decimals
Sales area in m²
OpenImmo: flaechen/verkaufsflaeche
flaechen.ladenflaeche zahl
0 … 99999999.99, 2 decimals
Shop area in m²
OpenImmo: flaechen/ladenflaeche
flaechen.gastroflaeche zahl
0 … 99999999.99, 2 decimals
Restaurant area in m²
OpenImmo: flaechen/gastroflaeche
flaechen.gartenflaeche zahl
0 … 99999999.99, 2 decimals
Garden area in m²
OpenImmo: flaechen/gartenflaeche
flaechen.kellerflaeche zahl
0 … 99999999.99, 2 decimals
Cellar area in m²
OpenImmo: flaechen/kellerflaeche
flaechen.balkon_terrasse_flaeche zahl
0 … 99999999.99, 2 decimals
Balcony and terrace area in m²
OpenImmo: flaechen/balkon_terrasse_flaeche
flaechen.dachbodenflaeche zahl
0 … 99999999.99, 2 decimals
Attic area in m²
OpenImmo: flaechen/dachbodenflaeche
flaechen.beheizbare_flaeche zahl
0 … 99999999.99, 2 decimals
Heated area in m²
OpenImmo: flaechen/beheizbare_flaeche
flaechen.freiflaeche zahl
0 … 99999999.99, 2 decimals
Open space in m²
OpenImmo: flaechen/freiflaeche
flaechen.sonstflaeche zahl
0 … 99999999.99, 2 decimals
Other area in m²
OpenImmo: flaechen/sonstflaeche
flaechen.vermietbare_flaeche zahl
0 … 99999999.99, 2 decimals
Lettable area in m²
OpenImmo: flaechen/vermietbare_flaeche
flaechen.teilbar_ab zahl
0 … 99999999.99, 2 decimals
Divisible from in m²
OpenImmo: flaechen/teilbar_ab
flaechen.bgf zahl
0 … 99999999.99, 2 decimals
Gross floor area in m²
OpenImmo: flaechen/bgf
flaechen.kubatur zahl
0 … 9999999999.99, 2 decimals
Building volume in m³
OpenImmo: flaechen/kubatur
flaechen.grz zahl
0 … 999.999, 3 decimals
Site occupancy index (GRZ)
OpenImmo: flaechen/grz
flaechen.gfz zahl
0 … 999.999, 3 decimals
Floor area ratio (GFZ)
OpenImmo: flaechen/gfz
flaechen.anzahl_zimmer aktiv zahl
0 … 999.5, 1 decimals
Rooms (halves allowed)
OpenImmo: flaechen/anzahl_zimmer
flaechen.anzahl_schlafzimmer zahl
0 … 999.5, 1 decimals
Bedrooms
OpenImmo: flaechen/anzahl_schlafzimmer
flaechen.anzahl_badezimmer zahl
0 … 999.5, 1 decimals
Bathrooms
OpenImmo: flaechen/anzahl_badezimmer
flaechen.anzahl_sep_wc ganzzahl
0 … 65535
Separate WCs
OpenImmo: flaechen/anzahl_sep_wc
flaechen.anzahl_balkone ganzzahl
0 … 65535
Balconies (1 or more marks the listing “with balcony”)
OpenImmo: flaechen/anzahl_balkone
flaechen.anzahl_terrassen ganzzahl
0 … 65535
Terraces (1 or more marks the listing “with terrace”)
OpenImmo: flaechen/anzahl_terrassen
flaechen.anzahl_logia ganzzahl
0 … 65535
Loggias
OpenImmo: flaechen/anzahl_logia
flaechen.anzahl_wohn_schlafzimmer ganzzahl
0 … 65535
Living-bedrooms
OpenImmo: flaechen/anzahl_wohn_schlafzimmer
flaechen.anzahl_stellplaetze ganzzahl
0 … 65535
Parking spaces
OpenImmo: flaechen/anzahl_stellplaetze
flaechen.anzahl_wohneinheiten ganzzahl
0 … 65535
Residential units
OpenImmo: flaechen/anzahl_wohneinheiten
flaechen.anzahl_gewerbeeinheiten ganzzahl
0 … 65535
Commercial units
OpenImmo: flaechen/anzahl_gewerbeeinheiten
flaechen.anzahl_betten ganzzahl
0 … 65535
Beds
OpenImmo: flaechen/anzahl_betten
flaechen.einliegerwohnung bool With granny flat
OpenImmo: flaechen/einliegerwohnung
flaechen.bueroteilflaeche zahl
0 … 9999999999.99, 2 decimals
Office sub-area in m²
OpenImmo: flaechen/bueroteilflaeche
flaechen.verwaltungsflaeche zahl
0 … 9999999999.99, 2 decimals
Administrative area in m²
OpenImmo: flaechen/verwaltungsflaeche
flaechen.flaechevon zahl
0 … 9999999999.99, 2 decimals
Area from in m²
OpenImmo: flaechen/flaechevon
flaechen.flaechebis zahl
0 … 9999999999.99, 2 decimals
Area to in m²
OpenImmo: flaechen/flaechebis
flaechen.fensterfront zahl
0 … 9999999999.99, 2 decimals
Window frontage in m
OpenImmo: flaechen/fensterfront
flaechen.fensterfront_qm zahl
0 … 9999999999.99, 2 decimals
Window area in m²
OpenImmo: flaechen/fensterfront_qm
flaechen.grundstuecksfront zahl
0 … 9999999999.99, 2 decimals
Plot frontage in m
OpenImmo: flaechen/grundstuecksfront
flaechen.plaetze_gastraum ganzzahl
0 … 2147483647
Seats in dining room
OpenImmo: flaechen/plaetze_gastraum
flaechen.anzahl_tagungsraeume ganzzahl
0 … 2147483647
Conference rooms
OpenImmo: flaechen/anzahl_tagungsraeume
flaechen.bmz zahl
0 … 9999999999.99, 2 decimals
Building mass ratio
OpenImmo: flaechen/bmz
flaechen.ausnuetzungsziffer zahl
0 … 9999999999.99, 2 decimals
Plot utilisation ratio
OpenImmo: flaechen/ausnuetzungsziffer

Features

Field Type Description
ausstattung.ausstatt_kategorie auswahl Quality of fittings
Values (ID code): 52001 STANDARD, 52002 GEHOBEN, 52003 LUXUS
OpenImmo: ausstattung/ausstatt_kategorie
ausstattung.heizungsart mehrfach Heating type
Values (ID code): 32001 OFEN, 32002 ETAGE, 32003 ZENTRAL, 32004 FERN, 32005 FUSSBODEN
OpenImmo: ausstattung/heizungsart@*
ausstattung.befeuerung mehrfach Heating fuel (what the heating can use)
Values (ID code): 33001 OEL, 33002 GAS, 33003 ELEKTRO, 33004 ALTERNATIV, 33005 SOLAR, 33006 ERDWAERME, 33007 LUFTWP, 33008 FERN, 33009 BLOCK, 33010 WASSER-ELEKTRO, 33011 PELLET, 33012 KOHLE, 33013 HOLZ, 33014 FLUESSIGGAS
OpenImmo: ausstattung/befeuerung@*
ausstattung.bad mehrfach Bathroom
Values (ID code): 40001 DUSCHE, 40002 WANNE, 40003 FENSTER, 40004 BIDET, 40005 PISSOIR
OpenImmo: ausstattung/bad@*
ausstattung.kueche mehrfach Kitchen (EBK = fitted kitchen)
Values (ID code): 41001 EBK, 41002 OFFEN, 41003 PANTRY
OpenImmo: ausstattung/kueche@*
ausstattung.boden mehrfach Flooring
Values (ID code): 42001 FLIESEN, 42002 STEIN, 42003 TEPPICH, 42004 PARKETT, 42005 FERTIGPARKETT, 42006 LAMINAT, 42007 DIELEN, 42008 KUNSTSTOFF, 42009 ESTRICH, 42010 DOPPELBODEN, 42011 LINOLEUM, 42012 MARMOR, 42013 TERRAKOTTA, 42014 GRANIT, 42015 VINYL
OpenImmo: ausstattung/boden@*
ausstattung.stellplatzart mehrfach Parking type
Values (ID code): 43001 GARAGE, 43002 TIEFGARAGE, 43003 CARPORT, 43004 FREIPLATZ, 43005 PARKHAUS, 43006 DUPLEX
OpenImmo: ausstattung/stellplatzart@*
ausstattung.fahrstuhl mehrfach Lift
Values (ID code): 44001 PERSONEN, 44002 LASTEN
OpenImmo: ausstattung/fahrstuhl@*
ausstattung.ausricht_balkon_terrasse mehrfach Balcony or terrace orientation
Values (ID code): 45001 NORD, 45002 OST, 45003 SUED, 45004 WEST, 45005 NORDOST, 45006 NORDWEST, 45007 SUEDOST, 45008 SUEDWEST
OpenImmo: ausstattung/ausricht_balkon_terrasse@*
ausstattung.dachform mehrfach Roof type
Values (ID code): 46001 KRUEPPELWALMDACH, 46002 MANSARDDACH, 46003 PULTDACH, 46004 SATTELDACH, 46005 WALMDACH, 46006 FLACHDACH, 46007 PYRAMIDENDACH
OpenImmo: ausstattung/dachform@*
ausstattung.bauweise mehrfach Construction method
Values (ID code): 47001 MASSIV, 47002 FERTIGTEILE, 47003 HOLZ
OpenImmo: ausstattung/bauweise@*
ausstattung.ausbaustufe mehrfach Completion level (house)
Values (ID code): 48001 BAUSATZHAUS, 48002 AUSBAUHAUS, 48003 SCHLUESSELFERTIGMITKELLER, 48004 SCHLUESSELFERTIGOHNEBODENPLATTE, 48005 SCHLUESSELFERTIGMITBODENPLATTE
OpenImmo: ausstattung/ausbaustufe@*
ausstattung.moebliert auswahl Furnished
Values (ID code): 49001 VOLL, 49002 TEIL
OpenImmo: ausstattung/moebliert@moeb
ausstattung.unterkellert auswahl Basement
Values (ID code): 50001 JA, 50002 NEIN, 50003 TEIL
OpenImmo: ausstattung/unterkellert@keller
ausstattung.breitband_art text
up to 60 characters
Broadband (e.g. fibre, DSL)
OpenImmo: ausstattung/breitband_zugang@art
ausstattung.breitband_speed zahl
0 … 100000, 2 decimals
Bandwidth in Mbit/s
OpenImmo: ausstattung/breitband_zugang@speed
ausstattung.gartennutzung bool Garden or garden use
OpenImmo: ausstattung/gartennutzung
ausstattung.gaestewc bool Guest WC
OpenImmo: ausstattung/gaestewc
ausstattung.kamin bool Fireplace
OpenImmo: ausstattung/kamin
ausstattung.klimatisiert bool Air-conditioned
OpenImmo: ausstattung/klimatisiert
ausstattung.barrierefrei bool Step-free
OpenImmo: ausstattung/barrierefrei
ausstattung.rollstuhlgerecht bool Wheelchair accessible
OpenImmo: ausstattung/rollstuhlgerecht
ausstattung.seniorengerecht bool Suitable for seniors
OpenImmo: ausstattung/seniorengerecht
ausstattung.wg_geeignet bool Suitable for flat-sharing
OpenImmo: ausstattung/wg_geeignet
ausstattung.sauna bool Sauna
OpenImmo: ausstattung/sauna
ausstattung.swimmingpool bool Swimming pool
OpenImmo: ausstattung/swimmingpool
ausstattung.wellnessbereich bool Spa area
OpenImmo: ausstattung/wellnessbereich
ausstattung.wintergarten bool Conservatory
OpenImmo: ausstattung/wintergarten
ausstattung.abstellraum bool Storage room
OpenImmo: ausstattung/abstellraum
ausstattung.dachboden bool Attic
OpenImmo: ausstattung/dachboden
ausstattung.fahrradraum bool Bike storage
OpenImmo: ausstattung/fahrradraum
ausstattung.wasch_trockenraum bool Laundry room
OpenImmo: ausstattung/wasch_trockenraum
ausstattung.rolladen bool Roller shutters
OpenImmo: ausstattung/rolladen
ausstattung.kabel_sat_tv bool Cable or satellite TV
OpenImmo: ausstattung/kabel_sat_tv
ausstattung.bibliothek bool Library
OpenImmo: ausstattung/bibliothek
ausstattung.teekueche bool Kitchenette (commercial)
OpenImmo: ausstattung/teekueche
ausstattung.energietyp mehrfach Energy standard (KfW, passive house …); the first value is stored
Values (ID code): 39001 PASSIVHAUS, 39002 NIEDRIGENERGIE, 39003 NEUBAUSTANDARD, 39004 KFW40, 39005 KFW60, 39006 KFW55, 39007 KFW70, 39008 MINERGIEBAUWEISE, 39009 MINERGIE_ZERTIFIZIERT
OpenImmo: ausstattung/energietyp@*
ausstattung.raeume_veraenderbar bool Flexible room layout
OpenImmo: ausstattung/raeume_veraenderbar
ausstattung.dv_verkabelung bool Data cabling
OpenImmo: ausstattung/dv_verkabelung
ausstattung.kabelkanaele bool Cable ducts
OpenImmo: ausstattung/kabelkanaele
ausstattung.dvbt bool DVB-T reception
OpenImmo: ausstattung/dvbt
ausstattung.umts_empfang bool Mobile reception
OpenImmo: ausstattung/umts_empfang
ausstattung.telefon_ferienimmobilie bool Telephone available
OpenImmo: ausstattung/telefon_ferienimmobilie
ausstattung.rampe bool Loading ramp
OpenImmo: ausstattung/rampe
ausstattung.hebebuehne bool Lifting platform
OpenImmo: ausstattung/hebebuehne
ausstattung.kran bool Crane
OpenImmo: ausstattung/kran
ausstattung.hallenhoehe zahl
0 … 9999999999.99, 2 decimals
Hall height in m
OpenImmo: ausstattung/hallenhoehe
ausstattung.stromanschlusswert zahl
0 … 9999999999.99, 2 decimals
Power connection in kW
OpenImmo: ausstattung/stromanschlusswert
ausstattung.gastterrasse bool Guest terrace
OpenImmo: ausstattung/gastterrasse
ausstattung.kantine_cafeteria bool Canteen/cafeteria
OpenImmo: ausstattung/kantine_cafeteria
ausstattung.brauereibindung bool Brewery tie
OpenImmo: ausstattung/brauereibindung
ausstattung.sporteinrichtungen bool Sports facilities
OpenImmo: ausstattung/sporteinrichtungen
ausstattung.angeschl_gastronomie mehrfach Attached gastronomy
Values (ID code): 95001 HOTELRESTAURANT, 95002 BAR
OpenImmo: ausstattung/angeschl_gastronomie@*
ausstattung.serviceleistungen mehrfach Services
Values (ID code): 93001 BETREUTES_WOHNEN, 93002 CATERING, 93003 REINIGUNG, 93004 EINKAUF, 93005 WACHDIENST
OpenImmo: ausstattung/serviceleistungen@*
ausstattung.sicherheitstechnik mehrfach Security systems
Values (ID code): 94001 ALARMANLAGE, 94002 KAMERA, 94003 POLIZEIRUF
OpenImmo: ausstattung/sicherheitstechnik@*

Condition and energy certificate

Field Type Description
zustand_angaben.baujahr aktiv ganzzahl
1000 … 2100
Year of construction
OpenImmo: zustand_angaben/baujahr
zustand_angaben.letztemodernisierung ganzzahl
1000 … 2100
Year of last modernisation
OpenImmo: zustand_angaben/letztemodernisierung
zustand_angaben.zustand auswahl Condition
Values (ID code): 29001 ERSTBEZUG, 29002 TEIL_VOLLRENOVIERUNGSBED, 29003 NEUWERTIG, 29004 TEIL_VOLLSANIERT, 29005 TEIL_VOLLRENOVIERT, 29006 TEIL_SANIERT, 29007 VOLL_SANIERT, 29008 SANIERUNGSBEDUERFTIG, 29009 BAUFAELLIG, 29010 NACH_VEREINBARUNG, 29011 MODERNISIERT, 29012 GEPFLEGT, 29013 ROHBAU, 29014 ENTKERNT, 29015 ABRISSOBJEKT, 29016 PROJEKTIERT
OpenImmo: zustand_angaben/zustand@zustand_art
zustand_angaben.alter auswahl Old or new building
Values (ID code): 31001 ALTBAU, 31002 NEUBAU
OpenImmo: zustand_angaben/alter@alter_attr
zustand_angaben.erschliessung auswahl Site development
Values (ID code): 53001 UNERSCHLOSSEN, 53002 TEILERSCHLOSSEN, 53003 VOLLERSCHLOSSEN, 53004 ORTSUEBLICHERSCHLOSSEN
OpenImmo: zustand_angaben/erschliessung@erschl_attr
zustand_angaben.bebaubar_nach auswahl Buildable under
Values (ID code): 54001 34_NACHBARSCHAFT, 54002 35_AUSSENGEBIET, 54003 B_PLAN, 54004 KEIN BAULAND, 54005 BAUERWARTUNGSLAND, 54006 LAENDERSPEZIFISCH, 54007 BAULAND_OHNE_B_PLAN
OpenImmo: zustand_angaben/bebaubar_nach@bebaubar_attr
zustand_angaben.bauzone text
up to 120 characters
Building zone
OpenImmo: zustand_angaben/bauzone
zustand_angaben.altlasten text
up to 300 characters
Contamination
OpenImmo: zustand_angaben/altlasten
zustand_angaben.verkaufstatus auswahl Sales status. VERKAUFT removes the listing from search (status sold or let)
Values (ID code): 56001 OFFEN, 56002 RESERVIERT, 56003 VERKAUFT
OpenImmo: zustand_angaben/verkaufstatus@stand
zustand_angaben.energiepass.epart aktiv auswahl Type of energy certificate
Values (ID code): 35001 BEDARF, 35002 VERBRAUCH
OpenImmo: zustand_angaben/energiepass/epart
zustand_angaben.energiepass.jahrgang auswahl Certificate version: 2008, 2014, 2026, “ohne” (none), “nicht_noetig” (not required, e.g. listed building), “bei_besichtigung” (at viewing)
Values (ID code): 36001 2008, 36002 2014, 36003 2026, 36004 ohne, 36005 nicht_noetig, 36006 bei_besichtigung
OpenImmo: zustand_angaben/energiepass/jahrgang
zustand_angaben.energiepass.gebaeudeart auswahl Residential or non-residential building
Values (ID code): 37001 wohn, 37002 nichtwohn
OpenImmo: zustand_angaben/energiepass/gebaeudeart
zustand_angaben.energiepass.gueltig_bis datum Valid until
OpenImmo: zustand_angaben/energiepass/gueltig_bis
zustand_angaben.energiepass.ausstelldatum datum Issued on
OpenImmo: zustand_angaben/energiepass/ausstelldatum
zustand_angaben.energiepass.energieverbrauchkennwert aktiv zahl
0 … 99999999.99, 2 decimals
Energy consumption in kWh/(m²·a) (with epart VERBRAUCH)
OpenImmo: zustand_angaben/energiepass/energieverbrauchkennwert
zustand_angaben.energiepass.endenergiebedarf aktiv zahl
0 … 99999999.99, 2 decimals
Final energy demand in kWh/(m²·a) (with epart BEDARF)
OpenImmo: zustand_angaben/energiepass/endenergiebedarf
zustand_angaben.energiepass.primaerenergiebedarf zahl
0 … 99999999.99, 2 decimals
Primary energy demand in kWh/(m²·a)
OpenImmo: zustand_angaben/energiepass/primaerenergiebedarf
zustand_angaben.energiepass.primaerenergietraeger aktiv auswahl Main energy source
Values (ID code): 34001 GAS, 34002 OEL, 34003 FERN, 34004 ERDWAERME, 34005 LUFTWP, 34006 SOLAR, 34007 PELLET, 34008 HOLZ, 34009 ELEKTRO, 34010 BLOCK, 34011 FLUESSIGGAS, 34012 KOHLE, 34013 ALTERNATIV, 34014 ERDGAS_LEICHT, 34015 ERDGAS_SCHWER, 34016 NAHWAERME, 34017 FERN_DAMPF, 34018 WAERMEPUMPE, 34019 HACKSCHNITZEL, 34020 KWK_FOSSIL, 34021 KWK_ERNEUERBAR, 34022 BIOENERGIE, 34023 UMWELTWAERME, 34024 WINDENERGIE, 34025 WASSERKRAFT, 34026 KOKS
OpenImmo: zustand_angaben/energiepass/primaerenergietraeger
zustand_angaben.energiepass.wertklasse auswahl Energy efficiency class
Values: A+, A, B, C, D, E, F, G, H
OpenImmo: zustand_angaben/energiepass/wertklasse
zustand_angaben.energiepass.mitwarmwasser bool Value includes hot water
OpenImmo: zustand_angaben/energiepass/mitwarmwasser
zustand_angaben.energiepass.baujahr ganzzahl
1900 … 2100
Year the heating system was installed
OpenImmo: zustand_angaben/energiepass/baujahr
zustand_angaben.energiepass.hwbwert zahl
0 … 999999.99, 2 decimals
Heating demand HWB (Austria)
OpenImmo: zustand_angaben/energiepass/hwbwert
zustand_angaben.energiepass.hwbklasse text
up to 5 characters
HWB class (Austria)
OpenImmo: zustand_angaben/energiepass/hwbklasse
zustand_angaben.energiepass.fgeewert zahl
0 … 999.99, 2 decimals
Energy efficiency factor fGEE (Austria)
OpenImmo: zustand_angaben/energiepass/fgeewert
zustand_angaben.energiepass.fgeeklasse text
up to 5 characters
fGEE class (Austria)
OpenImmo: zustand_angaben/energiepass/fgeeklasse
zustand_angaben.energiepass.geg2018 text
up to 255 characters
Energy certificate under GEG
OpenImmo: zustand_angaben/energiepass/geg2018
zustand_angaben.energiepass.stromwert text
up to 255 characters
Electricity value
OpenImmo: zustand_angaben/energiepass/stromwert
zustand_angaben.energiepass.waermewert text
up to 255 characters
Heat value
OpenImmo: zustand_angaben/energiepass/waermewert
zustand_angaben.energiepass.epasstext text
up to 255 characters
Energy certificate note
OpenImmo: zustand_angaben/energiepass/epasstext

Surroundings

Field Type Description
infrastruktur.ausblick auswahl View
Values (ID code): 57001 FERNE, 57002 SEE, 57003 BERGE, 57004 MEER
OpenImmo: infrastruktur/ausblick@blick
infrastruktur.zulieferung bool Delivery access (commercial)
OpenImmo: infrastruktur/zulieferung
infrastruktur.distanzen liste Distances in km: list of {ziel, km}. ziel: FLUGHAFEN, FERNBAHNHOF, AUTOBAHN, US_BAHN, BUS, KINDERGAERTEN, GRUNDSCHULE, HAUPTSCHULE, REALSCHULE, GESAMTSCHULE, GYMNASIUM, ZENTRUM, EINKAUFSMOEGLICHKEITEN, GASTSTAETTEN
OpenImmo: infrastruktur/distanzen
infrastruktur.distanzen_sport liste Distances in km: list of {ziel, km}. ziel: STRAND, SEE, MEER, SKIGEBIET, SPORTANLAGEN, WANDERGEBIETE, NAHERHOLUNG
OpenImmo: infrastruktur/distanzen_sport

Texts

Field Type Description
freitexte.objekttitel immer text
up to 255 characters
Listing headline
OpenImmo: freitexte/objekttitel
freitexte.dreizeiler text
up to 500 characters
Short description (three lines)
OpenImmo: freitexte/dreizeiler
freitexte.objektbeschreibung text
up to 20000 characters
Description (paragraphs separated by a blank line, no HTML)
OpenImmo: freitexte/objektbeschreibung
freitexte.lage text
up to 20000 characters
Location description
OpenImmo: freitexte/lage
freitexte.ausstatt_beschr text
up to 20000 characters
Features description
OpenImmo: freitexte/ausstatt_beschr
freitexte.sonstige_angaben text
up to 20000 characters
Other information
OpenImmo: freitexte/sonstige_angaben

Images, floor plans, documents

Field Type Description
anhaenge aktiv liste Images and documents in display order: list of {gruppe, titel, url} or {gruppe, titel, medien_id} (upload via POST /v1/medien). The list is complete: anything missing is removed. At least one image is needed to go online
OpenImmo: anhaenge/anhang

Availability and letting

Field Type Description
verwaltung_objekt.objektadresse_freigeben bool Show street and house number in the listing (default: yes)
OpenImmo: verwaltung_objekt/objektadresse_freigeben
verwaltung_objekt.verfuegbar_ab text
up to 120 characters
Available from (text, e.g. “immediately”)
OpenImmo: verwaltung_objekt/verfuegbar_ab
verwaltung_objekt.abdatum datum Available from (date)
OpenImmo: verwaltung_objekt/abdatum
verwaltung_objekt.bisdatum datum Available until (date)
OpenImmo: verwaltung_objekt/bisdatum
verwaltung_objekt.min_mietdauer ganzzahl
0 … 9999
Minimum rental period (number)
OpenImmo: verwaltung_objekt/min_mietdauer
verwaltung_objekt.min_mietdauer_einheit auswahl Unit of the minimum rental period
Values (ID code): 58001 TAG, 58002 WOCHE, 58003 MONAT, 58004 JAHR
OpenImmo: verwaltung_objekt/min_mietdauer@min_dauer
verwaltung_objekt.max_mietdauer ganzzahl
0 … 9999
Maximum rental period (number)
OpenImmo: verwaltung_objekt/max_mietdauer
verwaltung_objekt.max_mietdauer_einheit auswahl Unit of the maximum rental period
Values (ID code): 58001 TAG, 58002 WOCHE, 58003 MONAT, 58004 JAHR
OpenImmo: verwaltung_objekt/max_mietdauer@max_dauer
verwaltung_objekt.max_personen ganzzahl
0 … 9999
Maximum number of persons
OpenImmo: verwaltung_objekt/max_personen
verwaltung_objekt.vermietet bool Let (investment)
OpenImmo: verwaltung_objekt/vermietet
verwaltung_objekt.wbs_sozialwohnung bool Social housing certificate required
OpenImmo: verwaltung_objekt/wbs_sozialwohnung
verwaltung_objekt.denkmalgeschuetzt bool Listed building (no energy certificate needed)
OpenImmo: verwaltung_objekt/denkmalgeschuetzt
verwaltung_objekt.haustiere bool Pets allowed
OpenImmo: verwaltung_objekt/haustiere
verwaltung_objekt.nichtraucher bool Non-smokers only
OpenImmo: verwaltung_objekt/nichtraucher
verwaltung_objekt.als_ferien bool Usable as holiday home
OpenImmo: verwaltung_objekt/als_ferien
verwaltung_objekt.gewerbliche_nutzung bool Commercial use possible
OpenImmo: verwaltung_objekt/gewerbliche_nutzung
verwaltung_objekt.hochhaus bool High-rise
OpenImmo: verwaltung_objekt/hochhaus
verwaltung_objekt.versteigerungstermin datum Auction date (day)
OpenImmo: verwaltung_objekt/versteigerungstermin
verwaltung_objekt.zugang text
up to 255 characters
Access from
OpenImmo: verwaltung_objekt/zugang
verwaltung_objekt.laufzeit zahl
0 … 9999999999.99, 2 decimals
Remaining ground lease term in Jahre
OpenImmo: verwaltung_objekt/laufzeit
verwaltung_objekt.branchen text
up to 255 characters
Suitable industries
OpenImmo: verwaltung_objekt/branchen
verwaltung_objekt.geschlecht_geschl_attr auswahl Let to
Values (ID code): 96001 EGAL, 96002 NUR_MANN, 96003 NUR_FRAU
OpenImmo: verwaltung_objekt/geschlecht@geschl_attr

Identifiers

Field Type Description
verwaltung_techn.objektnr_extern text
up to 191 characters
Your property number as shown in the exposé
OpenImmo: verwaltung_techn/objektnr_extern
verwaltung_techn.objektnr_intern text
up to 191 characters
Internal property number (not public)
OpenImmo: verwaltung_techn/objektnr_intern

Custom fields

Field Type Description
zusatzfelder zusatz Additional details as name → text (up to 50, name up to 60 characters, text up to 1,000). Shown under “More details” when the portal knows the name
OpenImmo: verwaltung_objekt/user_defined_simplefield@feldname

Property types and subtypes

objektkategorie.objektart.typ is the element under <objektart>, untertyp its attribute. Example: {"typ": "haus", "untertyp": "DOPPELHAUSHAELFTE"} becomes <haus haustyp="DOPPELHAUSHAELFTE"/>.

typuntertyp (ID code)
wohnung ID 10001
@wohnungtyp
12001 DACHGESCHOSS, 12002 MAISONETTE, 12003 LOFT-STUDIO-ATELIER, 12004 PENTHOUSE, 12005 TERRASSEN, 12006 ETAGE, 12007 ERDGESCHOSS, 12008 SOUTERRAIN, 12009 APARTMENT, 12010 FERIENWOHNUNG, 12011 GALERIE, 12012 ROHDACHBODEN, 12013 ATTIKAWOHNUNG, 12014 KEINE_ANGABE
haus ID 10002
@haustyp
13001 REIHENHAUS, 13002 REIHENEND, 13003 REIHENMITTEL, 13004 REIHENECK, 13005 DOPPELHAUSHAELFTE, 13006 EINFAMILIENHAUS, 13007 STADTHAUS, 13008 BUNGALOW, 13009 VILLA, 13010 RESTHOF, 13011 BAUERNHAUS, 13012 LANDHAUS, 13013 SCHLOSS, 13014 ZWEIFAMILIENHAUS, 13015 MEHRFAMILIENHAUS, 13016 FERIENHAUS, 13017 BERGHUETTE, 13018 CHALET, 13019 STRANDHAUS, 13020 LAUBE-DATSCHE-GARTENHAUS, 13021 APARTMENTHAUS, 13022 BURG, 13023 HERRENHAUS, 13024 FINCA, 13025 RUSTICO, 13026 FERTIGHAUS, 13027 KEINE_ANGABE
grundstueck ID 10003
@grundst_typ
14001 WOHNEN, 14002 GEWERBE, 14003 INDUSTRIE, 14004 LAND_FORSTWIRSCHAFT, 14005 FREIZEIT, 14006 GEMISCHT, 14007 GEWERBEPARK, 14008 SONDERNUTZUNG, 14009 SEELIEGENSCHAFT
zimmer ID 10004
@zimmertyp
11001 ZIMMER
buero_praxen ID 10005
@buero_typ
15001 BUEROFLAECHE, 15002 BUEROHAUS, 15003 BUEROZENTRUM, 15004 LOFT_ATELIER, 15005 PRAXIS, 15006 PRAXISFLAECHE, 15007 PRAXISHAUS, 15008 AUSSTELLUNGSFLAECHE, 15009 COWORKING, 15010 SHARED_OFFICE
einzelhandel ID 10006
@handel_typ
16001 LADENLOKAL, 16002 EINZELHANDELSLADEN, 16003 VERBRAUCHERMARKT, 16004 EINKAUFSZENTRUM, 16005 KAUFHAUS, 16006 FACTORY_OUTLET, 16007 KIOSK, 16008 VERKAUFSFLAECHE, 16009 AUSSTELLUNGSFLAECHE
gastgewerbe ID 10007
@gastgew_typ
17001 GASTRONOMIE, 17002 GASTRONOMIE_UND_WOHNUNG, 17003 PENSIONEN, 17004 HOTELS, 17005 WEITERE_BEHERBERGUNGSBETRIEBE, 17006 BAR, 17007 CAFE, 17008 DISCOTHEK, 17009 RESTAURANT, 17010 RAUCHERLOKAL, 17011 EINRAUMLOKAL
hallen_lager_prod ID 10008
@hallen_typ
18001 HALLE, 18002 INDUSTRIEHALLE, 18003 LAGER, 18004 LAGERFLAECHEN, 18005 LAGER_MIT_FREIFLAECHE, 18006 HOCHREGALLAGER, 18007 SPEDITIONSLAGER, 18008 PRODUKTION, 18009 WERKSTATT, 18010 SERVICE, 18011 FREIFLAECHEN, 18012 KUEHLHAUS
land_und_forstwirtschaft ID 10009
@land_typ
19001 LANDWIRTSCHAFTLICHE_BETRIEBE, 19002 BAUERNHOF, 19003 AUSSIEDLERHOF, 19004 GARTENBAU, 19005 ACKERBAU, 19006 WEINBAU, 19007 VIEHWIRTSCHAFT, 19008 JAGD_UND_FORSTWIRTSCHAFT, 19009 TEICH_UND_FISCHWIRTSCHAFT, 19010 SCHEUNEN, 19011 REITERHOEFE, 19012 SONSTIGE_LANDWIRTSCHAFTSIMMOBILIEN, 19013 ANWESEN, 19014 JAGDREVIER
parken ID 10010
@parken_typ
20001 STELLPLATZ, 20002 CARPORT, 20003 DOPPELGARAGE, 20004 DUPLEX, 20005 TIEFGARAGE, 20006 BOOTSLIEGEPLATZ, 20007 EINZELGARAGE, 20008 PARKHAUS, 20009 TIEFGARAGENSTELLPLATZ, 20010 PARKPLATZ_STROM
sonstige ID 10011
@sonstige_typ
21001 PARKHAUS, 21002 TANKSTELLE, 21003 KRANKENHAUS, 21004 SONSTIGE
freizeitimmobilie_gewerblich ID 10012
@freizeit_typ
22001 SPORTANLAGEN, 22002 VERGNUEGUNGSPARKS_UND_CENTER, 22003 FREIZEITANLAGE
zinshaus_renditeobjekt ID 10013
@zins_typ
23001 MEHRFAMILIENHAUS, 23002 WOHN_UND_GESCHAEFTSHAUS, 23003 GESCHAEFTSHAUS, 23004 BUEROGEBAEUDE, 23005 SB_MAERKTE, 23006 EINKAUFSCENTREN, 23007 WOHNANLAGEN, 23008 VERBRAUCHERMAERKTE, 23009 INDUSTRIEANLAGEN, 23010 PFLEGEHEIM, 23011 SANATORIUM, 23012 SENIORENHEIM, 23013 BETREUTES-WOHNEN

Errors

Errors come as application/problem+json (RFC 9457). What counts is code: it does not change within v1. title and detail are for humans and follow Accept-Language. Quote anfrage_id when contacting us; it is also in the X-Request-Id header of every response.

codeMeaning
nicht_gefundenNot found
This address does not exist in the API.
methode_nicht_erlaubtMethod not allowed
The address does not support this method, see the Allow header.
schluessel_fehltKey missing
Send your key as "Authorization: Bearer ir_live_…".
schluessel_ungueltigInvalid key
The key is unknown or has been revoked.
ip_nicht_erlaubtIP not allowed
This key has an IP allow-list that does not include this address.
testschluessel_nur_testobjekteTest objects only
A test key only changes objects that have never been public. Use a live key for published objects.
recht_fehltPermission missing
The key lacks the permission for this request.
kein_api_zugangNo API access
Your plan does not include API access. The API is part of all agency and developer plans.
firma_nicht_freigegebenCompany not approved
Your company has not been approved yet or is suspended.
zu_viele_anfragenToo many requests
The rate limit has been reached. Retry after Retry-After seconds.
zu_viele_fehlversucheToo many failed attempts
Too many invalid keys from this address. Wait ten minutes.
zu_grossRequest too large
JSON requests may be at most 2 MB. Send images via POST /v1/media, OpenImmo files via POST /v1/openimmo.
json_erwartetJSON expected
Send Content-Type: application/json.
json_ungueltigInvalid JSON
The body is not a valid JSON object.
pruefung_fehlgeschlagenValidation failed
At least one field is invalid, see fehler.
idempotenz_konfliktIdempotency key reused
The same Idempotency-Key was sent with a different body.
objekt_nicht_gefundenListing not found
Your company has no listing with this ID.
lieferung_nicht_gefundenDelivery not found
Your company has no delivery with this number.
anfrage_nicht_gefundenEnquiry not found
Your company has no enquiry with this number.
pflichtangaben_fehlenRequired details missing
The listing cannot go online like this, see fehlend.
kontingent_erschoepftQuota exhausted
Your plan allows no more simultaneously active listings. Pause one or choose a larger plan.
kein_paketNo plan
Your company has no active plan.
laufzeit_abgelaufenRun expired
The listing’s run has expired.
firma_ungeprueftCompany not yet verified
Listings go online only once the company has been verified. Until then they stay drafts.
als_verkauft_gemeldetReported as sold
The listing is reported as sold (verkaufstatus VERKAUFT).
unbekannter_statusUnknown status
Allowed: aktiv, entwurf, pausiert, verkauft, vermietet, archiviert.
medium_ungueltigFile not usable
Allowed are JPEG, PNG, WebP and PDF up to 15 MB.
datei_erwartetFile expected
Send the file as multipart/form-data (field datei) or as the body with a matching Content-Type.
openimmo_erwartetOpenImmo expected
Send OpenImmo XML (application/xml) or a ZIP with XML and images (application/zip).
nicht_erlaubtNot allowed
This change is not allowed.
serverfehlerServer error
An unexpected error. We have been notified; quote the anfrage_id when contacting us.

Field errors in fehler[] carry pfad and code: pflichtfeld, unbekanntes_feld, typ_text, typ_zahl, typ_ganzzahl, typ_bool, typ_datum, typ_liste, typ_objekt, zu_lang, zu_klein, zu_gross, unbekannter_wert, zu_viele, doppelt, format_email, format_url, kauf_oder_miete, url_oder_medien_id, untertyp_ohne_typ, zusatzname. Notes in hinweise[] (preis_fehlt, miete_fehlt, ohne_bild) block nothing; the listing just stays a draft.

curl -X PATCH "https://api.immoriver.com/v1/objekte/DOKU-4711" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL"
Show response (HTTP 405)
HTTP 405
Content-Type: application/problem+json; charset=UTF-8
Allow: GET, PUT, DELETE

{
    "type": "https://immoriver.com/entwickler#fehler-methode_nicht_erlaubt",
    "title": "Methode nicht erlaubt",
    "status": 405,
    "code": "methode_nicht_erlaubt",
    "detail": "Die Adresse kennt diese Methode nicht, siehe Kopfzeile Allow.",
    "anfrage_id": "00MUHKGEYL1E2EFEC884EC409B"
}

Limits

Reading120 requests per minute and key
Writing60 per minute
Uploads and OpenImmo30 per minute
Per day20 000 requests per key
BodyJSON up to 2 MB, images up to 15 MB, OpenImmo ZIP up to 100 MB
Attachments80 per listing; custom fields 50

Every response with a key carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (seconds until the next window). Above the limit the API responds with 429 and Retry-After. Wait the given number of seconds.

OpenImmo and FTP

If your software already produces OpenImmo, send the file directly: POST /v1/openimmo with Content-Type: application/xml, or as a ZIP with XML and images (application/zip, up to 100 MB). It runs exactly like an FTP delivery, including the provider ID check and immediate publishing according to your company setting. Swiss software with IDX 3.01 keeps delivering via FTP.

curl -X POST "https://api.immoriver.com/v1/openimmo?warten=20" \
  -H "Authorization: Bearer $IMMORIVER_SCHLUESSEL" \
  -H "Content-Type: application/zip" \
  --data-binary @lieferung.zip

ChatGPT and AI assistants (MCP)

Besides the API for providers there is a public MCP server (Model Context Protocol). ChatGPT, Claude and other AI assistants can use it to search the current listings on immoriver.com and read single listings. It is read-only and needs no key. It returns no provider contact details and sends no enquiries; every answer links to the listing page for that.

Endpointhttps://immoriver.com/mcp
TransportStreamable HTTP, JSON-RPC 2.0 via POST, JSON responses
Authenticationnone
search_propertiesSearch listings by place, buy or rent, property type, price, rooms, area, radius, country and keyword. Up to 10 results with the total count and a link to all results.
get_propertyOne listing by its exposé number: prices, areas, rooms, year built, energy, description and photos.
Limits60 messages per minute and network, at most 10 per batch, request up to 64 KB
Server card/.well-known/mcp/server-card.json

Results are ordered neutrally: newest first, or by price or area on request, never by paid placement. A call to try it:

curl -X POST https://immoriver.com/mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_properties","arguments":{"location":"Köln","transaction":"buy","rooms_min":3}}}'

Code examples

Delivering the same listing from objekt.json in three languages. The examples read the key from the environment, not from the source code.

PHP

<?php
$schluessel = getenv('IMMORIVER_SCHLUESSEL');
$objekt = file_get_contents('objekt.json');

$ch = curl_init('https://api.immoriver.com/v1/objekte/DOKU-4711?warten=20');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_POSTFIELDS     => $objekt,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . $schluessel,
        'Content-Type: application/json',
    ],
]);
$antwort = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($status === 422) {
    foreach ($antwort['fehler'] as $f) {
        echo $f['pfad'], ': ', $f['meldung'], "\n";
    }
} else {
    $o = $antwort['objekte'][0];
    echo $o['ergebnis'], ', ', $o['freigabe'], ', ', $o['url'] ?? '-', "\n";
}

JavaScript (Node.js 18+)

import { readFile } from 'node:fs/promises';

const antwort = await fetch('https://api.immoriver.com/v1/objekte/DOKU-4711?warten=20', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.IMMORIVER_SCHLUESSEL}`,
    'Content-Type': 'application/json',
  },
  body: await readFile('objekt.json', 'utf8'),
});
const daten = await antwort.json();

if (antwort.status === 422) {
  for (const f of daten.fehler) console.log(`${f.pfad}: ${f.meldung}`);
} else {
  const o = daten.objekte[0];
  console.log(o.ergebnis, o.freigabe, o.url ?? '-');
}

Python

import json, os, urllib.request

anfrage = urllib.request.Request(
    "https://api.immoriver.com/v1/objekte/DOKU-4711?warten=20",
    data=open("objekt.json", "rb").read(),
    method="PUT",
    headers={
        "Authorization": "Bearer " + os.environ["IMMORIVER_SCHLUESSEL"],
        "Content-Type": "application/json",
    },
)
try:
    with urllib.request.urlopen(anfrage) as antwort:
        o = json.load(antwort)["objekte"][0]
        print(o["ergebnis"], o["freigabe"], o.get("url"))
except urllib.error.HTTPError as fehler:
    for f in json.load(fehler).get("fehler", []):
        print(f["pfad"] + ": " + f["meldung"])

Fetching enquiries (PHP)

<?php
// Alle fünf Minuten per Cron. Der Cursor liegt in einer Datei.
$cursor = @file_get_contents('anfragen.cursor') ?: '';
$ch = curl_init('https://api.immoriver.com/v1/anfragen?nach=' . urlencode($cursor));
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('IMMORIVER_SCHLUESSEL')],
]);
$antwort = json_decode(curl_exec($ch), true);

foreach ($antwort['anfragen'] as $a) {
    if ($a['anonymisiert']) {
        // Interessent hat die Löschung verlangt: auch im eigenen CRM löschen
        continue;
    }
    // … in Ihr CRM übernehmen: $a['anfragenummer'], $a['interessent'], $a['nachricht']
}

if ($antwort['weiter'] !== null) {
    file_put_contents('anfragen.cursor', $antwort['weiter']);
}

Versions

v1 stays stable: new fields, values and endpoints are added without breaking existing integrations. Anything that would have to change incompatibly would come as v2 at a new address, and v1 would keep running. Ignore unknown fields in responses. The field catalogue version is in GET /v1 under feldkatalog.

25.09.2026v1 (field catalogue 1.0): first release

Questions about the integration: support@immoriver.com. Quote the anfrage_id from the response.