pg-and-e

pg-and-e Authorization API

OAuth 2.0 authorization for customer data access.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.pge.com/en/save-energy-and-money/energy-usage-and-tips/understand-my-usage/share-my-data.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pg-and-e/refs/heads/main/openapi/pg-and-e-authorization-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/pg-and-e/refs/heads/main/apis.yml

OpenAPI Specification

pg-and-e-authorization-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: PG&E Share My Data Authorization API
  description: The PG&E Share My Data API provides customer-authorized access to energy usage data following the Energy Service Provider Interface (ESPI) standard and Green Button Connect My Data specification. Third-party companies can access interval data for both electricity and gas usage through RESTful web services with OAuth 2.0 authorization.
  version: '1.0'
servers:
- url: https://api.pge.com
tags:
- name: Authorization
  description: OAuth 2.0 authorization for customer data access.
paths:
  /GreenButtonConnect/espi/1_1/resource/Authorization:
    get:
      operationId: listAuthorizations
      summary: List authorizations
      description: Retrieves a list of active customer authorizations granting access to energy usage data for the authenticated third-party application.
      tags:
      - Authorization
      responses:
        '200':
          description: Success
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.pge.com/datacustodian/oauth/v2/authorize
          tokenUrl: https://api.pge.com/datacustodian/oauth/v2/token
          scopes:
            usage:read: Read energy usage data