Developer Portal
Connector Guides
API ReferenceConsole

Energy Star Portfolio Manager - Source

EnergyStarLogo

Energy Star Portfolio Manager allows you to retrieve meter data and EPA metrics available in the Portfolio Manager application.

Use Cases

Potential use cases include:

  • Measuring electric, water, or waste data
  • Tracking EPA metrics over time

Configuration

The only requirement in the configuration on the Mapped side is your Energy Star Portfolio Manager Account ID (the 6 digit number to the left of the username). However, you'll need to to add Mapped on the Energy Star Portfolio Manager API, and then share your buildings and meters with Mapped to allow access to the data:

  • First, Initiate a sharing request to Mapped's account in portfolio manager. This can be done by logging into your Portfolio Manager account and selecting "Add Organization" from the "My Portfolio" tab. Search for '[email protected]' in the email field to find Mapped. Our system will automatically accept the request after you submit it.
  • Next, you'll need to share your properties and meters. While logged into the Portfolio Manager, click on the Sharing tab and select 'Set Up Web Services/Data Exchange'.
  • Follow the instructions in the Share Properties wizard to select the Buildings and Meters with Mapped. For this Source connector, only Read Only access is required.
  • Once you shared everything you wish to connect to Mapped, you can launch the Mapped Connector configuration wizard for Energy Star and complete configuration of the connector.

Sections 1A and 2A of these docs from Energy Star may help as well, they contain screenshots of the area you'll need to go to initiate the request and share buildings and meters.

CredentialDescription
Account IDYour Portfolio Manager Account Id

Mapped Concepts

Connector ConceptMapped Type
MeterWaste_Meter, Energy_Meter, Water_Meter
Meter UsageWaste_Amount_Sensor, Water_Usage_Sensor, Energy_Usage_Sensor
MetricsEnergy_Star_Score, GHG_Emissions, Direct_GHG_Emissions, Indirect_GHG_Emissions, Total_GHG_Emissions, Median_Total_GHG_Emissions, National_Median_Total_GHG_Emissions, Regional_Median_Total_GHG_Emissions, Canadian_Regional_Median_Total_GHG_Emissions, GHG_Emissions_Factor, Electricity_GHG_Emissions_Factor, Chilled_Water_GHG_Emissions_Factor, Direct_Fuels_GHG_Emissions_Factor, Hot_Water_GHG_Emissions_Factor, Steam_GHG_Emissions_Factor, GHG_Emissions_Intensity, Direct_GHG_Emissions_Intensity, Indirect_GHG_Emissions_Intensity, Total_GHG_Emissions_Intensity, Median_Total_GHG_Emissions_Intensity, Regional_Median_Total_GHG_Emissions_Intensity, Canadian_Regional_Median_Total_GHG_Emissions_Intensity, Energy_Use, Site_Energy_Use, Energy_Use_Intensity, Site_Energy_Use_Intensity, Source_Energy_Use, Source_Energy_Use_Intensity

Sample Code

The following example shows how to retrieve the sensor data for a Waste_Meter; other possible meters from Energy Star include Energy_Meter, Water_Meter:

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  things(filter: {exactType: {eq: "Waste_Meter"}}) {
    id
    name
    exactType
    points {
      id
      name
      exactType
      unit {
        name
      }
      series(latest: true) {
        timestamp
        value {
          float64Value
        }
      }
    }
  }
}

Additionally, the Energy Star Connector Metrics points are unique - each Metric is associated with the building itself, as opposed to a specific thing. All the Metrics listed in the Concepts table function this way - comprehensive values associated with the entire building, instead of a particular sensor or meter. To find data for these points, best route is to filter your query by a specific building id, and then filter the points in that building by the specific type of Metric.

For example, we'll look for a point named sourceIntensity, which is the total amount of raw fuel required to operate the building. You can retrieve this data by searching the building for the Source_Energy_Use_Intensity type:

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  buildings(filter: {id: {eq: "BLDG9k4udR8PhwrmSbJADUiyfB"}}) {
    points(filter: {type: {eq: "Source_Energy_Use_Intensity"}}) {
      id
      name
      exactType
      series(latest: true) {
        timestamp
        value {
          float64Value
        }
      }
    }
  }
}

More information about the available Metrics can be found in these docs from Energy Star.