Modeling API Docs
latest
Methodology Documentation
Introduction
Usage Instructions
Request Structure
Response Structure
Examples
Interactive Documentation
Interactive API Documentation
Modeling API Docs
Contents
Edit on GitHub
Contents
Methodology Documentation
Introduction
Data Sources
Public Sources
Private Sources
Modeling Methodology
Usage Instructions
Setup & Authentication
Simple Request
Advanced Request
Request Structure
Address
Address Full
Address Components
Base Building
Building Summary
Enclosure
Air Infiltration
Attics
Roofs
Foundations
Walls
HVAC
HVAC Cooling Systems
HVAC Heating Systems
HVAC Heat Pumps
Air Distribution Systems
Hydronic Distribution Systems
HVAC Control Systems
Water Heating Systems
Electrical Panels
Photovoltaics
Appliances
Clothes Dryers
Cooking Ranges
Lifetime
Timelines
Models
Model Controls
Energy Costs Rates
Weather
Loans
Incentives
Automated Measures
Operate on existing systems
Existing HVAC Heating System
Existing HVAC Cooling System
Existing HVAC Distribution System
Existing Water Heating System
Add new systems with minimal configuration
New Heat Pump
New Water Heating System
Adjust global aspects of the building
Air Sealing
Attic Insulation
Thermostat
Cost
Custom Measures
Improved Building
Global Controls
Units
Escalation Rates
Response Structure
Address Found
Address Found Full
Address Found Components
Timelines
Models
Provided Base Building
Applied Base Building
Requested Improved Building
Applied Improved Building
Model Costs
Energy Totals
Energy Totals per Fuel Time Series
Energy End Uses
Energy End Uses per Fuel Time Series
Energy Costs
Energy Costs per Fuel Time Series
Emissions Totals
Total Emissions per Fuel Time Series
Typical
Examples
Simple
Request
Response
Simple with Monthly Datapoints
Request
Response
Simple with Monthly and Hourly Datapoints
Request
Response
Using baseBuilding
Request
Response
Using automatedMeasures
Request
Response
Interactive Documentation
Interactive API Documentation