Core Modeling API (2.0)

Download OpenAPI specification:Download

API to model building energy consumption.

modeling

Generate energy and financial models for a building

A model represents an upgrade package. Every model is within a timeline. You can have a single model in a timeline or multiple models spread across a timeline

Request
Request Body schema: application/json
required
addressFull
required
string (Address Full)
object (Address Components)
object (Building Characteristics)
object (Global Controls)
object (Model Controls)

If the default model controls object is provided, and no model controls object is present in a given model, values in this object are taken by default, affecting such model.

Array of objects (Request Timeline)
Responses
200

Successfully generated models

400

Incoming payload does not conform to the spec

422

Incoming payload is well-formed but failed validation

500

Generic error for unwanted exceptions

post/v2/timelines
Response samples
application/json
{
  • "addressFoundFull": "string",
  • "addressFoundComponents": {
    },
  • "globalControls": {
    },
  • "defaultModelControls": {
    },
  • "timelines": [
    ],
  • "typical": {
    },
  • "warnings": [
    ]
}