(PL) API

Bieżące odczyty

GET /api/current_readings

Odpowiedź jest w formacie JSON.

Klucz	Typ	Opis
status	string	Status odpowiedzi. W przypadku sukcesu ok, a w przypadku błedu error. Status ok nie oznacza, że nie wystąpił błąd czujnika.
date	string	Data pomiaru w formacie ISO w czasie uniwersalnym (UTC).
temperature	float, null	Temperatura lub null w przypadku błedu czujnika.
humidity	integer, null	Wilgotność lub null w przypadku błedu czujnika.
pressure	integer, null	Ciśnienie lub null w przypadku błedu czujnika.
dewpoint	float, null	Punkt rosy lub null w przypadku błedu czujników.
pm1.0	integer, null	PM 1.0 lub null w przypadku błedu czujnika.
pm2.5	integer, null	PM 2.5 lub null w przypadku błedu czujnika.
pm10	integer, null	PM 10 lub null w przypadku błedu czujnika.
aqi	integer, null	Indeks jakości powietrza lub null w przypadku błedu czujnika.

Przykładowa odpowiedź:

{
    "status": "ok",
    "date": "2024-01-19T18:08:29.533089",
    "temperature": -1.5,
    "humidity": 77,
    "pressure": 1006,
    "dewpoint": -5,
    "pm1.0": 2,
    "pm2.5": 4,
    "pm10": 4,
    "aqi": 3
}

Archiwalne odczyty

GET /api/archive_readings

Parametry:

Klucz	Opis
start_date	Data początkowa w formacie ISO w czasie uniwersalnym (UTC).
end_date	Data końcowa w formacie ISO w czasie uniwersalnym (UTC).
all	Jeśli ustawione na true zwraca wszystkie odczyty.

Należy podać parametr start_date i end_date lub parametr all.

Odpowiedź jest w formacie JSON.

Klucz	Typ	Opis
status	string	Status odpowiedzi. W przypadku sukcesu ok, a w przypadku błedu error.
readings	list	Lista odczytów. Każdy odczyt zawiera następujące klucze: date, temperature, humidity, pressure, dewpoint, pm1.0, pm2.5, pm10, aqi.

Przykładowe zapytanie:

GET /api/archive_readings?start_date=2024-03-22&end_date=2024-03-22

Odpowiedź dla powyższego zapytania:

{
    "status": "ok",
    "readings": [
        {
            "temperature": 8.6,
            "humidity": 83,
            "pressure": 1008,
            "pm1.0": 0,
            "pm2.5": 1,
            "pm10": 1,
            "dewpoint": 5.9,
            "aqi": 0,
            "date": "2024-03-22T00:00:00"
        },

        ...

        {
            "temperature": 9.3,
            "humidity": 88,
            "pressure": 997,
            "pm1.0": 1,
            "pm2.5": 2,
            "pm10": 2,
            "dewpoint": 7.4,
            "aqi": 1,
            "date": "2024-03-22T23:00:00"
        }
    ]
}

Pobieranie archiwalnych odczytów

GET /api/archive_readings/download/<format>

Dostępne formaty:

Format	Nazwa
json	JSON
csv	CSV
sql	SQL
yaml	YAML
xml	XML
excel	Microsoft Excel

Parametry:

Klucz	Opis
start_date	Data początkowa w formacie ISO w czasie uniwersalnym (UTC).
end_date	Data końcowa w formacie ISO w czasie uniwersalnym (UTC).
all	Jeśli ustawione na true zwraca wszystkie odczyty.
format	Jeśli ustawione na true zwraca sformatowany plik. Tylko dla formatów json i xml.

Należy podać parametr start_date i end_date lub parametr all.

Przykładowe zapytania:

GET /api/archive_readings/download/json?start_date=2024-03-22&end_date=2024-03-22

GET /api/archive_readings/download/csv?all=true

GET /api/archive_readings/download/xml?start_date=2024-03-22&end_date=2024-03-22&format=true