Get building controls

get

https://api.verdigris.co/data/v4/control/buildings

Time series of the controls reported by a building management system (BMS). Only one building ID is accepted per request, and only sites with an integrated BMS return data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of integers

required

length ≥ 1

An array of building IDs separated by commas. This is the integer oldid that REST API v3 returns for the same kind of entity.

ids*

interval

string

enum

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-01T12:30:00Z&end_time=2020-01-01T13:00:00Z:

interval=1m: returns 30 data points at minutely resolution.
interval=15m: returns 2 data points at 15-minute/quarter-hourly resolution.

The ordering of timestamps is not guaranteed.

Allowed:

start_time

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-01T12:34:00Z&interval=1m
VALID: start_time=2020-01-01T12:45:00Z&interval=15m
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:34:00Z&interval=15m
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

end_time

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-31T12:34:00Z&interval=1m
VALID: end_time=2020-12-31T12:45:00Z&interval=15m
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:34:00Z&interval=15m
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

timestamp_format

string | null

enum

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.

Allowed:

timezone

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.

Note

200Control data for given time range.

401Request to resource is unauthorized. This is likely due to missing access token in the Authorization header or an invalid token signature usually as a result of attempted token forgery by an unauthorized third-party.

403Request to resource is forbidden due to insufficient permissions.

404Resource with given ID cannot be found.

422One or more validations for request has failed.