API-Dokumentation

Maschinenlesbare Spezifikation: openapi.yaml (OpenAPI 3.0).

Authentifizierung

API-Key im Header mitschicken, entweder als X-API-Key oder als Authorization: Bearer <key>. Einen Key erstellen Sie im Entwickler-Dashboard (Anmeldung per Magic Link, kein Passwort).

Tiers

Tier	Limit/Tag	Zugriff
Public	100	1 Adresse/Anfrage, nur Gesamtscore
Developer	1.000	bis zu 20 Adressen/Anfrage, alle Dimensionen
Enterprise	10.000	wie Developer, plus Rohdaten/Bulk-Export (in Entwicklung), SLA

Self-Service-Registrierung erstellt Public-Tier-Keys. Für Developer/Enterprise (Pay-per-Call bzw. Abo, SLA) kontaktieren Sie uns direkt — kein Self-Service-Upgrade.

POST /api/v1/scores

Beispielanfrage (Public Tier):

curl -X POST https://www.lagepuls.de/api/v1/scores \
  -H "X-API-Key: imk_..." \
  -H "Content-Type: application/json" \
  -d '{"addresses": ["Alexanderplatz 1, Berlin"]}'

Beispielantwort:

{
  "tier": "public",
  "results": [
    {
      "address": "Alexanderplatz 1, Berlin",
      "status": "ok",
      "bezirk": "Mitte",
      "overall": {
        "score": 57,
        "ampel": "gelb",
        "dimensionsIncluded": 6,
        "dimensionsTotal": 6
      }
    }
  ]
}

Wichtige Hinweise

Abgedeckt sind Berlin, das Berliner Umland und die Ostseeküste MV (je mit unterschiedlicher Datentiefe) — Adressen außerhalb liefern `outside_pilot_region`.
Score-Werte sind regionale Perzentilränge, wöchentlich neu berechnet — keine Wertermittlung im Sinne der ImmoWertV, keine Anlageberatung. Details: Methodik.
Tageslimits sind ein rollierendes 24-Stunden-Fenster, kein Kalendertag-Reset.
overall.score verwendet immer die Standard-Dimensionsgewichtung. Die individuelle Gewichtungsanpassung („Käufer“/„Investor“/ „Familie“-Profile bzw. freie Regler) auf /bericht ist aktuell eine reine Web-UI-Funktion, kein API-Parameter — Developer/Enterprise- Antworten enthalten aber bereits alle dimensions[].score-Werte, aus denen sich ein eigener gewichteter Gesamtscore clientseitig nachbilden lässt.