announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Reporting Services / Custom Reporting API Timeframes

Custom Reporting API Timeframes

Timeframes

The timeframes that you can use with the Custom Reporting APIs are the same timeframes that are available in the user interface. The following is a mapping between the timeframes in the user interface to its XML equivalent.

Timeframe Option XML Snippet
Current Year for Energy 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentPeriod>
          <meterType>ENERGY</meterType>
     </currentPeriod>
</timeframe>
Current Year for Water 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentPeriod>
          <meterType>WATER</meterType>
     </currentPeriod>
</timeframe>
Current Year for Waste 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentPeriod>
          <meterType>WASTE</meterType>
     </currentPeriod>
</timeframe>
Baseline Year for Energy 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <baselinePeriod>
          <meterType>ENERGY</meterType>
     </baselinePeriod>
</timeframe>
Baseline Year for Water 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <baselinePeriod>
          <meterType>WATER</meterType>
     </baselinePeriod>
</timeframe>
Baseline Year for Waste 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <baselinePeriod>
          <meterType>WASTE</meterType>
     </baselinePeriod>
</timeframe>
Compare Baseline Year for Energy with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareBaselinePeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>ENERGY</meterType>
     </compareBaselinePeriod>
</timeframe>
Compare Baseline Year for Water with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareBaselinePeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>WATER</meterType>
     </compareBaselinePeriod>
</timeframe>
Compare Baseline Year for Waste with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareBaselinePeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>WASTE</meterType>
     </compareBaselinePeriod>
</timeframe>
Compare Current Year for Energy with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareCurrentPeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>ENERGY</meterType>
     </compareCurrentPeriod>
</timeframe>
Compare Current Year for Water with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareCurrentPeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>WATER</meterType>
     </compareCurrentPeriod>
</timeframe>
Compare Current Year for Waste with specific period ending date 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <compareCurrentPeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
          <meterType>WASTE</meterType>
     </compareCurrentPeriod>
</timeframe>
Current Year vs Baseline Year for Energy 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentVsBaseline>
          <meterType>ENERGY</meterType>
     </currentVsBaseline>
</timeframe>
Current Year vs Baseline Year for Water 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentVsBaseline>
          <meterType>WATER</meterType>
     </currentVsBaseline>
</timeframe>
Current Year vs Baseline Year for Waste 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <currentVsBaseline>
          <meterType>WASTE</meterType>
     </currentVsBaseline>
</timeframe>
Single Year N/A 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <singlePeriod>
          <periodEndingDate>
               <month>1</month>
               <year>2021</year>
          </periodEndingDate>
     </singlePeriod>
</timeframe>
Compare Two Years N/A 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <twoPeriods>
          <periodEndingDateOne>
               <month>1</month>
               <year>2021</year>
          </periodEndingDateOne>
          <periodEndingDateTwo>
               <month>1</month>
               <year>2022</year>
          </periodEndingDateTwo>
     </twoPeriods>
</timeframe>
Date Range Monthly Interval 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <dateRange>
          <fromPeriodEndingDate>
               <month>1</month>
               <year>2021</year>
          </fromPeriodEndingDate>
          <toPeriodEndingDate>
               <month>1</month>
               <year>2022</year>
          </toPeriodEndingDate>
          <interval>MONTHLY</interval>
     </dateRange>
</timeframe>
Date Range Quarterly Interval 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <dateRange>
          <fromPeriodEndingDate>
               <month>1</month>
               <year>2021</year>
          </fromPeriodEndingDate>
          <toPeriodEndingDate>
               <month>1</month>
               <year>2022</year>
          </toPeriodEndingDate>
          <interval>QUARTERLY</interval>
     </dateRange>
</timeframe>
Date Range Yearly Interval 
<?xml version="1.0" encoding="UTF-8"?>
<timeframe>
     <dateRange>
          <fromPeriodEndingDate>
               <month>1</month>
               <year>2021</year>
          </fromPeriodEndingDate>
          <toPeriodEndingDate>
               <month>1</month>
               <year>2022</year>
          </toPeriodEndingDate>
          <interval>YEARLY</interval>
     </dateRange>
</timeframe>
LIVE