Gets weather data for multiple buildings in a single batch request. Units are in degree Celsius (SI unit: ).

Recipes
🔑
Authenticate
Open Recipe
Log in to see full request history
Query Params
ids
array of integers
required
length ≥ 1

An array of building IDs separated by commas.

ids*
string
required

Interval between each data points. Affects the validity of start_time, end_time query parameters, time resolution and aggregation of results.

For example, given the time range query parameters, start_time=2020-01-01T00:00:00Z&end_time=2020-01-02T00:00:00Z:

  • interval=1h: returns data points at hourly resolution.
  • interval=1d: returns data points at daily resolution.
date-time
required

Start of the query time range. Value must be in ISO 8601 format.

Note that validity of start_time changes depending on the interval query parameter.

For example:

  • VALID: start_time=2020-01-01T13:00:00Z&interval=1h
  • VALID (if building’s timezone is in Pacific Standard Time):
    • start_time=2020-01-01T08:00:00Z&interval=1d (UTC)
    • start_time=2020-01-01T00:00:00+08:00&interval=1d (PST)
  • NOT VALID: start_time=2020-01-01T12:59:00Z&interval=1h
  • NOT VALID (if building’s timezone is in Pacific Standard Time):
    • start_time=2020-01-01T00:00:00Z&interval=1d
    • start_time=2020-01-01T04:00:00+08:00&interval=1d
date-time
required

End of the query time range. Value must be in ISO 8601 format.

Note that validity of end_time changes depending on the interval query parameter.

For example:

  • VALID: end_time=2020-12-31T13:00:00Z&interval=1h
  • VALID (if building’s timezone is in Pacific Standard Time):
    • end_time=2020-12-31T08:00:00Z&interval=1d (UTC)
    • end_time=2020-12-31T00:00:00+08:00&interval=1d (PST)
  • NOT VALID: end_time=2020-12-31T12:59:00Z&interval=1h
  • NOT VALID (if building’s timezone is in Pacific Standard Time):
    • end_time=2020-12-31T00:00:00Z&interval=1d
    • end_time=2020-12-31T04:00:00+08:00&interval=1d
string
required

What weather info will be returned in result, No include will default return 'temperature'.

For example:

  • include=: returns temperature.
  • include=temperature: returns temperature.
  • include=temperature,humidity: returns temperature and humidity.
  • include=temperature,humidity,dewPoint: returns temperature and humidity and dewPoint.
string | null

Format timestamps in the data. If set to ISO8601 (case-insensitive), the timestamp is returned as a string formatted in ISO 8601 format. If omitted, the timestamp is returned as an integer representing UNIX epoch.

string
Defaults to UTC

When used in conjunction with timestamp_format query parameter that is set to ISO8601 format, specifying the zone ID of IANA Time Zone Database returns the timestamp in the time zone offset.

Setting the timezone when timestamp_format is not specified has no affect on the UNIX epoch timestamp.

📘

Note

This query parameter meant to be a convenience feature that only affects the display format of the timestamps in the result. It has no affect on the building’s timezone.

Headers
string
Defaults to application/json

Specify a MIME type to indicate the content type the client would like to receive the data in. If omitted, defaults to application/json.

Currently, the supported formats are:

  • application/json
  • text/csv
Responses

Authorization header or an invalid token signature usually as a result of attempted token forgery by an unauthorized third-party.

Language
Credentials
OAuth2
Authenticate
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv