This version (0.1) is currently in beta and should not yet be used in production.
 

NAME

Airqualityforecast - Forecast of air-quality for locations in Norway

DESCRIPTION

This API implements a forecast of air-quality for a location in Norway, i.e. the forecast of several parameters relevant for air-quality. Besides a general air-quality index, the main parameters for air-quality like PM10, PM2.5 and O3 are given under the /aqi-description endpoint.

A location in Norway is defined by the statistical units area-class which are a municipality (kommune), a part of a municipality (delområde) and grunnkrets, the smallest area unit for statistics in Norway. Air-quality and concentrations in the finest resolution are available as maps under https://uemep-wms.met.no.

METHODS

/

The main request for air-quality data

Parameters

reftime

reference-time of the model as returned by /reftimes, usually the newest one

lat

geographical latitude

lon

geographical longitude

areaclass

geographical areaclass for which the data is valid, one of grunnkrets, fylke, kommune, delomrade

station

model data can also retrieved at predefined measurement station-id (eio) rather than for a area-class. A list of stations can be found under https://external.api.met.no/weatherapi/airqualityforecast/0.1/stations . If station is given, (lat, lon, areaclass) are ignored.

show

control which data to display, currently one of metadata, all. Only relevant for search by lat/lon, not station

Sample request URLs

  https://external.api.met.no/weatherapi/airqualityforecast/0.1/?lat=60&lon=10&areaclass=grunnkrets
  https://external.api.met.no/weatherapi/airqualityforecast/0.1/?station=NO0057A
  https://external.api.met.no/weatherapi/airqualityforecast/0.1/?lat=60&lon=10&areaclass=grunnkrets&show=metadata

The reftime parameter is not deterministic; you must replace it with a legal value read from /reftimes. The following URLs are for illustration only:

  https://external.api.met.no/weatherapi/airqualityforecast/0.1/?station=NO0057A&reftime=2019-07-21T12%3A00%3A00Z

Return structure

The return structure is defined as the #/definitions/AQLocationDataModel in the Data Model. A very short example:

    {
      "meta": {
        "reftime": "2018-09-01T00:00:00Z",
        "superlocation": {
          "longitude": 9.883918904721757,
          "name": "Drolsum og snarum",
          "areaclass": "delomrade",
          "latitude": 60.05512104383864,
          "areacode": "06230400"
        },
        "location": {
          "longitude": 10,
          "name": "Flattum",
          "areaclass": "grunnkrets",
          "latitude": 60,
          "areacode": "06230401"
        },
        "sublocations": []
      }
      "data": {
        "time": [
          {
            "from": "2018-09-01T01:00:00Z",
            "to": "2018-09-01T02:00:00Z",
            "variables": {
              "no2_local_fraction_traffic_exhaust": {
                "units": "%",
                "value": 7
                }
                // ... many more variables
              }
              {
              "reason": {
                "variables": ["pm10_concentration", "o3_concentration"],
                "sources": ["o3_nonlocal_fraction", "pm25_local_fraction_heating", "pm10_local_fraction_traffic_exhaust"]
            }
            // ...many more times
        }
    }

/met

Get meteorological forecast for selected air-quality stations.

A request to this parameters gives a full description of all meteorological parameters with their norwegian translation, their units and data-ranges.

Parameters

reftime

reference-time of the model as returned by /reftimes, usually the newest one

station

forecast at location of a predefined measurement station-id (eio). A list of stations can be found under https://external.api.met.no/weatherapi/airqualityforecast/0.1/stations .

Sample request URLs

  https://external.api.met.no/weatherapi/airqualityforecast/0.1/met?station=NO0057A

/met_description

A request to this parameters gives a full description of all meteorological parameters with their norwegian translation, their units and data-ranges

Parameters

None

Request URL

    https://external.api.met.no/weatherapi/airqualityforecast/0.1/aqi_description

/reftimes

Air quality forecast data are updated daily and the timestamp of latest measurements used in the forecast model are used as reference-time, reftimes called in this API. All available model runs are available under:

Parameters

None

Request URL

    https://external.api.met.no/weatherapi/airqualityforecast/0.1/reftimes

The return structure is:

    {
      "reftimes": [
        "2018-09-03T00:00:00Z",
        "2018-09-02T00:00:00Z",
        "2018-09-01T00:00:00Z"
      ]
    }

/stations

List of all stations with data.

Parameters

None

Request URLs

    https://external.api.met.no/weatherapi/airqualityforecast/0.1/stations

Return structure

The return structure is defined as a list of the #/definitions/StationModel in the [Data Model]. An example:

    [
      {
        "grunnkrets": {
          "name": "Alfaset",
          "areacode": "03013701"
        },
        "height": 3,
        "eoi": "NO0057A",
        "latitude": 59.927672,
        "name": "Alnabru",
        "delomrade": {
          "name": "Alfaset",
          "areacode": "03013700"
        },
        "longitude": 10.846553,
        "kommune": {
          "name": "Oslo",
          "areacode": "0301"
        }
      }
    ]

/aqi_description

A request to this parameters gives a full description of all components together with their norwegian translation, their aqi-limits, their sources as well as their preferred scales and color palettes.

Parameters

None

Request URL

    https://external.api.met.no/weatherapi/airqualityforecast/0.1/aqi_description

Return structure

The return structure is defined as the #/definitions/AQIDescriptionModel in the Data Model. A short example:

    {
      "variables": {
        "pm10_concentration": {
          "nameNO": "PM10",
          "sources": [
            {
              "source": "pm10_local_fraction_traffic_nonexhaust",
              "units": "%",
              "nameNO": "veistøv"
            },
            {
              "source": "pm10_local_fraction_traffic_exhaust",
              "units": "%",
              "nameNO": "eksos"
            },
            // ... further sources
          ],
          "aqis": [
            {
              "short_description_NO": "liten helserisiko",
              "class": 1,
              "to": 50,
              "color": "#3F9F41",
              "text": "low",
              "text_NO": "lite"
            },
            {
              "short_description_NO": "moderat helserisiko",
              "class": 2,
              "from": 50,
              "to": 80,
              "color": "#FFCB00",
              "text": "medium",
              "text_NO": "moderat"
            },
            // ... further aqis
          ]
        },
        //... further componentes
      }
    }

/areas

List all available areas for a areaclass. This is a local copy of the data provided by: https://www.ssb.no/klass/klassifikasjoner/1

Parameters

areaclass

geographical areaclass for which the data is valid, one of kommune, grunnkrets, delomrade

Sample request URLs

    https://external.api.met.no/weatherapi/airqualityforecast/0.1/areas?areaclass=grunnkrets

Return structure

The return structure is defined as a list of the #/definitions/LocationModel in the [Data Model]. An example:

    [
      {
        "longitude": 11.538393355859073,
        "areaclass": "kommune",
        "areacode": "0101",
        "latitude": 59.07004268027018,
        "name": "Halden"
      },
      // ... more areas
    ]

schema

The schema for the request-parameters for this product is available from https://external.api.met.no/weatherapi/airqualityforecast/0.1/swagger.json .

Restrictions

The availability and content of this product may change without further notice.

CHANGELOG

All changes are available as an RSS feed at the following URL: https://external.api.met.no/weatherapi/airqualityforecast/0.1/changelog

Version 0.1: 2018-12-17

Added show=metadata parameter

Version 0.1: 2018-10-02

New product available for air quality forecasts (beta version)