Portfolio Manager will be unavailable due to system upgrades beginning Saturday, November 16, 12:00 AM EST through Monday, November 18, 11:59 PM EST.
Web Service Documentation / Categories / Target Finder Services / Target Finder
Updated on August 23, 2020
This web service allows you to retrieve the estimated annual energy consumption associated with specific property design characteristics, and an energy performance goal expressed as either an ENERGY STAR score or % Better than Median. Conversely, you may also retrieve the ENERGY STAR score and % Better than Median associated with the estimated annual energy consumption of a specific property design. These metrics allow you to estimate how much energy your property would need to consume annually to reach your design energy goal, or conversely, determine the ENERGY STAR score that would be associated with your design estimated energy consumption. Target Finder Services does require user authentication but the property design information that you submit will not be saved for later reference. Your results can be returned in the set of units that you specify.
23.0
POST
/targetFinder?measurementSystem=(measurementSystem)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
measurementSystem | Optional. Indicates the desired set of units for the returned metrics. Valid values are METRIC or EPA. EPA is the default. |
Request/Response | Schema Name |
---|---|
Request | targetFinder.xsd |
Response | propertyMetrics.xsd |
The following example specifies an energy goal of an energy reduction target. If you want the results in the metric units then the following URL parameter should be provided: measurementSystem=METRIC
POST /targetFinder<?xml version="1.0" encoding="UTF-8"?> <targetFinder> <propertyInfo> <name>TARGET FINDER</name> <address address1="5300 Richmond Road" city="Bedford Heights" postalCode="22031" state="OH" country="US"/> <numberOfBuildings>1</numberOfBuildings> <primaryFunction>K-12 School</primaryFunction> <plannedConstructionCompletionYear>2016</plannedConstructionCompletionYear> <grossFloorArea units="Square Feet" temporary="false"> <value>10000</value> </grossFloorArea> </propertyInfo> <propertyUses> <k12School> <name>Broadway School</name> <useDetails> <totalGrossFloorArea units="Square Feet"> <value>10000</value> </totalGrossFloorArea> <openOnWeekends> <value>Yes</value> </openOnWeekends> <percentCooled> <value>80</value> </percentCooled> <percentHeated> <value>10</value> </percentHeated> <numberOfComputers> <value>50</value> </numberOfComputers> <cookingFacilities> <value>Yes</value> </cookingFacilities> <isHighSchool> <value>Yes</value> </isHighSchool> <monthsInUse> <value>8</value> </monthsInUse> <schoolDistrict> <value>String</value> </schoolDistrict> <numberOfWorkers> <value>50</value> </numberOfWorkers> <studentSeatingCapacity> <value>1000</value> </studentSeatingCapacity> <numberOfWalkInRefrigerationUnits> <value>2</value> </numberOfWalkInRefrigerationUnits> </useDetails> </k12School> </propertyUses> <estimatedEnergyList> <entries> <designEntry> <energyType>Electric</energyType> <energyUnit>MBtu (million Btu)</energyUnit> <estimatedAnnualEnergyUsage>10</estimatedAnnualEnergyUsage> <energyRateCost>100.11</energyRateCost> <energyRateCostUnit>MBtu (million Btu)</energyRateCostUnit> </designEntry> </entries> </estimatedEnergyList> <target> <targetTypeScore> <value>50</value> </targetTypeScore> </target> </targetFinder>
The following example specifies an energy goal of an energy reduction target for a property located outside the United States or Canada. The international weather station ID value used was provided by the Get International Weather Station List web service.
POST /targetFinder<?xml version="1.0" encoding="UTF-8"?> <targetFinder> <propertyInfo> <name>TARGET FINDER</name> <address address1="1234 Park Street" city="Yokohama" postalCode="220-0001" otherState="Kanagawa" country="JP"/> <numberOfBuildings>1</numberOfBuildings> <primaryFunction>K-12 School</primaryFunction> <plannedConstructionCompletionYear>2016</plannedConstructionCompletionYear> <grossFloorArea units="Square Feet" temporary="false"> <value>10000</value> </grossFloorArea> </propertyInfo> <propertyUses> <k12School> <name>Broadway School</name> <useDetails> <totalGrossFloorArea units="Square Feet"> <value>10000</value> </totalGrossFloorArea> <openOnWeekends> <value>Yes</value> </openOnWeekends> <percentCooled> <value>80</value> </percentCooled> <percentHeated> <value>10</value> </percentHeated> <numberOfComputers> <value>50</value> </numberOfComputers> <cookingFacilities> <value>Yes</value> </cookingFacilities> <isHighSchool> <value>Yes</value> </isHighSchool> <monthsInUse> <value>8</value> </monthsInUse> <schoolDistrict> <value>String</value> </schoolDistrict> <numberOfWorkers> <value>50</value> </numberOfWorkers> <studentSeatingCapacity> <value>1000</value> </studentSeatingCapacity> <numberOfWalkInRefrigerationUnits> <value>2</value> </numberOfWalkInRefrigerationUnits> </useDetails> </k12School> </propertyUses> <estimatedEnergyList> <entries> <designEntry> <energyType>Electric</energyType> <energyUnit>MBtu (million Btu)</energyUnit> <estimatedAnnualEnergyUsage>10</estimatedAnnualEnergyUsage> <energyRateCost>100.11</energyRateCost> <energyRateCostUnit>MBtu (million Btu)</energyRateCostUnit> </designEntry> </entries> </estimatedEnergyList> <target> <targetTypeScore> <value>50</value> </targetTypeScore> </target> <internationalWeatherStationId>603600</internationalWeatherStationId> </targetFinder>
The following example shows the calculated metrics for the specified design project.
<?xml version="1.0" encoding="UTF-8"?>
<propertyMetrics>
<metric name="medianScore" dataType="numeric">
<value>50</value>
</metric>
<metric name="medianSiteIntensity" uom="kBtu/ft�" dataType="numeric">
<value>77.4</value>
</metric>
<metric name="medianSourceIntensity" uom="kBtu/ft�" dataType="numeric">
<value>240.0</value>
</metric>
<metric name="medianTotalGHGEmissions" uom="Metric Tons CO2e" dataType="numeric">
<value>108.4</value>
</metric>
<metric name="medianSiteTotal" uom="kBtu" dataType="numeric">
<value>774000.0</value>
</metric>
<metric name="medianSourceTotal" uom="kBtu" dataType="numeric">
<value>2400000.0</value>
</metric>
<metric name="medianEnergyCost" uom="$" dataType="numeric">
<value>77485.14</value>
</metric>
<metric name="medianWaterWasteWaterSiteIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
<metric name="medianWaterWasteWaterSourceIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
<metric name="designPropGrossFloorArea" uom="ft�" dataType="numeric">
<value>10000</value>
</metric>
<metric name="designSystemDefinedPropertyType" dataType="string">
<value>K-12 School</value>
</metric>
<metric name="designScore" dataType="numeric">
<value>100</value>
</metric>
<metric name="designSiteIntensity" uom="kBtu/ft�" dataType="numeric">
<value>1.0</value>
</metric>
<metric name="designSourceIntensity" uom="kBtu/ft�" dataType="numeric">
<value>3.1</value>
</metric>
<metric name="designTotalGHGEmissions" uom="Metric Tons CO2e" dataType="numeric">
<value>1.4</value>
</metric>
<metric name="designSiteTotal" uom="kBtu" dataType="numeric">
<value>10000.0</value>
</metric>
<metric name="designSourceTotal" uom="kBtu" dataType="numeric">
<value>31400.0</value>
</metric>
<metric name="designEnergyCost" uom="$" dataType="numeric">
<value>1001.10</value>
</metric>
<metric name="designWaterWasteWaterSiteIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
<metric name="designWaterWasteWaterSourceIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
<metric name="designTargetScore" dataType="numeric">
<value>50</value>
</metric>
<metric name="designTargetSiteIntensity" uom="kBtu/ft�" dataType="numeric">
<value>77.4</value>
</metric>
<metric name="designTargetSourceIntensity" uom="kBtu/ft�" dataType="numeric">
<value>240.0</value>
</metric>
<metric name="designTargetTotalGHGEmissions" uom="Metric Tons CO2e" dataType="numeric">
<value>108.4</value>
</metric>
<metric name="designTargetSiteTotal" uom="kBtu" dataType="numeric">
<value>774254.9</value>
</metric>
<metric name="designTargetSourceTotal" uom="kBtu" dataType="numeric">
<value>2400190.4</value>
</metric>
<metric name="designTargetEnergyCost" uom="$" dataType="numeric">
<value>77485.14</value>
</metric>
<metric name="designTargetWaterWasteWaterSiteIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
<metric name="designTargetWaterWasteWaterSourceIntensity" dataType="numeric">
<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
</metric>
</propertyMetrics>