How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PG&E Share My Data (Green Button Connect My Data) ESPI API

PG&E's production Green Button Connect My Data implementation, branded Share My Data. A NAESB REQ.21 Energy Services Provider Interface (ESPI) 1.1 REST API returning Green Button Atom/XML, serving customer-authorized electric and gas interval usage, usage summaries, reading types, billing and account information, service tariff and rate-plan detail, and demand response program enrollment. PG&E's own Supported-APIs reference enumerates the resource set: DownloadSampleData, ReadServiceStatus, ApplicationInformation, Authorization (feed, single, and DELETE revocation), LocalTimeParameters, ReadingType, Subscription UsagePoint / MeterReading / IntervalBlock / UsageSummary trees, and the asynchronous Batch family — Batch/Bulk/{BulkID}, Batch/Subscription/{SubscriptionID}, Batch/BulkRetailCustomerInfo/{BulkID}, Batch/RetailCustomer/{RetailCustomerID}, Batch/BulkRetailDRPrgInfo/{BulkID} and Batch/RetailDRPrgInfo/{RetailCustomerID}. Asynchronous results are announced to a third party's registered notification URI. Every production request runs over mutual (two-way) TLS 1.2 with the third party's X.509 client certificate attached, plus a bearer token — client_access_token for third-party-level resources, per-customer access_token for subscription resources, registration_access_token for ApplicationInformation. Verified live anonymously on 2026-07-27: the ESPI resource paths answer HTTP 400 "Invalid Certificate" from a Mulesoft-API-Gateway while invented sibling paths answer HTTP 404 "No listener for endpoint", which distinguishes a real mTLS-protected listener from a catch-all. Access is application-approval gated; not self-serve.

PG&E Share My Data (Green Button Connect My Data) ESPI API is one of 2 APIs that Pacific Gas and Electric publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Green Button, ESPI, Energy Data, Smart Metering, and Electricity. The published artifact set on APIs.io includes API documentation, an API reference, an OpenAPI specification, rate-limit docs, sample payloads, and SDKs.

This API exposes 7 operations across 7 paths, organized into 4 resource areas, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.greenbuttonalliance.org:8443/DataCustodian.

7 operations 7 paths 7 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.pge.com/GreenButtonConnect/espi/1_1/resource
Authentication
OAuth 2.0
License
Resource Areas
4

Authentication & Security 1

PG&E Share My Data (Green Button Connect My Data) ESPI API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode and clientCredentials flows. By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. They span 4 resource areas: ApplicationInformation, Authorization, Batch, UsagePoint. Each is listed below with its method, path, parameters, and response codes.

ApplicationInformation 2

Application Information endpoints

GET
/espi/1_1/resource/ApplicationInformation
Retrieve all Application Information [FB33]
findApplicationInformations 7 params → 200202400403
GET
/espi/1_1/resource/ApplicationInformation/{applicationInformationId}
Retrieve Application Information by Id [FB3]
getApplicationInformation 1 param → 200202400403
Authorization 2

Authorization endpoints

GET
/espi/1_1/resource/Authorization
Find all Authorizations [FB3]
findAuthorizations 7 params → 200202400403
GET
/espi/1_1/resource/Authorization/{authorizationId}
Retrieve Authorization by Id [FB3]
getAuthorization 8 params → 200202400403
Batch 1

Batch data transfer endpoints

GET
/espi/1_1/resource/Batch/Bulk/{bulkId}
Request Bulk transfer [FB35]
downloadBulkData 8 params → 200202400403
UsagePoint 2

Usage Point endpoints

GET
/espi/1_1/resource/UsagePoint
Retrieve all Usage Points [FB33]
findUsagePoints 7 params → 200202400403
GET
/espi/1_1/resource/UsagePoint/{usagePointId}
Retrieve Usage Point by Id [FB32]
getUsagePoint 8 params → 200202400403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ApplicationInformation (12 properties), Authorization (8 properties), AtomEntry (6 properties), UsagePoint (6 properties). Each schema is shown below with its type and property counts.

ApplicationInformation
object
Contains information about a Third Party Application requesting access to DataCustodian services
12 properties
Authorization
object
Represents a permission granted by an owner for access to a resource
8 properties
UsagePoint
object
Logical point on a network at which consumption or production is measured or estimated
6 properties
AtomLink
object
Atom link element (RFC 4287)
3 properties
AtomContent
object
Atom content element containing ESPI resource (RFC 4287)
1 property
AtomEntry
object
Atom feed entry (RFC 4287) containing ESPI resource
6 properties
AtomFeed
object
Atom Feed (RFC 4287) containing ESPI resources
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

green-button-alliance-espi-openapi.json Raw ↑

Other APIs Pacific Gas and Electric publishes across the network.

PG&E Share My Data OAuth 2.0 Authorization API
Where this information came from

This is an independent, third-party profile of PG&E Share My Data (Green Button Connect My Data) ESPI API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.