v5

latestOpenAPI 3.1.0Apache-2.02026-08-0212527433.1 KB
compare

Eine Ressource über mehrere Städte vergleichen

Vergleicht EINE Ressource (resource) über mehrere Städte (cities, kommasepariert) in einer einzigen Antwort. Jede Stadt trägt einen eigenen source_status (ok/disabled/no_data/error/not_found); eine fehlende oder tote Stadt-Quelle führt nicht zu einem Gesamt-5xx, sondern wird pro Stadt ehrlich ausgewiesen. resource wird gegen eine feste Liste geprüft (unbekannt -> 400). Neben weather/air sind auch indicators, demographics, unemployment, tourism, charging-status und weather-warnings vergleichbar. Das Ergebnis ist paginierbar (page/limit/offset/sort).

get/api/v1/compare

Query parameters

citiesstring required

Kommaseparierte Stadt-Slugs (auf MAX_CITIES begrenzt).

resource'weather' | 'air' | 'indicators' | 'demographics' | 'unemployment' | 'tourism' | 'charging-status' | 'weather-warnings' required

Zu vergleichende Ressource; unbekannt -> 400 invalid_request. weather/air = Live-Adapter (DWD/UBA); indicators, demographics, unemployment, tourism, charging-status und weather-warnings delegieren an die jeweiligen Stadt-Endpunkte (identisches Verhalten inkl. Attribution). charging-status liefert im Compare nur die Aggregate (points_omitted statt Einzelpunkt-Liste).

pageinteger
limitinteger
offsetinteger
sort'city' | 'source_status'
order'asc' | 'desc'

Headers

If-None-Matchstring

Conditional GET; If-None-Match == ETag -> 304 Not Modified ohne Body.

Response

Vergleichsliste mit per-Stadt source_status