Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamsebastiandev/krankenhausampelbayern.de

Dashboard zur Medizinischen Versorgungslage in Bayern.
https://github.com/iamsebastiandev/krankenhausampelbayern.de

api bayern covid-19 covid19 krankenhausampel

Last synced: 2 days ago
JSON representation

Dashboard zur Medizinischen Versorgungslage in Bayern.

Host: GitHub
URL: https://github.com/iamsebastiandev/krankenhausampelbayern.de
Owner: IamSebastianDev
License: other
Created: 2021-09-10T14:18:49.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2023-01-22T12:40:03.000Z (almost 2 years ago)
Last Synced: 2023-03-06T19:26:00.603Z (over 1 year ago)
Topics: api, bayern, covid-19, covid19, krankenhausampel
Language: JavaScript
Homepage: https://krankenhausampelbayern.de
Size: 975 KB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license.md

Awesome Lists containing this project

README

! Please note: The API is no longer hosted, but can still be self hosted for own use. The LGL Bayern is changing it's website regularly, and I do not have the necessry time to adjust the crawler.

# 🚦 Covid-19 Bayern

Die Covid-19 Krankenhausampel Bayern verfolgt das Ziel, eine möglichst vollständige übersicht über die aktuelle und vergangene medizinische Versorgungslage (in relation zu der Covid-19 Pandemie) in Bayern zu bieten und diese als Schnittstelle für verschiedene Consumer bereitzustellen.

## API - Request

Die Api besteht aus einem Puppeteer-crawler mit einer TTL von 30 Minuten der automatisiert die Seite des LGL Bayern crawlt. Die Daten werden dann aufbearbeitet und als JSON Datensatz gespeichert. Die API erstellt automatisch einen Datensatz pro Tag. Da das LGL Daten auch rückwirkend ändert, und dies auf der Seite nicht ersichtlich ist, sind die Daten der vergangenen Tage ausschließlich snapshots und sollten **nicht als vollständig angesehen werden**.

### Endpoint

Die API kann per `GET` request an `/api` abgefragt werden.

```js
// Zugriff auf die Daten der API im Browser

const response = await fetch('https://krankenhausampelbayern.de/api');
const data = await response.json();
```

### Queryparameter

Die API respektiert zwei verschiedene Queryparameter.

### `?timeframe=`

Der `timeframe` Queryparamter kann benutzt werden, um die Anzahl an Datensätzen zu begrenzen, die von der API zurückgegeben werden. Als standard werden alle vorhandenen Datensätze zurückgegeben. Der Parameter erwartet eine Nummer.

```js
const res = await fetch('/api?timeframe=14');
```

### `?omitmetadata=`

Der `omitmetadata` queryparameter kann benutzt werden, um die von der API mitgelieferten Metadaten zu ignorieren. Metadaten enthalten die Beschreibungen, Einheiten und andere Informationen die auch vom Consumer bestimmt werden können. Der Parameter erwartet einen boolean. (true oder false)

```js
const res = await fetch('/api?omitmetadata=true|false');
```

## API - Response

Das Schema der API-Response ist folgendes:

```js
{
// 'history' enthölt alle returnierten Datensätze
"history": [
{
// Gesamtanzahl aller mit Covid-19 Hospitalisirten Patienten
"hospitalized": ,
// Hospitalisierungen mit Covid-19 der letzten 7 Tage
"hospitalized7Days": ,
// Hospitalisierungsinzidenz
"hospitalizedIncidence": ,
// Anzahl der Patienten die mit Covid-19
// intensivmedizinisch behandelt werden.
"icuOccupation": ,
// Gesamtanzahl aller Positiv getesteten
"cases7Days": ,
// Gesamtinzidenz
"incidence7Days": ,
// Momentaner R-Wert
"rvalue": ,
// Prozentsatz der Grundimmunisierten
"vaccinated":
},
],
// 'metaData' Enthält die Metadaten der Datensätze.
// Das Schema für die Metadaten ist dabei für jeden Datenpunkt gleich.
"metaData": {
"hospitalized": {
// Der Titel des Datensatz
"title": ,
// Die Beschreibung des Datensatzes
"description": ,
// Der Wert bei dem die Stufe der Ampel überschritten wird.
// Definiert nur für 'icuOccupation' & 'Hospitalized7Days'
"threshold": ,
// Wenn die Zahl des Datensatzes eine Einheit benötigt ist
// diese hier definiert.
"unit":
},
...
// Der Zeitpunkt der Anfrage
"requestTimeStamp": ,
// Die Anzahl an returnierten Datensätze
"numberOfDataSets":
},
// 'Eventuelle Fehler bei der Anfrage'
"error": {
"message":
}
}
```

## Quelle

Die Quelle der Daten ist das [Bayrische Landesamt für Gesundheit und Lebensmittelsicherheit](https://www.lgl.bayern.de/gesundheit/infektionsschutz/infektionskrankheiten_a_z/coronavirus/karte_coronavirus/index.htm).

## Lizenz

Der Quellcode der API & des Dashboard sind [MIT-Lizenziert](https://opensource.org/licenses/MIT).