For your security, you will be logged out of your session in 5 minutes.
For your security, you have been logged out of your session due to inactivity.
PG&E's Share My Data service provides a remote connection Application Programming Interface (API) at URL endpoints for external software services to receive PG&E customer authorized account data. The APIs are secured and require properly credentialed access by third parties. Credentials are distributed to third parties through a registration process at http://sharemydata.pge.com/#login, and data access is encrypted using TLS1.2 mutual authentication connection. Tokens are issued and managed in conjunction with both third party registration and end user customer authorization, according to the OAuth2 standard.
To assist with the development of software to connect to the Share My Data platform, it is helpful to see the detailed mechanism involved in each call to the published APIs endpoints. To this end, PG&E has some sample SDKs it has developed in the past for both JavaScript and Python to illustrate key aspects of connecting to the Share My Data platform. These SDKs provide code samples to help guide you through the process of development, but are not intended to provide production code. For JavaScript, you will need to install NodeJS, and make sure to "npm install –save …" to update relevant NodeJS library modules. The code is not standalone, but provides snippets that illustrate how the interaction happens between a third-party data client code and PG&E's Share My Data API services.
To assist with the implementation of the Share My Data platform, PG&E developed SDKs in both JavasScript and Python. These SDKs provide samples to help guide you through the process of development, but are not intended to provide functioning code.
[ZIP, 1.73 MB]
[PDF, 622.01 KB]
[ZIP, 5.11 KB]
[PDF, 711.35 KB]
Download Supported APIs (PDF, 88 KB)
The Supported APIs document shows the APIs supported by PG&E's implementation of Share My Data, as well as the PG&E specific API URL.
Download Supported Function Blocks (PDF, 108 KB)
The Supported Function Blocks document lists which ESPI standard function blocks PG&E's Share My Data implementation supports.
Download Supported Relational Data Model (PG&E Implementation of ESPI) (PDF, 282 KB)
In conjunction with the Supported Data Elements document, the Supported Relational Data Model illustrates how the relationship between the different PG&E data elements is captured by the ESPI standard.
Download Supported Data Elements (PDF, 135 KB)
The Supported Data Elements document provides a mapping between the ESPI standard data elements and PG&E's data elements.
Download XSDs (ZIP, 50 KB)
These XSDs correspond to the version of the ESPI schema definition that our Share My Data implementation uses (XSDs provide ESPI standard defined data elements).
DOWNLOAD PROCESS FLOW (PDF, 550 KB)
These process flow diagrams illustrate the redirects, authorization token flows necessary to implement PG&E's Share My Data interaction.
Share My Data implementation follows the national Energy Service Provider Interface (ESPI) standard. The standard has also been branded as the Green Button Connect My Data initiative (GBCMD) as promoted by the White House Chief Technology Officer and Presidential Innovation Fellows. The ESPI standard outlines the technical framework for delivering functionality around customer authorization, data exchange and the format of the authorized data that is exchanged. These details are covered in the ESPI standard and GBCMD documentation. Find the documentation at Green Button Data.
To utilize Share My Data, third parties must first obtain and provision an X.509 digital certificate from a trusted certificate authority on their API connection servers. Third parties can then complete registration with PG&E at the third party registration site, upload their certificate there also, receive credentials from PG&E that enable them to test their connection, and subsequently obtain bearer tokens through our data custodian authorization token endpoints. These bearer tokens are described in the OAuth2 standard and enable third party software to securely connect PG&E's data access APIs. The SDK's provide interaction details on how to obtain the tokens in the script code.
Client access bearer tokens and Customer data access bearer tokens are obtained separately and are called Client Access Tokens and Access Tokens, respectively. Access Tokens are obtained per individual PG&E customer authorization. A typical workflow is one that follows OAuth2, per standard (IETF 6749) authorization mechanism, where a customer begins at a third party site, and that site redirects the customer to https://sharemydata.pge.com/#MyAuthorization/ first for authentication. There, the customer authenticates with PG&E and goes through a scope defining authorization of their data access to the third party ("Click-through" process). Upon completion, PG&E redirects back to the third party with an HTTP 302 response, whereupon the third party is ready to obtain bearer tokens (access token). Review a detailed flow of the process.
The third party data client server connects to PG&E's data access API endpoints by mutual TLS 1.2 connection. The individual API endpoint access controlled by bearer tokens; once a request is accepted and processed, the data is returned in a synchronous response or an asynchronous response based on a notification to a third party specified URL.
The data follows the aforementioned ESPI schema. Review a description of the supported elements.
PG&E releases data according to the scope allowed for the third party type and customer authorization.
Review a definition of the scope, and also follow the Green Button scope definitions.
Prior to registering to use Share My Data, we highly recommend that you and your organization familiarize yourselves with the following resources:
Visit the Green Button Data SDK
Tools for creating, testing, and displaying Green Button data files. Find the SDKs developed by PG&E: JavaScript | Python)
Visit the Green Button API Sandbox
This API sandbox allows developers full access, in Green Button Format, to Energy Usage Information for the purpose of developing new Green Button applications.
Due to finite system resources as well as to allow PG&E to reduce operational risks, the following API threshold limits are in place to ensure ongoing platform stability for our users.
Please be aware that our acceptable use conditions are subject to change. The Share My Data team is continually evaluating our ability to support third party requests as the platform grows and more users integrate with the system. However, we will be certain to communicate any such change in advance of implementation.
Please see the following release notes for improvements and changes we've made to Share My Data. If you encounter an issue with Share My Data or have a suggestion for improving the service, contact us at ShareMyData@pge.com.
March 20, 2023
What’s new:
RQI value | Description | |
---|---|---|
0 |
Valid: data that has gone through all required validation checks and either passed them all or has been verified |
|
7 |
Manually edited: replaced or approved by a human |
|
8 |
Estimated using reference day: data value was replaced by a machine computed value based on analysis of historical data using the same type of measurement |
|
9 |
Estimated using linear interpolation: data value was computed using linear interpolation based on the readings before and after it |
|
10 |
Questionable: data that has failed one or more checks |
|
11 |
Derived: data that has been calculated (using logic or mathematical operations), not necessarily measured directly |
|
12 |
Projected (forecast): data that has been calculated as a projection or forecast of future readings |
|
13 |
Mixed: indicates that the quality of this reading has mixed characteristics |
|
14 |
Raw: data that has not gone through the validation, editing and estimation process. NOTE MV90 Meters RQI indicator will remain in 14 as a final RQ status |
|
15 |
Normalized for weather: the values have been adjusted to account for weather, to compare usage in different climates |
|
16 |
Other: specifies that a characteristic applies other than those defined |
|
17 |
Validated: data that has been validated and possibly edited and/or estimated in accordance with approved procedures |
|
18 |
Verified: data that failed at least one of the required validation checks but was determined to represent actual usage |
|
19 |
Revenue quality: valid and acceptable for billing purposes [possible extension for ESPI standard, and not part of original ESPI] |
5. Release of vendor API usage metrics in the Share My Data Third Party vendor portal.
November 15, 2018
What's new:
September 27, 2018
What's new:
PG&E added new data elements to the Rule 24 data set as part of PG&E's Expanded Data Set (EDS) project, and corresponding new data elements are introduced in Rule 25 data set. The specific data elements comprising PG&E's expanded Rule 25 data set are set forth below with designation EDS:
Rule 25 Data Elements
Notes
Account Elements
Account Name
Account Address
Account ID
EDS: Outage Block
Service Elements
PG&E UUID
Service ID
Future Changes to Status of Service
SA Status
Service Start Date
Service Address
Current Service Tariff
Historical Billed Service Tariff
Tariff Options (Medical Baseline, CARE, FERA, TBS, CCA_TBS, Solar Choice
Current Service Voltage and Commodity Historical Billed Service Voltage
Service Meter Number
Number of Service Meters
Meter Type
Current Meter Read Cycle
Historical Billed Meter Read Cycle
Current Standby Rate Option if On-site Generation Indicator
Historical Billed Standby Rate Option
EDS: Customer Class Indicator
Historical Billing Elements
Bill start date
Bill end date
Bill total charges($)
Bill total kWh
EDS: Name of Service Provider
Historical Bill Tier Breakdown (if any)
EDS: Line Item Bill Period
EDS: Name (Over Baseline 1%-30%)
EDS: Volume (1234.2)
EDS: Rate ($0.032/kWh)
EDS: Cost ($100.23)
Historical Bill TOU kWh breakdown (except for ABS-TX billed)
EDS: Line Item Bill Period (for TOU breakdown)
EDS: Name (of TOU charge)
EDS: Volume (1234.2)
EDS: Rate ($0.032/kWh)
EDS: Cost ($100.23)
Historical Bill Demand Breakdown
EDS: Line Item Bill Period (for Demand breakdown)
EDS: Name
EDS: Volume (1234.2)
EDS: Rate ($0.032/kWh)
EDS: Cost ($100.23)
Historical Bill Line Items
EDS: Line Item Bill Period
EDS: Charge name (DWR Bond Charge)
EDS: Volume (1234.2)
EDS: Unit (kWh)
EDS: Rate ($0.032/kWh)
EDS: Cost ($100.23)
Historical Usage Intervals
Interval Usage Start
Default Interval Duration (in seconds)
Interval usage Volume (1234.2)
Unit (kWh/Therms)
Utility Demand Response Programs
(DR) Program Name
Earliest Termination Date without Financial Obligation
Earliest Termination Date regardless of Financial Obligation
DR Program Status
DR Program Enrollment Date
DR Program De-Enrollment Date
Data Elements
Commodity
Local Time Parameters (DST details)
Default Data Quality
Energy Direction
Power of Ten Multiplier (for interval usage values)
Power of Ten Multiplier (for Billed Demand)
Power of Ten Multiplier (For Billed total usage)
Interval Length(of Usage Reading)
Currency of bill total cost
Electric Interval TOU Indicators
June 28, 2018
As part of the Click-Through project and the continued improvements to the Share My Data Platform, PG&E launched Click-Through Phase 2 on June 28, 2018.
What's new:
The most critical changes that impact third parties are changes to conform to the OAuth 2.0 protocol (PG&E eliminated the initial series of redirects). Find details below.
IMPORTANT: Third parties are REQUIRED to make changes to their existing OAuth implementation. PG&E's Click-Through Phase 2 changes are NOT backwards compatible, so it is necessary for third parties to implement changes concurrent with PG&E's implementation. Without implementation, the current customer authorization process will stop working on the cut-off date of June 29, 2018. Existing authorizations, however, are unaffected.
Please note: Besides the changes to the customer authorization process, other changes are also backwards compatible and are voluntary enhancements third parties can elect to support.
If you have any questions or need additional support, feel free to email sharemydata@pge.com.
What’s new:
Required Changes: the following SMD 2.0 updates require changes on the part of third parties.
Optional Enhancements: The following changes are backwards compatible, and are voluntary enhancements third parties can elect to support.
Should you have any questions or need for additional support, please feel free to contact us at ShareMyData@pge.com.
Required Changes: the following SMD 2.0 updates require changes on the part of those users accessing their own data:
Optional Enhancements: The following changes are backwards compatible, and are voluntary enhancements third parties can elect to support.
Should you have any questions or need for additional support, please feel free to contact us at ShareMyData@pge.com.
Required Changes: the following SMD 2.0 updates require changes on the part of CCA implementations.
Optional Enhancements: The following changes are backwards compatible, and are voluntary enhancements third parties can elect to support.
Should you have any questions or need for additional support, please feel free to contact us at ShareMyData@pge.com.
What's new:
Fixed defects:
Questions or concerns? Please contact ShareMyData@pge.com.
If you have questions or comments, please email our team at ShareMyData@pge.com.