Public API Reference — Hantavirus

Überblick

Hantavirus.app bietet eine öffentliche, schreibgeschützte API für den programmatischen Zugriff auf Ausbruchsdaten. Die API basiert auf tRPC und ist unter https://api.hantavir.us.com/api/trpc erreichbar.

Authentifizierung

Die öffentliche API ist nicht authentifiziert. Alle Leseprozeduren sind ohne API-Schlüssel verfügbar.

Ratenbegrenzungen

60 Anfragen pro Minute pro IP-Adresse
Ratenbegrenzungs-Header sind in den Antworten enthalten: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Bei Überschreitung wird 429 Too Many Requests zurückgegeben

tRPC-Router

Router	Wichtige Prozeduren	Cache-TTL
`outbreak.*`	getCurrent, getBySlug, list, getRiskLevel	30 s
`cases.*`	getCounts, getTimeSeries	30 s
`regions.*`	list, byCountry	60 s
`news.*`	list, getById	Keine
`timeline.*`	list	60 s (erste Seite)
`faqs.*`	list	Keine
`advisories.*`	list, byCountry	Keine
`ticker.*`	list	10 s

Die vollständige Prozedurdokumentation ist in der internen API-Referenz verfügbar.

REST-Endpunkte

Zur Vereinfachung bieten wir auch REST-Wrapper an:

Endpunkt	Methode	Beschreibung
`/v1/outbreak/:slug`	GET	Ausbruchs-Header anhand des Slugs abrufen
`/v1/outbreaks`	GET	Alle aktiven Ausbrüche auflisten
`/v1/cases/:slug`	GET	Fallzahlen für einen Ausbruch abrufen

Server-Sent Events (SSE)

Stream	Beschreibung	Ereignisse
`/sse/ticker`	Live-Nachrichtenticker-Updates	text, severity, link
`/sse/ships/:mmsi`	Schiffspositions-Updates	lat, lng, speed, heading

Beispiel: Ticker-SSE

const source = new EventSource('https://api.hantavir.us.com/sse/ticker');
source.onmessage = (e) => {
  const data = JSON.parse(e.data);
  console.log(data.text, data.severity);
};

Sprachunterstützung

Alle lokalisierten Prozeduren akzeptieren die Sprache über:

Cookie hv-locale
Header Accept-Language
Standard: en

Unterstützt: en, ar (Gulf Khaleeji), fr

Für vollständige API-Details siehe die vollständige API-Dokumentation.