v1

latestOpenAPI 3.1.02026-07-24200331.1 KB

Retrieve Timelines

post/timelines

Headers

Accept-Encodingstring required

Request body

locationstring json

ID of a pre-defined location, GeoJSON geometry or latlong array - see formats

fieldsstring[] required

Selected fields from our data layers (polygon/polyline default to Max, if not suffix is not specified)

unitsstring

Unit system of the field values, either "metric" or "imperial" - see Field Descriptors

timestepsstring[]

Timesteps of the timelines: "1m", "5m", "15m", "30m", "1h", "1d" or "current" (defaults to "1h") - see Timestep Availability

startTimestring

Start time can be "now", "nowPlusXm/h/d", "nowMinusXm/h/d" or ISO 8601 format "2019-03-20T14:09:50Z". (defaults to now)

endTimestring

End time can be "now", "nowPlusXm/h/d", "nowMinusXm/h/d" or ISO 8601 format "2019-03-20T14:09:50Z". (defaults to now)

timezonestring

The timezone parameter displays the response datetime in the requested timezone. The timezone parameter is not affecting the request startTime and endTime. If you like to request data at a specific timezone, please add the timezone (in ISO 8601 format) to the startTime and endTime parameters. Timezone of time values, according to IANA Timezone Names (defaults to UTC) - see Formats. Using the auto value will automatically set the timezone of the request location

dailyStartHourinteger

This setting is used only with daily timesteps (1d) and determines when the daily aggregation period begins. By default, the aggregation runs from 6 AM to 6 AM. You can adjust this by setting dailyStartHour to any value between 0 and 23 (where 0 represents midnight, 1 represents 1 AM, and so on). For example, to aggregate from midnight to 11:59 PM, set dailyStartHour to 0.

Response

200

Example response

{
  "data": {
    "timelines": [
      {
        "timestep": "1h",
        "endTime": "2023-11-09T13:00:00Z",
        "startTime": "2023-11-09T07:00:00Z",
        "intervals": [
          {
            "startTime": "2023-11-09T07:00:00Z",
            "values": {
              "temperature": 3.31
            }
          }
        ]
      }
    ]
  }
}