Öffentliche API

Das FastAPI-Backend veröffentlicht sein OpenAPI-Schema sowie interaktive Dokumentationen unter /docs und /redoc relativ zur API-Origin. Öffentliche Lese-Endpunkte benötigen keine Anmeldung; schreibende und interne Endpunkte sind separat geschützt.

GET /api/v1/polygons/overview?area_sizes=S,M&floors=EG,OG&categories=fashion,gastronomy&occupancy_statuses=VACANT
GET /api/v1/osm/features?west=9.42&south=54.78&east=9.44&north=54.80&zoom=16&categories=fashion,gastronomy&floors=EG,OG
GET /api/v1/analytics/overview?area_sizes=S,M&floors=EG,OG&sources=STADTPLANNER,OSM
GET /api/v1/analysis-areas/{area_id}/analytics?area_sizes=S,M

Die gemeinsamen Multi-Value-Parameter heißen categories, floors, area_sizes, occupancy_statuses, business_structures und sources. Der OSM-Viewport verwendet osm_categories separat für Umfeldlayer. Kommagetrennte Werte und wiederholte Parameter werden akzeptiert. Innerhalb eines Parameters gilt OR, zwischen Parametern AND; ungültige Enumwerte liefern HTTP 422.

Antworten werden als JSON ausgeliefert. Unbekannte Slugs liefern HTTP 404. Das OpenAPI-Schema ist die maßgebliche Referenz für Felder, Typen, Parameter und mögliche geschützte Operationen.

Implementierung, Datenmodelle, Migrationen und lokale Einrichtungsanleitungen liegen im offiziellen Projekt-Repository. Das veröffentlichte OpenAPI-Schema bleibt die maßgebliche Referenz für die jeweils laufende Instanz.