Interfejs programistyczny aplikacji (API) - Główny inspektorat ochrony środowiska
Interfejs programistyczny aplikacji (API)


Interfejs API portalu "Jakość Powietrza" GIOŚ umożliwia dostęp do danych dotyczących jakości powietrza w Polsce, wytwarzanych w ramach Państwowego Monitoringu Środowiska i gromadzonych w bazie JPOAT2,0. Poniższa lista opisuje usługi sieciowe udostępnione w ramach interfejsu API.

Udostępniane dane nie są na bieżąco weryfikowane, zatem mogą ulec zmianie w późniejszym czasie. Dane udostępniane są w czasie lokalnym.

Udostępniany poprzez API wynik CO (tlenku węgla) wyświetlany jest w jednostce μg/m3, na mapie portalu Jakości Powietrza przeliczony jest już na mg/m3.
Liczba sensorów udostępnianych przez API (identycznie jak na portalu Jakości Powietrza GIOŚ) jest stała i maksymalnie udostępniane są wyniki automatycznych pomiarów dwutlenku siarki (SO2), dwutlenku azotu (NO2), pyłu PM10, pyłu PM2,5, tlenku węgla (CO), benzenu (C6H6), ozonu (O3).
 

Ze względu na zdarzające się przypadki awarii sprzętu pomiarowego, awarii transmisji danych lub innych zdarzeń losowych na które pracownicy Głównego Inspektoratu Ochrony Środowiska nie mają wpływu, mogą występować sporadyczne przerwy w transmisji i prezentacji danych pomiarowych na portalu "Jakość Powietrza" oraz w aplikacjach korzystających z interfejsu API.

Korzystając z API akceptują Państwo wszystkie warunki zawarte w Regulaminie portalu. Użytkownik ponownie wykorzystujący informacje sektora publicznego udostępniane na portalu Jakość Powietrza zobowiązany jest w sposób czytelny i wyraźny wskazać źródło pozyskania informacji.

W przypadku wystąpienia problemów technicznych/informatycznych prosimy o kontakt na adres mailowy api (małpka) gios.gov.pl 

 

Stacje pomiarowe

Usługa sieciowa udostępniająca listę stacji pomiarowych.

http://api.gios.gov.pl/pjp-api/rest/station/findAll

Usługa sieciowa typu REST wykorzystująca zapytanie HTTP GET. Udostępniająca dane w formacie JSON.

Przykład zapytania: Usługa nie przyjmuje parametrów wejściowych.

Przykład odpowiedzi:

[{
    "id": 14,
    "stationName": "Działoszyn",
    "gegrLat": "50.972167",
    "gegrLon": "14.941319",
    "city": {
        "id": 192,
        "name": "Działoszyn",
        "commune": {
            "communeName": "Bogatynia",
            "districtName": "zgorzelecki",
            "provinceName": "DOLNOŚLĄSKIE"
        }
    },
    "addressStreet": null
}]

 

Stanowiska pomiarowe

Usługa sieciowa udostępniająca listę stanowisk pomiarowych dostępnych na wybranej stacji pomiarowej.

http://api.gios.gov.pl/pjp-api/rest/station/sensors/{stationId}

Usługa sieciowa typu REST wykorzystująca zapytanie HTTP GET. Udostępniająca dane w formacie JSON.

Przykład zapytania: http://api.gios.gov.pl/pjp-api/rest/station/sensors/14

Przykład odpowiedzi:

[{
    "id": 92,
    "stationId": 14,
    "param": {
        "paramName": "pył zawieszony PM10",
        "paramFormula": "PM10",
        "paramCode": "PM10",
        "idParam": 3
    }
},
{
    "id": 88,
    "stationId": 14,
    "param": {
        "paramName": "dwutlenek azotu",
        "paramFormula": "NO2",
        "paramCode": "NO2",
        "idParam": 6
    }
}]

 

Dane pomiarowe

Usługa sieciowa udostępniająca dane pomiarowe na podstawie podanego identyfikatora stanowiska pomiarowego.

http://api.gios.gov.pl/pjp-api/rest/data/getData/{sensorId}

Usługa sieciowa typu REST wykorzystująca zapytanie HTTP GET. Udostępniająca dane w formacie JSON.

Przykład zapytania: http://api.gios.gov.pl/pjp-api/rest/data/getData/92

Przykład odpowiedzi:

{
    "key": "PM10",
    "values": [
    {
        "date": "2017-03-28 11:00:00",
        "value": 30.3018
    },
    {
        "date": "2017-03-28 12:00:00",
        "value": 27.5946
    }]
}

Indeks jakości powietrza

Usługa sieciowa udostępniająca indeks jakości powietrza na podstawie podanego identyfikatora stacji pomiarowej.

http://api.gios.gov.pl/pjp-api/rest/aqindex/getIndex/{stationId}

Usługa sieciowa typu REST wykorzystująca zapytanie HTTP GET. Udostępniająca dane w formacie JSON.

Przykład zapytania: http://api.gios.gov.pl/pjp-api/rest/aqindex/getIndex/52

Przykład odpowiedzi:

{
    "id": 52,
    "stCalcDate": "2017-03-28 12:00:00",
    "stIndexLevel": {
        "id": 2,
        "indexLevelName": "Umiarkowany"
    },
    "stSourceDataDate": "2017-03-28 12:00:00",
    "so2CalcDate": "2017-03-28 12:00:00",
    "so2IndexLevel": 0,
        "id": 0,
        "IndexLevelName": "Bardzo dobry"
    "so2SourceDataDate": "2017-03-28 12:00:00",
    "no2CalcDate": "2017-03-28 12:00:00",
    "no2IndexLevel": 0,
        "id": 0,
        "IndexLevelName": "Bardzo dobry"
    "no2SourceDataDate": "2017-03-28 12:00:00",
    "pm10CalcDate": "2017-03-28 12:00:00",
    "pm10IndexLevel": 2,
        "id": 2,
        "IndexLevelName": "Umiarkowany"
    "pm10SourceDataDate": "2017-03-28 12:00:00",
    "pm25CalcDate": "2017-03-28 12:00:00",
    "pm25IndexLevel": 2,
        "id": 2,
        "IndexLevelName": "Umiarkowany"
    "pm25SourceDataDate": null,
    "o3CalcDate": "2017-03-28 12:00:00",
    "o3IndexLevel": null,
    "o3SourceDataDate": "2017-03-28 12:00:00",
}

 

Opis:
id": 52,  - oznacza numer id danej stacji pomiarowej, numery id wszystkich stacji udostępniane są poprzez pierwszą usługę  http://api.gios.gov.pl/pjp-api/rest/station/findAll
"stCalcDate": "2017-03-28 12:00:00", - data wykonania obliczeń indeksu
 "stIndexLevel": { - wartość indeksu dla stacji (co do zasady przybiera wartość  najgorszego z indeksów cząstkowych zanieczyszczeń)
  "id": 2, - wartość indeksu dla stacji wyrażona w postaci liczby -1 – Brak indeksu, 0 – Bardzo dobry, 1 – Dobry, 2 – Umiarkowany, 3 - Dostateczny, 4 – Zły, 5 – Bardzo zły
 "indexLevelName": "Umiarkowany" – jak wyżej – nazwa kategorii indeksu
"stSourceDataDate": "2017-03-28 12:00:00", - data danych źródłowych, z których policzono wartość indeksu
 "so2CalcDate": "2017-03-28 12:00:00", - Data wykonania obliczeń indeksu dla wskaźnika SO2
 "so2IndexLevel": null,  - Wartość indeksu dla wskaźnika SO2 (jak wyżej, zakresy indeksu o id od  -1 do 5 lub null jeśli na stacji nie są wykonywane pomiary danego zanieczyszczenia)
 "so2SourceDataDate": "2017-03-28 12:00:00", - Data danych źródłowych, z których policzono wartość indeksu dla wskaźnika SO2

stIndexStatus  - Status indeksu ogólnego dla stacji pomiarowej. Może przyjmować wartość „true” (indeks ważny) lub „false” (indeks nieważny/ brak indeksu)
stIndexCrParam - Kod zanieczyszczenia krytycznego (o gorszej wartości) dla województwa, w którym zlokalizowana jest stacja pomiarowa. Może przyjmować wpisy: „pyl” jeśli w danej godzinie zanieczyszczeniem krytycznym w danym województwie jest pył: łącznie PM10 i PM2,5 (zwykle zimą), lub „ozon” jeśli zanieczyszczeniem krytycznym jest ozon (zwykle latem). Jeśli najgorszym zanieczyszczeniem w danym województwie w danej godzinie jest jakiś inny parametr, np. SO2 – Bardzo zły, wówczas indeks dla danej stacji przyjmuje wartość dla tego zanieczyszczenia, jednak ogólny indeks w województwie nadal odnosi się do najgorszego z zanieczyszczeń krytycznych: pył lub ozon.