Examples

Simple

Request

Send a POST request to /v1/timelines with the following payload.

{
  "addressFull": "504 RANDALL RD, BALLSTON SPA, NY 12020"
}

Response

And the response will have the following structure.

{
  "addressFoundFull": "197 RANDALL RD, BALLSTON SPA, NY 12020",
  "addressFoundComponents": {
    "addressLine1": "197 Randall Rd",
    "city": "Ballston Spa",
    "stateAbbreviation": "NY",
    "zipCode": "12020"
  },
  "timelines": [
    {
      "id": "896fd222-003d-4c86-92ab-bed220d4bc8e",
      "radiantId": "39cc8695-0010-4334-8efc-6f23a17c7493",
      "label": "MIGHTY_LINX",
      "models": [
        {
          "id": "c1c6bc5c-0d4d-401e-96c6-aeb881eacb73",
          "radiantId": "d32cf3d2-209d-40e3-8595-13bdd10d88ce",
          "label": "BASE",
          "providedBaseBuilding": {},
          "appliedBaseBuilding": {
            "buildingSummary": {
              "conditionedFloorArea": 2600,
              "averageCeilingHeight": 8,
              "bathCount": 3,
              "bedroomsCount": 4,
              "residentCount": 5,
              "storiesCount": 2,
              "windowToWallFraction": 0.14,
              "yearBuilt": 2007,
              "propertyUse": "single-family detached"
            },
            "enclosure": {
              "airInfiltration": {
                "rate": 6.0,
                "rateUnit": "ACH",
                "housePressurePa": 50.0
              },
              "attics": [
                {
                  "id": "Attic1",
                  "area": 1300,
                  "floorAssemblyEffectiveRValue": 31.6
                }
              ],
              "roofs": [
                {
                  "id": "Roof1",
                  "area": 1453,
                  "pitch": 6,
                  "assemblyEffectiveRValue": 2.3,
                  "lifetime": {
                    "replacementCost": 7000,
                    "endOfLifeDate": "2030-01-01"
                  }
                }
              ],
              "walls": [
                {
                  "id": "Wall1",
                  "type": "wood stud",
                  "assemblyEffectiveRValue": 16.0,
                  "fractionAreaShared": 0.0
                }
              ],
              "foundations": [
                {
                  "id": "BasementUnconditioned1",
                  "type": "basement unconditioned",
                  "area": 1300,
                  "wallHeight": 8
                }
              ]
            },
            "systems": {
              "hvac": {
                "hvacCoolingSystems": [
                  {
                    "id": "CentralAirConditioner1",
                    "systemType": "central air conditioner",
                    "coolEfficiency": 13.0,
                    "coolEfficiencyUnits": "SEER",
                    "coolLoadFraction": 1.0,
                    "lifetime": {
                      "replacementCost": 2000,
                      "endOfLifeDate": "2024-07-01"
                    }
                  }
                ],
                "hvacHeatingSystems": [
                  {
                    "id": "Furnace1",
                    "systemType": "furnace",
                    "fuel": "natural gas",
                    "heatEfficiency": 0.8,
                    "heatEfficiencyUnits": "AFUE",
                    "heatLoadFraction": 1.0
                  }
                ],
                "hvacControlSystems": [
                  {
                    "id": "HVACControl1",
                    "heatingSeason": {
                      "setpoint": 68
                    },
                    "coolingSeason": {
                      "setpoint": 78
                    }
                  }
                ],
                "hvacDistributionSystems": {
                  "airDistributionSystems": [
                    {
                      "id": "HVACDistributionFurnaceAndCentralAC1",
                      "systemType": "regular velocity",
                      "numberOfReturnRegisters": 2,
                      "conditionedFloorAreaServed": 2600,
                      "ducts": [
                        {
                          "id": "HVACDistributionFurnaceAndCentral1Supply",
                          "systemType": "supply",
                          "insulationRValue": 0.0,
                          "leakageValue": 0.2,
                          "leakageUnits": "fraction",
                          "location": "attic vented"
                        },
                        {
                          "id": "HVACDistributionFurnaceAndCentral1Return",
                          "systemType": "return",
                          "insulationRValue": 0.0,
                          "leakageValue": 0.2,
                          "leakageUnits": "fraction",
                          "location": "attic vented"
                        }
                      ]
                    }
                  ]
                }
              },
              "waterHeating": {
                "waterHeatingSystems": [
                  {
                    "id": "WaterHeater1",
                    "systemType": "storage water heater",
                    "fuel": "natural gas",
                    "location": "conditioned space",
                    "tankVolume": 40,
                    "dhwLoadFraction": 1.0,
                    "efficiency": 0.59,
                    "efficiencyUnits": "EF",
                    "hotWaterTemperature": 125.0,
                    "lifetime": {
                      "replacementCost": 1000,
                      "installedDate": "2015-11-12"
                    }
                  }
                ]
              }
            },
            "appliances": {
              "clothesDryers": [
                {
                  "id": "ClothesDryer1",
                  "fuel": "electricity",
                  "combinedEnergyFactor": 3.73,
                  "isVented": true,
                  "ventedFlowRate": 150
                }
              ],
              "cookingRanges": [
                {
                  "id": "CookingRange1",
                  "fuel": "natural gas",
                  "isInduction": false
                }
              ]
            }
          },
          "energyTotals": {
            "annual": {
              "coalTotal": {
                "mbtu": [0.0]
              },
              "electricityTotal": {
                "kwh": [8314.77],
                "mbtu": [28.37]
              },
              "fuelOilTotal": {
                "mbtu": [0.0]
              },
              "naturalGasTotal": {
                "mbtu": [175.92]
              },
              "propaneTotal": {
                "mbtu": [0.0]
              },
              "woodCordTotal": {
                "mbtu": [0.0]
              },
              "woodPelletsTotal": {
                "mbtu": [0.0]
              },
              "total": {
                "mbtu": [204.29]
              }
            }
          },
          "energyCosts": {
            "annual": {
              "coalTotal": [0.0],
              "electricityTotal": [1050.94],
              "fuelOilTotal": [0.0],
              "naturalGasTotal": [2892.89],
              "propaneTotal": [0.0],
              "woodCordTotal": [0.0],
              "woodPelletsTotal": [0.0],
              "total": [3943.83]
            }
          },
          "emissionTotals": {
            "annual": {
              "coalTotal": {
                "co2": [0.0]
              },
              "electricityTotal": {
                "co2": [1945.79]
              },
              "fuelOilTotal": {
                "co2": [0.0]
              },
              "naturalGasTotal": {
                "co2": [25913.69]
              },
              "propaneTotal": {
                "co2": [0.0]
              },
              "woodCordTotal": {
                "co2": [0.0]
              },
              "woodPelletsTotal": {
                "co2": [0.0]
              },
              "total": {
                "co2": [27859.48]
              }
            }
          }
        }
      ],
      "totalEnergyCosts": 3943.83,
      "totalEmissions": {
        "co2": 27859.48
      }
    }
  ]
}

Simple with Monthly Datapoints

Request

Send a POST request to /v1/timelines with the following payload.

{
  "addressFull": "504 RANDALL RD, BALLSTON SPA, NY 12020",
  "globalControls": {
    "resolution": ["annual", "monthly"]
  }
}

Response

And the response will have the following structure.

{
  "addressFoundFull": "197 RANDALL RD, BALLSTON SPA, NY 12020",
  "addressFoundComponents": {
    "addressLine1": "197 Randall Rd",
    "city": "Ballston Spa",
    "stateAbbreviation": "NY",
    "zipCode": "12020"
  },
  "timelines": [
    {
      "id": "896fd222-003d-4c86-92ab-bed220d4bc8e",
      "radiantId": "39cc8695-0010-4334-8efc-6f23a17c7493",
      "label": "MIGHTY_LINX",
      "models": [
        {
          "id": "c1c6bc5c-0d4d-401e-96c6-aeb881eacb73",
          "radiantId": "d32cf3d2-209d-40e3-8595-13bdd10d88ce",
          "label": "BASE",
          "providedBaseBuilding": {},
          "appliedBaseBuilding": {
            "buildingSummary": {
              "conditionedFloorArea": 2600,
              "averageCeilingHeight": 8,
              "bathCount": 3,
              "bedroomsCount": 4,
              "residentCount": 5,
              "storiesCount": 2,
              "windowToWallFraction": 0.14,
              "yearBuilt": 2007,
              "propertyUse": "single-family detached"
            },
            "enclosure": {
              "airInfiltration": {
                "rate": 6.0,
                "rateUnit": "ACH",
                "housePressurePa": 50.0
              },
              "attics": [
                {
                  "id": "Attic1",
                  "area": 1300,
                  "floorAssemblyEffectiveRValue": 31.6
                }
              ],
              "roofs": [
                {
                  "id": "Roof1",
                  "area": 1453,
                  "pitch": 6,
                  "assemblyEffectiveRValue": 2.3,
                  "lifetime": {
                    "replacementCost": 7000,
                    "endOfLifeDate": "2030-01-01"
                  }
                }
              ],
              "walls": [
                {
                  "id": "Wall1",
                  "type": "wood stud",
                  "assemblyEffectiveRValue": 16.0,
                  "fractionAreaShared": 0.0
                }
              ],
              "foundations": [
                {
                  "id": "BasementUnconditioned1",
                  "type": "basement unconditioned",
                  "area": 1300,
                  "wallHeight": 8
                }
              ]
            },
            "systems": {
              "hvac": {
                "hvacCoolingSystems": [
                  {
                    "id": "CentralAirConditioner1",
                    "systemType": "central air conditioner",
                    "coolEfficiency": 13.0,
                    "coolEfficiencyUnits": "SEER",
                    "coolLoadFraction": 1.0,
                    "lifetime": {
                      "replacementCost": 2000,
                      "endOfLifeDate": "2024-07-01"
                    }
                  }
                ],
                "hvacHeatingSystems": [
                  {
                    "id": "Furnace1",
                    "systemType": "furnace",
                    "fuel": "natural gas",
                    "heatEfficiency": 0.8,
                    "heatEfficiencyUnits": "AFUE",
                    "heatLoadFraction": 1.0
                  }
                ],
                "hvacControlSystems": [
                  {
                    "id": "HVACControl1",
                    "heatingSeason": {
                      "setpoint": 68
                    },
                    "coolingSeason": {
                      "setpoint": 78
                    }
                  }
                ],
                "hvacDistributionSystems": {
                  "airDistributionSystems": [
                    {
                      "id": "HVACDistributionFurnaceAndCentralAC1",
                      "systemType": "regular velocity",
                      "numberOfReturnRegisters": 2,
                      "conditionedFloorAreaServed": 2600,
                      "ducts": [
                        {
                          "id": "HVACDistributionFurnaceAndCentral1Supply",
                          "systemType": "supply",
                          "insulationRValue": 0.0,
                          "leakageValue": 0.2,
                          "leakageUnits": "fraction",
                          "location": "attic vented"
                        },
                        {
                          "id": "HVACDistributionFurnaceAndCentral1Return",
                          "systemType": "return",
                          "insulationRValue": 0.0,
                          "leakageValue": 0.2,
                          "leakageUnits": "fraction",
                          "location": "attic vented"
                        }
                      ]
                    }
                  ]
                }
              },
              "waterHeating": {
                "waterHeatingSystems": [
                  {
                    "id": "WaterHeater1",
                    "systemType": "storage water heater",
                    "fuel": "natural gas",
                    "location": "conditioned space",
                    "tankVolume": 40,
                    "dhwLoadFraction": 1.0,
                    "efficiency": 0.59,
                    "efficiencyUnits": "EF",
                    "hotWaterTemperature": 125.0,
                    "lifetime": {
                      "replacementCost": 1000,
                      "installedDate": "2015-11-12"
                    }
                  }
                ]
              }
            },
            "appliances": {
              "clothesDryers": [
                {
                  "id": "ClothesDryer1",
                  "fuel": "electricity",
                  "combinedEnergyFactor": 3.73,
                  "isVented": true,
                  "ventedFlowRate": 150
                }
              ],
              "cookingRanges": [
                {
                  "id": "CookingRange1",
                  "fuel": "natural gas",
                  "isInduction": false
                }
              ]
            }
          },
          "energyTotals": {
            "annual": {
              "coalTotal": {
                "mbtu": [0.0]
              },
              "electricityTotal": {
                "kwh": [0.0],
                "mbtu": [28.37]
              },
              "fuelOilTotal": {
                "mbtu": [0.0]
              },
              "naturalGasTotal": {
                "mbtu": [175.92]
              },
              "propaneTotal": {
                "mbtu": [0.0]
              },
              "woodCordTotal": {
                "mbtu": [0.0]
              },
              "woodPelletsTotal": {
                "mbtu": [0.0]
              },
              "total": {
                "mbtu": [204.29]
              }
            },
            "monthly": {
              "coalTotal": {
                "mbtu": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "electricityTotal": {
                "mbtu": [2.93, 2.44, 2.15, 1.75, 2.21, 2.16, 3.52, 2.91, 1.94, 1.68, 1.98, 2.70],
                "kwh": [859.41, 714.81, 629.55, 511.45, 648.17, 632.72, 1032.89, 853.19, 568.66, 493.00, 579.91, 790.64]
              },
              "fuelOilTotal": {
                "mbtu": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "naturalGasTotal": {
                "mbtu": [44.96, 31.67, 225.13, 9.04, 1.93, 1.25, 1.19, 1.11, 1.90, 7.52, 18.86, 34.37]
              },
              "propaneTotal": {
                "mbtu": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "woodCordTotal": {
                "mbtu": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "woodPelletsTotal": {
                "mbtu": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "total": {
                "mbtu": [47.89, 34.11, 24.28, 10.79, 4.14, 3.41, 4.71, 4.02, 3.84, 9.20, 20.84, 37.06]
              }
            }
          },
          "energyCosts": {
            "annual": {
              "coalTotal": [0.0],
              "electricityTotal": [1050.94],
              "fuelOilTotal": [0.0],
              "naturalGasTotal": [2892.89],
              "propaneTotal": [0.0],
              "woodCordTotal": [0.0],
              "woodPelletsTotal": [0.0],
              "total": [3943.83]
            },
            "monthly": {
              "coalTotal": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
              "electricityTotal": [108.63, 90.35, 79.58, 64.65, 81.93, 79.98, 130.56, 107.84, 71.88, 62.32, 73.30, 99.94],
              "fuelOilTotal": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
              "naturalGasTotal": [739.25, 520.77, 363.90, 148.68, 31.70, 20.58, 19.51, 18.31, 31.19, 123.68, 310.21, 565.12],
              "propaneTotal": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
              "woodCordTotal": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
              "woodPelletsTotal": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
              "total": [847.88, 611.12, 443.48, 213.33, 113.63, 100.56, 150.07, 126.15, 103.07, 186.00, 383.51, 665.05]
            }
          },
          "emissionTotals": {
            "annual": {
              "coalTotal": {
                "co2": [0.0]
              },
              "electricityTotal": {
                "co2": [1945.79]
              },
              "fuelOilTotal": {
                "co2": [0.0]
              },
              "naturalGasTotal": {
                "co2": [25913.69]
              },
              "propaneTotal": {
                "co2": [0.0]
              },
              "woodCordTotal": {
                "co2": [0.0]
              },
              "woodPelletsTotal": {
                "co2": [0.0]
              },
              "total": {
                "co2": [27859.48]
              }
            },
            "monthly": {
              "coalTotal": {
                "co2": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "electricityTotal": {
                "co2": [201.12, 167.28, 147.33, 119.69, 151.69, 148.07, 241.72, 199.67, 133.08, 115.37, 135.71, 185.03]
              },
              "fuelOilTotal": {
                "co2": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "naturalGasTotal": {
                "co2": [6621.96, 4664.87, 3259.73, 1331.83, 283.98, 184.39, 174.78, 163.98, 279.36, 1107.89, 2778.76, 5062.16]
              },
              "propaneTotal": {
                "co2": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "woodCordTotal": {
                "co2": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "woodPelletsTotal": {
                "co2": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              "total": {
                "co2": [6823.08, 4832.15, 3407.06, 1451.52, 435.67, 332.46, 416.51, 363.65, 412.44, 1223.27, 2914.47, 5247.19]
              }
            }
          }
        }
      ],
      "totalEnergyCosts": 3943.83,
      "totalEmissions": {
        "co2": 27859.48
      }
    }
  ]
}

Simple with Monthly and Hourly Datapoints

Request

Send a POST request to /v1/timelines with the following payload.

{
  "addressFull": "504 RANDALL RD, BALLSTON SPA, NY 12020",
  "globalControls": {
    "resolution": ["annual", "monthly", "hourly"]
  }
}

Response

The example with hourly datapoints is large and difficult to process in a browser. We recommend downloading the compressed version, uncompress it locally and use an editor with JSON formatting capabilities.

The only difference compared to the monthly resolution, is that objects including datapoints will have an extra property hourly with arrays of size 8,760. There are 8,760 hours in a standard year.

Download the response example with hourly datapoints here: simple_with_monthly_and_hourly.json.gz.

Note

In a future release, we’ll automatically compress the response payload including hourly data and inform the client through the Content-Encoding HTTP response header.

Using baseBuilding

Request

Send a POST request to /v1/timelines with the following payload.

{
  "addressFull": "504 RANDALL RD, BALLSTON SPA, NY 12020",
  "addressComponents": {
    "addressLine1": "504 Randall Rd",
    "city": "Ballston Spa",
    "stateAbbreviation": "NY",
    "zipCode": "12020"
  },
  "baseBuilding": {
    "buildingSummary": {
      "conditionedFloorArea": 2413,
      "averageCeilingHeight": 8,
      "bathCount": 2,
      "bedroomsCount": 4,
      "residentCount": 5,
      "storiesCount": 1,
      "windowToWallFraction": 0.14,
      "yearBuilt": 1945,
      "propertyUse": "single-family detached"
    },
    "enclosure": {
      "airInfiltration": {
        "rate": 15,
        "rateUnit": "ACH",
        "housePressurePa": 50
      },
      "attics": [
        {
          "id": "Attic1",
          "area": 1225,
          "floorAssemblyEffectiveRValue": 20.6
        }
      ],
      "roofs": [
        {
          "id": "Roof1",
          "area": 1370,
          "pitch": 6,
          "assemblyEffectiveRValue": 2.3,
          "lifetime": {
            "replacementCost": 7000,
            "endOfLifeDate": "2030-01-01"
          }
        }
      ],
      "walls": [
        {
          "id": "Wall1",
          "type": "wood stud",
          "assemblyEffectiveRValue": 4,
          "fractionAreaShared": 0
        }
      ],
      "foundations": [
        {
          "id": "BasementConditioned1",
          "type": "basement conditioned",
          "area": 1188,
          "wallHeight": 8
        }
      ]
    },
    "systems": {
      "hvac": {
        "hvacCoolingSystems": [
          {
            "id": "RoomAirConditioner1",
            "systemType": "room air conditioner",
            "coolEfficiency": 10.7,
            "coolEfficiencyUnits": "EER",
            "coolLoadFraction": 0.33,
            "lifetime": {
              "replacementCost": 200,
              "endOfLifeDate": "2024-07-01"
            }
          }
        ],
        "coolLoadGapFraction": 0.67,
        "hvacHeatingSystems": [
          {
            "id": "ElectricResistance1",
            "systemType": "electric resistance",
            "fuel": "electricity",
            "heatEfficiency": 1,
            "heatEfficiencyUnits": "fraction",
            "heatLoadFraction": 1
          }
        ],
        "heatLoadGapFraction": 0,
        "hvacControlSystems": [
          {
            "id": "HVACControl1",
            "heatingSeason": {
              "setpoint": 68
            },
            "coolingSeason": {
              "setpoint": 78
            }
          }
        ]
      },
      "waterHeating": {
        "waterHeatingSystems": [
          {
            "efficiency": 0.92,
            "efficiencyUnits": "EF",
            "dhwLoadFraction": 1,
            "systemType": "storage water heater",
            "fuel": "electricity",
            "id": "WaterHeater1",
            "hotWaterTemperature": 125,
            "location": "conditioned space",
            "lifetime": {
              "replacementCost": 1000,
              "installedDate": "2015-11-12"
            },
            "tankVolume": 40
          }
        ]
      }
    },
    "appliances": {
      "clothesDryers": [
        {
          "id": "ClothesDryer1",
          "fuel": "electricity",
          "combinedEnergyFactor": 3.73,
          "isVented": true,
          "ventedFlowRate": 150
        }
      ],
      "cookingRanges": [
        {
          "id": "CookingRange1",
          "fuel": "electricity",
          "isInduction": false
        }
      ]
    }
  },
  "globalControls": {
    "timelineStartDate": "2022-12-10",
    "includeTypical": true,
    "financialAnalysisOptions": [
      "difference",
      "installed costs",
      "energy costs"
    ],
    "includeStatusQuoTimeline": true,
    "timelineDurationInYears": 3,
    "useFixture": true,
    "fixtureName": "extensive-inputs",
    "includeBase": true,
    "resolution": [
      "annual"
    ]
  },
  "defaultModelControls": {
    "allowIncreasedFixedCapacities": false,
    "energyCostRates": {
      "electricity": {
        "kwh": 0.1264
      }
    }
  }
}

Response

And the response will have the following structure.

{
  "addressFoundFull": "504 RANDALL RD, BALLSTON SPA, NY 12020",
  "addressFoundComponents": {
    "addressLine1": "504 RANDALL RD",
    "city": "BALLSTON SPA",
    "stateAbbreviation": "NY",
    "zipCode": "12020"
  },
  "timelines": [
    {
      "id": "9fc7c4d3-a32e-47ec-9bbf-022d887aafa8",
      "radiantId": "747c1265-0ff3-4310-b069-5a6b209bf5a7",
      "label": "STATUS_QUO",
      "models": [
        {
          "id": "f860e17c-5125-44dc-aa4c-ee028d503a96",
          "radiantId": "a863b445-e8bb-404c-9cb7-f4a8a5907090",
          "label": "BASE",
          "providedBaseBuilding": {},
          "energyTotals": {
            "annual": {
              "electricityTotal": {
                "mbtu": [
                  22.98
                ],
                "kwh": [
                  6734.773878
                ]
              },
              "naturalGasTotal": {
                "mbtu": [
                  88.66
                ]
              },
              "fuelOilTotal": {
                "mbtu": [
                  0
                ]
              },
              "propaneTotal": {
                "mbtu": [
                  0
                ]
              },
              "woodCordTotal": {
                "mbtu": [
                  0
                ]
              },
              "woodPelletsTotal": {
                "mbtu": [
                  0
                ]
              },
              "coalTotal": {
                "mbtu": [
                  0
                ]
              },
              "total": {
                "mbtu": [
                  111.64
                ]
              }
            }
          },
          "energyCosts": {
            "annual": {
              "electricityTotal": [
                851.2754181792001
              ],
              "naturalGasTotal": [
                1504.5602
              ],
              "fuelOilTotal": [
                0
              ],
              "propaneTotal": [
                0
              ],
              "woodCordTotal": [
                0
              ],
              "woodPelletsTotal": [
                0
              ],
              "coalTotal": [
                0
              ],
              "total": [
                2355.8356181792
              ]
            }
          },
          "emissionTotals": {
            "annual": {
              "electricityTotal": {
                "co2": [
                  0.7149244900974349
                ]
              },
              "naturalGasTotal": {
                "co2": [
                  4.7065426501236
                ]
              },
              "fuelOilTotal": {
                "co2": [
                  0
                ]
              },
              "propaneTotal": {
                "co2": [
                  0
                ]
              },
              "coalTotal": {
                "co2": [
                  0
                ]
              },
              "woodCordTotal": {
                "co2": [
                  0
                ]
              },
              "woodPelletsTotal": {
                "co2": [
                  0
                ]
              },
              "total": {
                "co2": [
                  5.421467140221035
                ]
              }
            }
          },
          "appliedBaseBuilding": {
            "appliances": {
              "clothesDryers": [
                {
                  "combinedEnergyFactor": 3.73,
                  "fuel": "electricity",
                  "id": "ClothesDryer1",
                  "isVented": true,
                  "ventedFlowRate": 150
                }
              ],
              "cookingRanges": [
                {
                  "fuel": "natural gas",
                  "id": "CookingRange1",
                  "isInduction": false
                }
              ]
            },
            "buildingSummary": {
              "averageCeilingHeight": 8,
              "bathCount": 3,
              "bedroomsCount": 4,
              "conditionedFloorArea": 2580,
              "residentCount": 3.2366863905325443,
              "storiesCount": 2,
              "windowToWallFraction": 0.14,
              "yearBuilt": 2007,
              "propertyUse": "single-family detached"
            },
            "enclosure": {
              "airInfiltration": {
                "housePressurePa": 50,
                "rate": 6,
                "rateUnit": "ACH"
              },
              "attics": [
                {
                  "area": 860,
                  "floorAssemblyEffectiveRValue": 31.6,
                  "id": "AtticVented1",
                  "isVented": true
                }
              ],
              "foundations": [
                {
                  "area": 860,
                  "id": "BasementConditioned1",
                  "type": "basement conditioned",
                  "wallHeight": 8
                }
              ],
              "roofs": [
                {
                  "area": 961,
                  "assemblyEffectiveRValue": 2.3,
                  "id": "Roof1",
                  "pitch": 6
                }
              ],
              "walls": [
                {
                  "assemblyEffectiveRValue": 16,
                  "fractionAreaShared": 0,
                  "id": "Wall1Exposed",
                  "type": "wood stud"
                }
              ]
            },
            "systems": {
              "electricalPanels": [
                {
                  "id": "ElectricalPanel1"
                }
              ],
              "hvac": {
                "hvacControlSystems": [
                  {
                    "coolingSeason": {
                      "setbackStartHour": null,
                      "setbackTemp": null,
                      "setpointTemp": 78,
                      "totalWeeklySetbackHours": null
                    },
                    "heatingSeason": {
                      "setbackStartHour": null,
                      "setbackTemp": null,
                      "setpointTemp": 68,
                      "totalWeeklySetbackHours": null
                    },
                    "id": "HVACControl1"
                  }
                ],
                "hvacCoolingSystems": [
                  {
                    "compressorType": null,
                    "coolCapacityBtuPerHour": null,
                    "coolEfficiency": 13,
                    "coolEfficiencyUnits": "SEER",
                    "coolLoadFraction": 1,
                    "id": "central air conditioner1",
                    "systemType": "central air conditioner"
                  }
                ],
                "coolLoadGapFraction": 0.67,
                "hvacDistributionSystems": {
                  "airDistributionSystems": [
                    {
                      "conditionedFloorAreaServed": 2580,
                      "numberOfReturnRegisters": 3,
                      "systemType": "regular velocity",
                      "id": "HVACAirDistributionFurnaceAndCentralAC1",
                      "ducts": [
                        {
                          "systemType": "return",
                          "id": "HVACAirDistributionFurnaceAndCentralAC1return"
                        },
                        {
                          "systemType": "supply",
                          "id": "HVACAirDistributionFurnaceAndCentralAC1supply"
                        }
                      ]
                    }
                  ]
                },
                "hvacHeatingSystems": [
                  {
                    "fuel": "natural gas",
                    "heatEfficiency": 0.8,
                    "heatEfficiencyUnits": "AFUE",
                    "heatLoadFraction": 1,
                    "id": "Furnace1",
                    "systemType": "furnace"
                  }
                ]
              },
              "heatLoadGapFraction": 0,
              "waterHeating": {
                "waterHeatingSystems": [
                  {
                    "hotWaterTemperature": 125,
                    "dhwLoadFraction": 1,
                    "tankVolume": 40,
                    "connectedHeatingId": null,
                    "fuel": "natural gas",
                    "heatCapacityBtuPerHour": null,
                    "systemType": "storage water heater",
                    "efficiency": 0.59,
                    "efficiencyUnits": "EF",
                    "id": "WaterHeater1",
                    "location": null
                  }
                ]
              }
            }
          }
        }
      ],
      "totalEnergyCosts": 2355.8356181792,
      "totalEmissions": {
        "co2": 5.421467140221035
      }
    }
  ]
}

Using automatedMeasures

Request

Send a POST request to /v1/timelines with the following payload.

{
  "addressFull": "504 RANDALL RD, BALLSTON SPA, NY 12020",
  "timelines": [
    {
      "models": [
        {
          "automatedMeasures": {
            "newHeatPump": {
              "systemType": "heat pump",
              "performanceClass": "federal minimally compliant",
              "heatloadFraction": 1.0,
              "coolLoadFraction": 1.0
            }
          }
        }
      ]
    }
  ]
}

Response

And the response will have the following structure.

{
  "addressFoundFull": "197 RANDALL RD, BALLSTON SPA, NY 12020",
  "addressFoundComponents": {
    "addressLine1": "197 Randall Rd",
    "city": "Ballston Spa",
    "stateAbbreviation": "NY",
    "zipCode": "12020"
  },
  "timelines": [
    {
      "id": "ca4379e4-f513-42a0-bf4f-b7100af8bcda",
      "radiantId": "869e628b-8be9-44ca-b764-b7530350ba47",
      "label": "OLYMPIC_GIRAFFE",
      "models": [
        {
          "id": "776364ab-59bf-4937-b1b1-fbf6b5492e0f",
          "radiantId": "40404d64-408a-4b17-bd70-d368f6486d5a",
          "label": "BASE",
          "providedBaseBuilding": {},
          "appliedBaseBuilding": {
            "buildingSummary": {
              "conditionedFloorArea": 2413,
              "averageCeilingHeight": 8,
              "bathCount": 2,
              "bedroomsCount": 4,
              "residentCount": 5,
              "storiesCount": 1,
              "windowToWallFraction": 0.14,
              "yearBuilt": 1945,
              "propertyUse": "single-family detached"
            },
            "enclosure": {
              "airInfiltration": {
                "rate": 15.0,
                "rateUnit": "ACH",
                "housePressurePa": 50.0
              },
              "attics": [
                {
                  "id": "Attic1",
                  "area": 1225,
                  "floorAssemblyEffectiveRValue": 20.6
                }
              ],
              "roofs": [
                {
                  "id": "Roof1",
                  "area": 1370,
                  "pitch": 6,
                  "assemblyEffectiveRValue": 2.3,
                  "lifetime": {
                    "replacementCost": 7000,
                    "endOfLifeDate": "2030-01-01"
                  }
                }
              ],
              "walls": [
                {
                  "id": "Wall1",
                  "type": "wood stud",
                  "assemblyEffectiveRValue": 4.0,
                  "fractionAreaShared": 0.0
                }
              ],
              "foundations": [
                {
                  "id": "BasementConditioned1",
                  "type": "basement conditioned",
                  "area": 1188,
                  "wallHeight": 8
                }
              ]
            },
            "systems": {
              "hvac": {
                "hvacCoolingSystems": [
                  {
                    "id": "RoomAirConditioner1",
                    "systemType": "room air conditioner",
                    "coolEfficiency": 10.7,
                    "coolEfficiencyUnits": "EER",
                    "coolLoadFraction": 0.33,
                    "lifetime": {
                      "replacementCost": 200,
                      "endOfLifeDate": "2024-07-01"
                    }
                  }
                ],
                "hvacHeatingSystems": [
                  {
                    "id": "ElectricResistance1",
                    "systemType": "electric resistance",
                    "fuel": "electricity",
                    "heatEfficiency": 1.0,
                    "heatEfficiencyUnits": "fraction",
                    "heatLoadFraction": 1.0
                  }
                ],
                "hvacControlSystems": [
                  {
                    "id": "HVACControl1",
                    "heatingSeason": {
                      "setpoint": 68
                    },
                    "coolingSeason": {
                      "setpoint": 78
                    }
                  }
                ]
              },
              "waterHeating": {
                "waterHeatingSystems": [
                  {
                    "id": "WaterHeater1",
                    "systemType": "storage water heater",
                    "fuel": "electricity",
                    "location": "conditioned space",
                    "tankVolume": 40,
                    "dhwLoadFraction": 1.0,
                    "efficiency": 0.92,
                    "efficiencyUnits": "EF",
                    "hotWaterTemperature": 125.0,
                    "lifetime": {
                      "replacementCost": 1000,
                      "installedDate": "2015-11-12"
                    }
                  }
                ]
              }
            },
            "appliances": {
              "clothesDryers": [
                {
                  "id": "ClothesDryer1",
                  "fuel": "electricity",
                  "combinedEnergyFactor": 3.73,
                  "isVented": true,
                  "ventedFlowRate": 150
                }
              ],
              "cookingRanges": [
                {
                  "id": "CookingRange1",
                  "fuel": "electricity",
                  "isInduction": false
                }
              ]
            }
          },
          "energyTotals": {
            "annual": {
              "coalTotal": {
                "mbtu": [0.0]
              },
              "electricityTotal": {
                "kwh": [0.0],
                "mbtu": [0.0]
              },
              "fuelOilTotal": {
                "mbtu": [0.0]
              },
              "naturalGasTotal": {
                "mbtu": [0.0]
              },
              "propaneTotal": {
                "mbtu": [0.0]
              },
              "woodCordTotal": {
                "mbtu": [0.0]
              },
              "woodPelletsTotal": {
                "mbtu": [0.0]
              },
              "total": {
                "mbtu": [0.0]
              }
            }
          },
          "energyCosts": {
            "annual": {
              "coalTotal": [0.0],
              "electricityTotal": [0.0],
              "fuelOilTotal": [0.0],
              "naturalGasTotal": [0.0],
              "propaneTotal": [0.0],
              "woodCordTotal": [0.0],
              "woodPelletsTotal": [0.0],
              "total": [0.0]
            }
          },
          "emissionTotals": {
            "annual": {
              "coalTotal": {
                "co2": [0.0]
              },
              "electricityTotal": {
                "co2": [0.0]
              },
              "fuelOilTotal": {
                "co2": [0.0]
              },
              "naturalGasTotal": {
                "co2": [0.0]
              },
              "propaneTotal": {
                "co2": [0.0]
              },
              "woodCordTotal": {
                "co2": [0.0]
              },
              "woodPelletsTotal": {
                "co2": [0.0]
              },
              "total": {
                "co2": [0.0]
              }
            }
          }
        },
        {
          "id": "c4574bb1-162d-49ee-b5dc-06c8883b3cc0",
          "radiantId": "3715acd5-2193-40b0-a238-a7c6cc798bfe",
          "label": "SWIFT_WEASEL",
          "automatedMeasures": {
            "newHeatPump": {
              "systemType": "heat-pump",
              "performanceClass": "federal minimally compliant"
            }
          },
          "requestedImprovedBuilding": {},
          "appliedImprovedBuilding": {
            "buildingSummary": {
              "conditionedFloorArea": 2413,
              "averageCeilingHeight": 8,
              "bathCount": 2,
              "bedroomsCount": 4,
              "residentCount": 5,
              "storiesCount": 1,
              "windowToWallFraction": 0.14,
              "yearBuilt": 1945,
              "propertyUse": "single-family detached"
            },
            "enclosure": {
              "airInfiltration": {
                "rate": 15.0,
                "rateUnit": "ACH",
                "housePressurePa": 50.0
              },
              "attics": [
                {
                  "id": "Attic1",
                  "area": 1225,
                  "floorAssemblyEffectiveRValue": 20.6
                }
              ],
              "roofs": [
                {
                  "id": "Roof1",
                  "area": 1370,
                  "pitch": 6,
                  "assemblyEffectiveRValue": 2.3
                }
              ],
              "walls": [
                {
                  "id": "Wall1",
                  "type": "wood stud",
                  "assemblyEffectiveRValue": 4.0,
                  "fractionAreaShared": 0.0
                }
              ],
              "foundations": [
                {
                  "id": "BasementConditioned1",
                  "type": "basement conditioned",
                  "area": 1225,
                  "wallHeight": 8
                }
              ]
            },
            "systems": {
              "hvac": {
                "hvacCoolingSystems": [],
                "hvacHeatingSystems": [
                  {
                    "id": "Boiler1",
                    "connectedDistributionId": "HVACDistributionBoiler1",
                    "systemType": "boiler",
                    "fuel": "natural gas",
                    "heatEfficiency": 0.8,
                    "heatEfficiencyUnits": "AFUE"
                  }
                ],
                "hvacDistributionSystems": {
                  "hydronicDistributionSystems": [
                    {
                      "id": "HVACDistributionBoiler1",
                      "systemType": "baseboard",
                      "conditionedFloorAreaServed": 2413
                    }
                  ]
                },
                "hvacHeatPumps": [
                  {
                    "id": "MiniSplit1",
                    "systemType": "mini-split",
                    "compressorType": "variable speed",
                    "backupSystem": {
                      "systemType": "separate",
                      "backupHvacId": "Boiler1"
                    },
                    "heatEfficiency": 8.5,
                    "heatEfficiencyUnits": "HSPF",
                    "coolEfficiency": 14,
                    "coolEfficiencyUnits": "SEER",
                    "heatLoadFraction": 1.0,
                    "coolLoadFraction": 1.0
                  }
                ],
                "hvacControlSystems": [
                  {
                    "id": "HVACControl1",
                    "heatingSeason": {
                      "setpoint": 68
                    },
                    "coolingSeason": {
                      "setpoint": 78
                    }
                  }
                ]
              },
              "waterHeating": {
                "waterHeatingSystems": [
                  {
                    "id": "WaterHeater1",
                    "systemType": "storage water heater",
                    "connectedHeatingId": "Boiler1",
                    "fuel": "natural gas",
                    "location": "conditioned space",
                    "tankVolume": 40,
                    "dhwLoadFraction": 1.0,
                    "heatCapacityBtuPerHour": null,
                    "efficiency": 0.92,
                    "efficiencyUnits": "EF",
                    "hotWaterTemperature": 125.0
                  }
                ]
              }
            },
            "appliances": {
              "clothesDryers": [
                {
                  "id": "ClothesDryer1",
                  "fuel": "electricity",
                  "combinedEnergyFactor": 3.73,
                  "isVented": true,
                  "ventedFlowRate": 150
                }
              ],
              "cookingRanges": [
                {
                  "id": "CookingRange1",
                  "fuel": "electricity",
                  "isInduction": false
                }
              ]
            }
          },
          "energyTotals": {
            "annual": {
              "coalTotal": {
                "mbtu": [0.0]
              },
              "electricityTotal": {
                "kwh": [0.0],
                "mbtu": [0.0]
              },
              "fuelOilTotal": {
                "mbtu": [0.0]
              },
              "naturalGasTotal": {
                "mbtu": [0.0]
              },
              "propaneTotal": {
                "mbtu": [0.0]
              },
              "woodCordTotal": {
                "mbtu": [0.0]
              },
              "woodPelletsTotal": {
                "mbtu": [0.0]
              },
              "total": {
                "mbtu": [0.0]
              }
            }
          },
          "energyCosts": {
            "annual": {
              "coalTotal": [0.0],
              "electricityTotal": [0.0],
              "fuelOilTotal": [0.0],
              "naturalGasTotal": [0.0],
              "propaneTotal": [0.0],
              "woodCordTotal": [0.0],
              "woodPelletsTotal": [0.0],
              "total": [0.0]
            }
          },
          "emissionTotals": {
            "annual": {
              "coalTotal": {
                "co2": [0.0]
              },
              "electricityTotal": {
                "co2": [0.0]
              },
              "fuelOilTotal": {
                "co2": [0.0]
              },
              "naturalGasTotal": {
                "co2": [0.0]
              },
              "propaneTotal": {
                "co2": [0.0]
              },
              "woodCordTotal": {
                "co2": [0.0]
              },
              "woodPelletsTotal": {
                "co2": [0.0]
              },
              "total": {
                "co2": [0.0]
              }
            }
          }
        }
      ],
      "totalEnergyCosts": 0.0,
      "totalEmissions": {
        "co2": 0.0
      }
    }
  ]
}