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.

Example Building

{
  // 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
  ]
}

GET /api/v1/buildings
List buildings

Returns details about all accessible buildings.

Example Request

$ curl -i https://app.verdigris.co/api/v1/buildings -H "Authorization: Token token=<access_token>"

Examples

{
  "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
      ]
    }
  ]
}

GET /api/v1/buildings/:id
Show a building

Returns details about requested building.

Example Request

$ curl -i https://app.verdigris.co/api/v1/buildings/166 -H "Authorization: Token token=<access_token>"

Examples

{
  "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
  ]
}

Params

Param name Description
id
required

building id


Value:

Must be String


GET /api/v1/buildings/:building_id/power
Power data for a building

Returns the power data for the requested building.

Example Request

$ curl -i https://app.verdigris.co/api/v1/buildings/166/power -H "Authorization: Token token=<access_token>"

Examples

// keys are unix epoch timestamps in string format, values are Watts
{
  "1411430400": 993.6999999999998,
  "1411516800": 914.8000000000001,
  "1411603200": 985.3000000000002
}

Params

Param name Description
building_id
required

building id


Value:

Must be String

end_time
optional

End time in unix timestamp


Value:

Must be String

interval
optional

Time granularity in minutes (default: 1440)


Value:

Must be String

limit
optional

Number of results (default: 30, max: 300)


Value:

Must be String

start_time
optional

Start time in unix timestamp (default: 0)


Value:

Must be String


GET /api/v1/buildings/:building_id/energy
Energy data for a building

Returns the energy data for the requested building.

Example Request

$ curl -i https://app.verdigris.co/api/v1/buildings/166/energy -H "Authorization: Token token=<access_token>"

Examples

// keys are unix epoch timestamps in string format, values are Watt-hours
{
  "1411430400": 906.5999999999999,
  "1411516800": 993.7999999999998,
  "1411603200": 980.1999999999998
}

Params

Param name Description
building_id
required

building id


Value:

Must be String

end_time
optional

End time in unix timestamp


Value:

Must be String

interval
optional

Time granularity in minutes (default: 1440)


Value:

Must be String

limit
optional

Number of results (default: 30, max: 300)


Value:

Must be String

start_time
optional

Start time in unix timestamp (default: 0)


Value:

Must be String