api‐specification ‐ weather

API specifications

specification formatting based on idratherbewriting.com/learnapidoc/docapis_resource_descriptions.html

The specification of the API that serves the cached data on weather warnings for German districts (Kreise), that are provided by the DWD.

Resource Descriptions

Available Methods

• The API to handle status indicator communication /weather:

method	path
GET	/weather/warnings

---

Endpoints and Methods

• GET /weather/warnings

returns shapes of German districts that have issued warnings of weather against them by the DWD. Parameters

• bbox the geographical boundaries with which the resulting district borders can overlap. (WGS84)
• events list of types of events to include in the results.

---

Parameters

end-point: weather

Request

Name	Method	Description
weather/warnings	GET	Search for

General Search Parameters

Name	Data Type	Required / Optional	Description
bbox	number array	optional	bounding box of 2 coordinates in the WGS84 format, represented as an array of four numbers: bbox={lat northwest corner},{lon northwest corner},{lat southeast corner},{lon southeast corner}
events	string array	optional	The types of events to look for. for types of events, refer to DWD documentation chapter 3.1.1

---

examples

GET /weather/warnings

request example

localhost:3000/weather/warnings?events=FROST

response example

[
  {
      "properties": {
          "EVENT": [
              "FROST"
          ],
          "AREADESC": "Kreis Unterallgäu",
          "URGENCY": "Immediate",
          "SENT": "2020-01-15Z",
          "ONSET": "2020-01-15T20:00:00Z",
          "HEADLINE": "Amtliche WARNUNG vor FROST",
          "DESCRIPTION": "Es tritt leichter Frost zwischen 0 °C und -4 °C auf.",
          "PARAMETERNAME": "Lufttemperatur",
          "PARAMETERVALUE": "0 bis -4 [°C]"
      },
      "geometry": {
          "coordinates": [
              [
                  [
                      [
                          10.1561,
                          47.9893
                      ],
          [ ... ]
                      [
                          10.2961,
                          48.2225
                      ]
                  ]
              ]
          ],
          "type": "MultiPolygon"
      },
      "bbox": [
          10.077,
          47.8201,
          10.7074,
          48.2296
      ],
      "_id": "5e1f1b99db7edb4068c7082d",
      "type": "Feature",
      "id": "Warnungen_Landkreise.fid--1cfd208f_16fa9819749_-484",
      "__v": 0
  },

  [ ... ]

]