api‐specification ‐ radar

API specifications radar

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

This Endpoint serves information of the radar data provided by DWD. Following products RX and RY from the DWD are used. We cached the data by R-Plumber which provide us with information. It provides a feature set of precipitation data from Germany.

Resource Descriptions

Available Methods

• The API to retrieve precipitation features /radar/get1hRadar and /radar/get5mRadar:

method	path
GET	/radar/get1hRadar
GET	/radar/get1hRadar

• GET /radar/get1hRadar

  Returns a gejson of a feature group with information about the precipitation in the last one hour.

  Allows to search in a Bounding box. Allows to get a minimum level of precipitation. Allows to get a maximum level of precipitation.

  Parameters

  these filters are used on the searched data in the listed order.

  • bbox the geographical boundaries in which the tweets are located (WGS84).
  • min the minimum level of precipitation of a feature
  • max the maximum level of precipitation of a feature

Parameters

end-point: Tweet-Search

Request

Name	Method	Description
/radar/get1hradar	GET	Returns all features of precipitation in the last hour, optionally with a minimum and/ or maximum level of precipitation and inside a bounding box.
/radar/get5mradar	GET	Returns all features of precipitation in the last 5 minutes, optionally with a minimum and/ or maximum level of precipitation and inside a bounding box.

General Search Parameters

Name	Data Type	Required / Optional	Description
bbox	number array	optional	bounding box of 4 coordinates in the WGS84 format, represented as an array of four numbers: bbox={north},{west},{west},{south}
minimum	number	optional	Minimum level of precipitation. If value is lower then minimum it wont be returned. The data are encoded with 4 different levels of precipitation
maximum	number	optional	Maximum level of precipitation. If value is higher then maximum it wont be returned. The data are encoded with 4 different levels of precipitation

---

examples

tbd