API

Jakość powietrza

Organizacja: Urząd Miasta Kielce 5 endpointów Nazwa techniczna: air-quality Wersja: v1 Własne Publiczne

Publiczne API stacji, sensorów oraz pomiarów jakości powietrza.

Tagi

  • Jakość powietrza

Dokumentacja

API udostępnia stacje, metadane sensorów, bieżące odczyty oraz pomiary historyczne jakości powietrza.

Endpointy API

GET /stations Stacje json

Zwraca listę aktywnych stacji jakości powietrza udostępnionych publicznie.

Metadane publikacyjne danych
Licencja Creative Commons Attribution 4.0 International
Organizacja Urząd Miasta Kielce
Poziom otwartości
Kategorie Jakość powietrza, Środowisko
Tagi Jakość powietrza
Źródła danych Syngeos
Wypróbuj endpoint

Endpoint

/api/public/air-quality/stations?version=v1
Request
GET /api/public/air-quality/stations
Response
[
  {
    "uri": "https://data.example.test/api/public/air-quality/stations#kielce-centrum",
    "id": "kielce-centrum",
    "provider": "syngeos",
    "externalId": "10288",
    "name": "Kielce Centrum",
    "address": "Rynek",
    "city": "Kielce",
    "source": "Syngeos",
    "location": {"lat": 50.870, "lon": 20.630},
    "historyEnabled": true
  }
]
GET /sensors Sensory json

Zwraca definicje sensorów, jednostki, etykiety i zakresy prezentacji.

Metadane publikacyjne danych
Licencja Creative Commons Attribution 4.0 International
Organizacja Urząd Miasta Kielce
Poziom otwartości
Kategorie Jakość powietrza, Środowisko
Tagi Jakość powietrza
Źródła danych Syngeos
Wypróbuj endpoint

Endpoint

/api/public/air-quality/sensors?version=v1
Request
GET /api/public/air-quality/sensors
Response
[
  {
    "uri": "https://data.example.test/api/public/air-quality/sensors#PM10",
    "code": "PM10",
    "label": "PM10",
    "unit": "ug/m3",
    "icon": "cloud",
    "sortOrder": 10,
    "groupCode": "particulate-matter",
    "groupOrder": 10,
    "minValue": 0,
    "maxValue": 100,
    "fadeStartMinutes": 60,
    "maxAgeMinutes": 180,
    "legend": [
      {"from": 0, "to": 20, "color": "#16a34a", "label": "Bardzo dobra"}
    ]
  }
]
GET /history/{stationId}/{sensorCode} Pomiary historyczne json

Zwraca pomiary historyczne wybranego sensora dla wskazanej stacji i zakresu dat.

Metadane publikacyjne danych
Licencja Creative Commons Attribution 4.0 International
Organizacja Urząd Miasta Kielce
Poziom otwartości
Kategorie Jakość powietrza, Środowisko
Tagi Jakość powietrza
Źródła danych Syngeos
Wypróbuj endpoint

Endpoint

/api/public/air-quality/history/{stationId}/{sensorCode}?version=v1

Parametry

Nazwa Położenie Typ Wymaganie Opis przykład
stationId ścieżka string wymagany Identyfikator stacji z endpointu /stations. 10288
sensorCode ścieżka string wymagany Kod sensora z endpointu /sensors, np. PM10. PM10
from query date wymagany Data początkowa zakresu w formacie YYYY-MM-DD. 2026-01-01
to query date wymagany Data końcowa zakresu w formacie YYYY-MM-DD. 2026-01-31
timezone query string opcjonalny Opcjonalna strefa czasu dla dat w odpowiedzi, np. Europe/Warsaw. Domyślnie UTC. Europe/Warsaw
Request
GET /api/public/air-quality/history/10288/PM10?from=2026-01-01&to=2026-01-31&timezone=Europe/Warsaw
Response
{
  "readings": [
    {
      "readAt": "2026-01-01T12:00:00+01:00",
      "value": 24.3
    }
  ]
}
GET /live Bieżące odczyty json

Zwraca najnowsze odczyty dla wszystkich aktywnych stacji.

Metadane publikacyjne danych
Licencja Creative Commons Attribution 4.0 International
Organizacja Urząd Miasta Kielce
Poziom otwartości
Kategorie Jakość powietrza, Środowisko
Tagi Jakość powietrza
Źródła danych Syngeos
Wypróbuj endpoint

Endpoint

/api/public/air-quality/live?version=v1
Request
GET /api/public/air-quality/live
Response
{
  "stations": [
    {
      "uri": "https://data.example.test/api/public/air-quality/stations#kielce-centrum",
      "stationId": "kielce-centrum",
      "readings": [
        {"sensorUri": "https://data.example.test/api/public/air-quality/sensors#PM10", "sensorCode": "PM10", "readAt": "2026-01-01T12:00:00+01:00", "value": 24.3}
      ],
      "error": null
    }
  ]
}
GET /live/{deviceId} Bieżące odczyty urządzenia json

Zwraca najnowsze odczyty dla pojedynczego urządzenia źródłowego.

Metadane publikacyjne danych
Licencja Creative Commons Attribution 4.0 International
Organizacja Urząd Miasta Kielce
Poziom otwartości
Kategorie Jakość powietrza, Środowisko
Tagi Jakość powietrza
Źródła danych Syngeos
Wypróbuj endpoint

Endpoint

/api/public/air-quality/live/{deviceId}?version=v1

Parametry

Nazwa Położenie Typ Wymaganie Opis przykład
deviceId ścieżka string wymagany Zewnętrzny identyfikator urządzenia pomiarowego. 10288
Request
GET /api/public/air-quality/live/10288
Response
{
  "readings": [
    {"sensorUri": "https://data.example.test/api/public/air-quality/sensors#PM10", "sensorCode": "PM10", "readAt": "2026-01-01T12:00:00+01:00", "value": 24.3}
  ]
}