...
https://stg-2030ddx.aia.org/api/v1/authenticate
http://beta2030ddx.aia.org/api/v1/authenticate ( recommended site to test APIs until launch timeline)
Sample API Request For Project Create Or Update-
...
https://stg-2030ddx.aia.org/api/v1/import_project
https://beta2030ddx.aia.org/api/v1/import_project (recommended site to test APIs until launch timeline)
User Authentication
When firm users are attempting to transfer project data from an energy modeling tool linked to the DDx API, the first step in the process is authentication. For authentication purposes, two types of keys—the User Key and Firm Key—are required to be provided by the user to generate an authentication token and establish the data link.
...
DDx Input Field | API Parameter Name | DDx MATCH Selection Option |
Project Category | projectCategory | Non-Residential Residential |
Project Phase | projectPhase | Concept Schematic Design Design Development Construction Documents Construction Administration
|
Country | country | See Appendix A |
State/Province | state | See Appendix B |
Climate Zone | climateZone | 1A Very Hot - Humid 1B Very Hot - Dry 2A Hot - Humid 2B Hot - Dry 3A Warm - Humid 3B Warm - Dry 3C Warm - Marine 4A Mixed - Humid 4B Mixed - Dry 4C Mixed - Marine 5A Cool - Humid 5B Cool - Dry 6A Cold - Humid 6B Cold - Dry 7 Very Cold 8 Subarctic |
Use Type 1 | useType1 | See Appendix C |
Design Energy Code | designEnergyCode | ASHRAE 90.1-1999 ASHRAE 90.1-2001 ASHRAE 90.1-2004 ASHRAE 90.1-2007 ASHRAE 90.1-2010 ASHRAE 90.1-2013 ASHRAE 90.1-2016 California Title 24 2005 for high rise residential California Title 24 2005 for single family residential California Title 24 2008 California Title 24 2010 California Title 24 2013 California Title 24 2016 California Title 24 NonResidential-2008 California Title 24 Residential-2005 California Title 24 Residential-2008 IECC 2018 IECC-2003 IECC-2006 IECC-2009 IECC-2012 IECC-2015 Massachusetts Stretch Code NECB 2011 NECB 2015 NECB 2017 Older than 1999 Oregon Energy Code Oregon Energy Code 2010 Oregon Energy Code 2014 Oregon Energy Efficiency Specialty Code 2014 Oregon Energy Efficiency Specialty Code-2010 Washington Energy Code Washington Energy Code 2015 Washington State Energy Code-2012 |
Energy Modeling Tool | energyModelingTool | 30 AEDG AERG 50 AEDG AERG Autodesk Insight 360 Cove.tool DOE 2.2 DOE-2.1E EnergyPro DOE-2.1E VisualDOE DOE-2.2 eQuest DOE-2.2 GreenBuildingStudio DOE-2.2 Other EnergyPlus AECOSim EnergyPlus DesignBuilder EnergyPlus Ladybug Tools EnergyPlus OpenStudio EnergyPlus Other EnergyPlus Simergy HAP HEED Home Energy Saver IES - Virtual Environment
Other Other design guide Other energy simulation tool PlanITImpact REM Rate Sefaira Trace 3D Plus Trace 700 TRNSYS |
Renewables | renewables | None PV Solar Thermal Wind Turbine |
Chiller Type | chillerType | Electric Driven Natural Gas Absorption Natural Gas Engine Driven |
...
AIA 2030 DDx Use Types | ENERGY STAR Target Finder Use Types | |
1 | Bank/Financial Institution | bankBranch |
2 | Courthouse | Courthouse |
3 | Data Center | DataCenter |
4 | Education - College/University (campus-level) | CollegeUniversity |
5 | Education - General | AdultEducation |
6 | Education - K-12 School | K-12School |
7 | Food Sales - Convenience Store (w/ or w/out gas station) | ConvenienceStoreWithGasStation |
8 | Food Sales - General | WholesaleClubSupercenter |
9 | Food Sales - Supermarket/Grocery | SupermarketGroceryStore |
10 | Food Service - Fast Food | FastFoodRestaurant |
11 | Food Service - General | Food Service |
12 | Food Service - Restaurant/Cafeteria | Restaurant |
13 | Health Care - Clinic | UrgentCareClinicOtherOutpatient |
14 | Health Care - Hospital Inpatient | Hospital |
15 | Health Care - Medical Office | MedicalOffice |
16 | Health Care - Nursing/Assisted Living | SeniorCareCommunity |
17 | Health Care - Outpatient - General | OutpatientRehabilitationPhysicalTherapy |
18 | Laboratory | Laboratory |
19 | Lodging - General | otherLodgingResidential |
20 | Lodging - Hotel/Motel | Hotel |
21 | Lodging - Residence Hall/Dormitory | ResidenceHallDormitory |
22 | Mixed-Use | Mixed Use |
23 | Office - Small ( less than < 10,000 sf) | Office |
24 | Office - Medium (10,000 to < 100,000 sf) | Office |
25 | Office - Large ( greater than 100,000 sf) | Office |
26 | Public Assembly - Entertainment/Culture | PerformingArts |
27 | Public Assembly - General | Other - Entertainment/Public Assembly Use |
28 | Public Assembly - Library | Library |
29 | Public Assembly - Recreation | otherRecreation |
30 | Public Assembly - Social/Meeting | socialMeetingHall |
31 | Public Safety - Fire/Police Station | fireStation |
32 | Public Safety - General | otherPublicServices |
33 | Religious Worship | WorshipFacility |
34 | Residential - Mid-Rise/High-Rise | No Reasonable Target Finder match |
35 | Residential - Mobile Homes | SingleFamilyHome |
36 | Residential - Multi-Family, 2 to 4 units | MultifamilyHousing |
37 | Residential - Multi-Family, 5 or more units | MultifamilyHousing |
38 | Residential - Single-Family Attached | SingleFamilyHome |
39 | Residential - Single-Family Detached | SingleFamilyHome |
40 | Retail - Mall | enclosedMall |
41 | Retail - Non-mall, Vehicle Dealerships, misc. | AutomobileDealership |
42 | Retail Store | RetailStore |
43 | Service (vehicle repair/service, postal service) | RepairServices(Vehicle,Shoe,Locksmith,etc.) |
44 | Storage - Distribution/Shipping Center | Distribution Center |
45 | Storage - General | Distribution Center |
46 | Storage - Non-refrigerated warehouse | Distribution CenterNonRefrigeratedWarehouse |
47 | Storage - Refrigerated warehouse | Distribution CenterRefrigeratedWarehouse |
48 | Warehouse - Self-storage | selfStorageFacility |
49 | Other | Other |
...