Buildings refer to actual locations in the world, with address, latitude, longitude, and timezone information. A building has many panels, which can be accessed from the panels path.
{
// primary key of the building
"id": 166,
// name of the building
"name": "NASA Ames Building 19",
// address of the building
"address": "Bldg 19, North Akron Rd., Moffett Field, CA, 94035",
// latitude of the building
"latitude": 37.4121271,
// longitude of the building
"longitude": -122.0574439,
// IANA timezone string of the building
"timezone": "America/Los_Angeles",
// panel id's of panels associated to the building
"panel_ids": [
169,
170
]
}
Returns details about all accessible buildings. If energy is null, the building is missing data for that time interval.
$ curl -i https://app.verdigris.co/api/v3/buildings -H "Authorization: Token token=<access_token>"
{ "buildings": [ { "id": 166, "name": "NASA Ames Building 19", "address": "Bldg 19, North Akron Rd., Moffett Field, CA, 94035", "latitude": 37.4121271, "longitude": -122.0574439, "timezone": "America/Los_Angeles", "panel_ids": [ 169, 170 ] }, { "id": 167, "name": "Orn, Cormier and Olson", "address": "214 Feeney Radial New Devanteview, PW 51447", "latitude": 41.7130798, "longitude": -95.1953554, "timezone": "America/Chicago", "panel_ids": [ 171, 172, 173, 174 ] } ] }
Returns details about requested building.
$ curl -i https://app.verdigris.co/api/v3/buildings/166 -H "Authorization: Token token=<access_token>"
{ "id": 166, "name": "NASA Ames Building 19", "address": "Bldg 19, North Akron Rd., Moffett Field, CA, 94035", "latitude": 37.4121271, "longitude": -122.0574439, "timezone": "America/Los_Angeles", "panel_ids": [ 169, 170 ] }
Param name | Description |
---|---|
id required |
building id Value: Must be String |
Returns the energy data in Watt-hours for the requested buildings.
$ curl -G \
"https://app.verdigris.co/api/v3/buildings/energy?\
ids=1,2&\
start_time=2017-06-20T23:55:00Z&\
end_time=2017-06-20T23:57:00Z&\
interval=minutely&\
timestamp_format=iso8601" \
--data-urlencode "timezone=Pacific Time (US & Canada)" \
-H "Authorization: Token token=<access_token>"
# RESPONSE # result is in the format: # { # building_id0: { # "timestamps": [ # timestamp0, # timestamp1 # ], # "energy": [ # energy0, # energy1 # ] # }, # "building_id2": { # "timestamps": [ # timestamp0, # timestamp1 # ], # "energy": [ # energy0, # energy1 # ] # } # } # energy is in units of Watt-hours { "1": { "timestamps": [ "2017-06-20T16:55:00-07:00", "2017-06-20T16:56:00-07:00" ], "energy": [ 1337, 1338 ] }, "2": { "timestamps": [ "2017-06-20T16:55:00-07:00", "2017-06-20T16:56:00-07:00" ], "energy": [ 1337, 1338 ] } }
Param name | Description |
---|---|
ids required |
comma separated building ids (e.g. Value: Must be String |
start_time required |
start time in ISO 8601 combined date and time format (e.g. Value: Must be String |
end_time required |
end time in ISO 8601 combined date and time format (e.g. Value: Must be String |
interval required |
time between each data point Value: Must be one of: minutely, 15-minutely, hourly, daily. |
timestamp_format optional |
specify how timestamps are returned in the response (default: unix epoch seconds) Value: Must be one of: iso8601. |
timezone optional |
timezone used to account for hour and day boundaries, and daylight savings (default: UTC) Value: Must be one of: International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, UTC, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Srednekolymsk, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku’alofa, Tokelau Is., Chatham Is., Samoa, Pacific/Midway, Pacific/Midway, Pacific/Pago_Pago, Pacific/Honolulu, America/Juneau, America/Los_Angeles, America/Tijuana, America/Denver, America/Phoenix, America/Chihuahua, America/Mazatlan, America/Chicago, America/Regina, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Guatemala, America/New_York, America/Indiana/Indianapolis, America/Bogota, America/Lima, America/Lima, America/Halifax, America/Caracas, America/La_Paz, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Argentina/Buenos_Aires, America/Montevideo, America/Guyana, America/Godthab, Atlantic/South_Georgia, Atlantic/Azores, Atlantic/Cape_Verde, Europe/Dublin, Europe/London, Europe/Lisbon, Europe/London, Africa/Casablanca, Africa/Monrovia, Etc/UTC, Europe/Belgrade, Europe/Bratislava, Europe/Budapest, Europe/Ljubljana, Europe/Prague, Europe/Sarajevo, Europe/Skopje, Europe/Warsaw, Europe/Zagreb, Europe/Brussels, Europe/Copenhagen, Europe/Madrid, Europe/Paris, Europe/Amsterdam, Europe/Berlin, Europe/Berlin, Europe/Rome, Europe/Stockholm, Europe/Vienna, Africa/Algiers, Europe/Bucharest, Africa/Cairo, Europe/Helsinki, Europe/Kiev, Europe/Riga, Europe/Sofia, Europe/Tallinn, Europe/Vilnius, Europe/Athens, Europe/Istanbul, Europe/Minsk, Asia/Jerusalem, Africa/Harare, Africa/Johannesburg, Europe/Kaliningrad, Europe/Moscow, Europe/Moscow, Europe/Volgograd, Europe/Samara, Asia/Kuwait, Asia/Riyadh, Africa/Nairobi, Asia/Baghdad, Asia/Tehran, Asia/Muscat, Asia/Muscat, Asia/Baku, Asia/Tbilisi, Asia/Yerevan, Asia/Kabul, Asia/Yekaterinburg, Asia/Karachi, Asia/Karachi, Asia/Tashkent, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kathmandu, Asia/Dhaka, Asia/Dhaka, Asia/Colombo, Asia/Almaty, Asia/Novosibirsk, Asia/Rangoon, Asia/Bangkok, Asia/Bangkok, Asia/Jakarta, Asia/Krasnoyarsk, Asia/Shanghai, Asia/Chongqing, Asia/Hong_Kong, Asia/Urumqi, Asia/Kuala_Lumpur, Asia/Singapore, Asia/Taipei, Australia/Perth, Asia/Irkutsk, Asia/Ulaanbaatar, Asia/Seoul, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Yakutsk, Australia/Darwin, Australia/Adelaide, Australia/Melbourne, Australia/Melbourne, Australia/Sydney, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Pacific/Guam, Pacific/Port_Moresby, Asia/Magadan, Asia/Srednekolymsk, Pacific/Guadalcanal, Pacific/Noumea, Pacific/Fiji, Asia/Kamchatka, Pacific/Majuro, Pacific/Auckland, Pacific/Auckland, Pacific/Tongatapu, Pacific/Fakaofo, Pacific/Chatham, Pacific/Apia. |
Returns the forecasted power data in Watts for the requested building.
$ curl -G \
"https://app.verdigris.co/api/v3/buildings/1/forecast" \
-H "Authorization: Token token=<access_token>"
# RESPONSE # result is in the format: # { # made_at: The time that the forecast was generated at., # timestamps: Unix epoch seconds accompanying above quantiles. # mean: average forecast, # 0.05: 5th percentile, # 0.10: 10th percentile, # 0.15: 15th percentile, # ... (continue incrementing by 5 percent) # 0.95: 95th percentile, # } { "made_at": "2017-09-01T16:39:55.969-07:00", "timestamps": [<length 96 array>], "mean": [<length 96 array>], "0.05": [<length 96 array>], "0.10": [<length 96 array>], "0.15": [<length 96 array>], ... "0.95": [<length 96 array>] }
Param name | Description |
---|---|
building_id required |
building id Value: Must be String |