Fetch weather data

GET /data/weather

Get weather measurements for the selected instruments and time range.

Optionally choose what period to recalculate results to.

The maximum date range per request is 31 days. If you request a longer range, the server will respond with an error.
The default Period is 1 minute.
The period can be set to anything between 1 minute and 1 day. If you request a period outside this range, the server will respond with an error.

Requires an API key with the data.enviro:read scope.

Query parameters

instruments array[string] Required

Serial numbers of selected instruments
start string(date-time) Required

Start date and time for loading a range of data. Must be in UTC.

This uses the ISO8601 format. For example, 2023-01-01T00:00:00Z is 1st January 2023 at midnight UTC.
end string(date-time) Required

End date and time for loading a range of data. Must be in UTC.

This uses the ISO8601 format. For example, 2023-01-01T00:00:00Z is 1st January 2023 at midnight UTC.
period string(duration)

Period to recalculate data samples to.

This cannot be less than the recorded data period.

This uses the ISO8601 duration format. For example, P1D is 1 day, PT1H is 1 hour, PT1M is 1 minute.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- time string(date-time)
  
  Time of the sample
- instrument string
  
  Instrument serial number
- windSpeed number
  
  Wind speed in metres per second
- windDirection number
  
  Wind direction in degrees
- temperature number
  
  Temperature in degrees Celsius
- pressure number
  
  Pressure in bar
- humidity number
  
  Relative humidity as a percentage
- precipitation number
  
  Precipitation in millimetres per hour
401 application/json

Your access token is invalid or has expired
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
403 application/json

You do not have permission to access this data
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
429 application/json

You have made too many requests in a short time
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error

GET /data/weather

curl \
 --request GET 'https://api.mycirrus.cloud/v1/data/weather?instruments=QT123456&instruments=QT234567&start=2023-01-01T00%3A00%3A00Z&end=2023-01-31T00%3A00%3A00Z'

Response examples (200)

[
  {
    "time": "2023-06-09T01:00:00Z",
    "humidity": 82,
    "pressure": 1.012,
    "windSpeed": 1.55,
    "instrument": "QT123456",
    "temperature": 10.48,
    "precipitation": 0,
    "windDirection": 140.37
  }
]

Response examples (401)

{
  "error": "TokenExpired",
  "description": "Your access token is invalid or has expired. Try refreshing the token."
}

Response examples (403)

{
  "error": "AccessDenied",
  "description": "You do not have permission to access this data."
}

Response examples (429)

{
  "error": "TooManyRequests",
  "description": "You have made too many requests in a short time. Please wait before trying again."
}