KlimaSensitiv API

This is the documentation for the KlimaSensitiv API. It is private and can only be accessed using a valid auth token.

• KlimaSensitiv API
  • Authentication
  • Stations
  • Station Sensors
  • Last readings
  • Readings
  • Bulk Readings (OASC)

Authentication

All calls must supply a secret token sent via the header X-KLIMASRV-AUTH. You will receive the secret on request.

Stations

Returns all accessable stations.

URL: GET https://klima.rgeo.de/api/stations

Sample Call:

curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/stations

Station Sensors

Returns all sensors for the given station. The station id needs to be supplied.

URL: GET https://klima.rgeo.de/api/station/{station}/sensors

Sample Call:

curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/1/sensors

Last readings

Returns the last readings (timespan in minutes) for a given station and sensor. Backwards from the given timestamp. The data is ordered by date ascending.

timestamp should be in ISO format using UTC.

URL: GET https://klima.rgeo.de/api/last_readings/{station}/{sensor}/{timestamp}/{timespan}

Optional parameter: timezone which converts the response data to the desired timezone. By default the station timezone is used.

Sample Call:

curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/last_readings/1/1/2020-01-01/60
curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/last_readings/1/1/2020-01-01/60?timezone=UTC

Readings

Returns the readings for given station(s) and sensor(s), in the given timeframe. The data is ordered by date ascending.

URL: GET https://klima.rgeo.de/api/readings

Sample Call:

curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/readings?start=2019-01-01T00:00&end=2019-01-02T13:00&stations=&sensors=

Bulk Readings (OASC)

Returns all readings since the given timestamp. This endpoint is intended to retrieve all data for further processing on the consumer side.

The returned data uses the OASC WeatherObserved format. In particular the normalized format thereof.

URL: GET https://klima.rgeo.de/api/bulk_readings

Sample Call:

curl -H "X-KLIMASRV-AUTH: xxx" https://klima.rgeo.de/api/bulk_readings?from_timestamp=2019-01-01T00:00&station=1

Sample Response:

{
    "type": "WeatherObserved",
    "dateObserved": {
      "value": "2020-12-20T00:00:00+00:00"
    },
    "dataProvider": {
      "value": "rgeo - Research Group for Earth Observation"
    },
    "stationID": {
      "value": 2
    },
    "stationName": {
      "value": "DE_02_HD-Geo-Institut"
    },
    "stationCode": {
      "value": "DE_Heidelberg_69115_4"
    },
    "installationType": {
      "value": "roof_settlement_marginallyInfluenced"
    },
    "licenseType": {
      "value": "open"
    },
    "sensorSource": {
      "value": "xyz"
    },
    "location": {
      "value": {
        "type": "Point",
        "coordinates": [
          8.6761,
          49.400672
        ]
      }
    },
    "windDirection": {
      "value": 59.0,
      "metadata": {
        "accuracy": {
          "value": 0
        }
      }
    },
    "temperature": {
      "value": 7.8,
      "metadata": {
        "accuracy": {
          "value": 0
        }
      }
    },
    "relativeHumitity": {
      "value": 73.7,
      "metadata": {
        "accuracy": {
          "value": 0
        },
        "sensorSource": {
          "value": "xyz"
        },
      }
    }
}