Search
K
Objektverwaltung

Objektverwaltung

1.0.0OAS 3.0

Das führende Datenmodell für alle vermarkteten Objekte – Wohnungen, Häuser und
Gewerbeflächen. Objekte sind die Grundlage für Exposés, Matching und Bewertung.

Der Bestand lässt sich über OpenImmo befüllen und exportieren, sodass
bestehende Maklersoftware ohne Zwischenschritt angebunden werden kann.

API Base URL
  • Server 1:https://api.maklerportal.example/v1

    Produktion

  • Server 2:https://sandbox.api.maklerportal.example/v1

    Sandbox

Security
apiKey (apiKey)

Jeder Aufruf trägt einen API-Schlüssel im Header apikey. Den Schlüssel
erzeugen Sie im Maklerportal unter “Meine Anwendungen”; er wird genau einmal
angezeigt.

An jedem Schlüssel hängen die Scopes, die er nutzen darf. Fehlt einer,
antwortet die API mit 403 und code: "scope_fehlt"; der fehlende Scope
steht in details[].feld.

Additional Information
Contact API-Support Objektwerk GmbH (api-support@objektwerk.example)

Objekte

Objekte auflisten

get

Query Parameters

statusstring

Allowed values:entwurfaktivreserviertverkauftvermietetarchiviert

Example:aktiv

typstring

Allowed values:wohnunghausgrundstueckgewerbestellplatz

Example:wohnung

plzstring

Filter auf die Postleitzahl.

Example:20251

limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Trefferliste

datenarray
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/objekte
 
application/json

Objekt anlegen

post

Body

application/json

ObjektAnlegen

typstringrequired

Allowed values:wohnunghausgrundstueckgewerbestellplatz

Example:wohnung

titelstringrequired

<= 120 characters

Example:3-Zimmer-Altbau am Falkenried

beschreibungstring

Example:Gepflegte Altbauwohnung im zweiten Obergeschoss mit zwei Südbalkonen.

adresseobjectrequired
Show Child Parameters
wohnflaeche_qmnumber(float)

Example:86.5

grundstuecksflaeche_qmnumber(float)

Example:412

zimmernumber(float)

Example:3

baujahrinteger

Example:1908

etageinteger

Example:2

kaufpreis_eurinteger

Example:645000

kaltmiete_eurinteger

Example:1450

nebenkosten_eurinteger

Example:280

verfuegbar_abstring(date)

Example:2026-11-01

energieausweisobject

Kennwerte, die für die Veröffentlichung eines Exposés benötigt werden.

Show Child Parameters
provisionobject
Show Child Parameters

Response

application/json

Angelegt

Objekt

typstringrequired

Allowed values:wohnunghausgrundstueckgewerbestellplatz

Example:wohnung

titelstringrequired

<= 120 characters

Example:3-Zimmer-Altbau am Falkenried

beschreibungstring

Example:Gepflegte Altbauwohnung im zweiten Obergeschoss mit zwei Südbalkonen.

adresseobjectrequired
Show Child Parameters
wohnflaeche_qmnumber(float)

Example:86.5

grundstuecksflaeche_qmnumber(float)

Example:412

zimmernumber(float)

Example:3

baujahrinteger

Example:1908

etageinteger

Example:2

kaufpreis_eurinteger

Example:645000

kaltmiete_eurinteger

Example:1450

nebenkosten_eurinteger

Example:280

verfuegbar_abstring(date)

Example:2026-11-01

energieausweisobject

Kennwerte, die für die Veröffentlichung eines Exposés benötigt werden.

Show Child Parameters
provisionobject
Show Child Parameters
idstring

Example:obj_8f2c1a

statusstring

Allowed values:entwurfaktivreserviertverkauftvermietetarchiviert

Example:aktiv

medien_anzahlinteger

Example:14

angelegt_amstring(date-time)

Example:2026-08-14T08:12:44Z

geaendert_amstring(date-time)

Example:2026-08-20T09:38:02Z

post/objekte

Body

{ "typ": "wohnung", "titel": "3-Zimmer-Altbau am Falkenried", "adresse": { "strasse": "Falkenried 42", "plz": "20251", "ort": "Hamburg" }, "wohnflaeche_qm": 86.5, "zimmer": 3, "baujahr": 1908, "kaufpreis_eur": 645000, "provision": { "kaeufer_prozent": 3.57, "verkaeufer_prozent": 3.57 } }
 
application/json

Objekt abrufen

get

Path Parameters

objektIdstringrequired

Example:obj_8f2c1a

Response

application/json

Objekt

Objekt

typstringrequired

Allowed values:wohnunghausgrundstueckgewerbestellplatz

Example:wohnung

titelstringrequired

<= 120 characters

Example:3-Zimmer-Altbau am Falkenried

beschreibungstring

Example:Gepflegte Altbauwohnung im zweiten Obergeschoss mit zwei Südbalkonen.

adresseobjectrequired
Show Child Parameters
wohnflaeche_qmnumber(float)

Example:86.5

grundstuecksflaeche_qmnumber(float)

Example:412

zimmernumber(float)

Example:3

baujahrinteger

Example:1908

etageinteger

Example:2

kaufpreis_eurinteger

Example:645000

kaltmiete_eurinteger

Example:1450

nebenkosten_eurinteger

Example:280

verfuegbar_abstring(date)

Example:2026-11-01

energieausweisobject

Kennwerte, die für die Veröffentlichung eines Exposés benötigt werden.

Show Child Parameters
provisionobject
Show Child Parameters
idstring

Example:obj_8f2c1a

statusstring

Allowed values:entwurfaktivreserviertverkauftvermietetarchiviert

Example:aktiv

medien_anzahlinteger

Example:14

angelegt_amstring(date-time)

Example:2026-08-14T08:12:44Z

geaendert_amstring(date-time)

Example:2026-08-20T09:38:02Z

get/objekte/{objektId}
 
application/json