Reference · built on requestConnectorEnergy, EV & distributed resources

Green Button Connect My Data

Utility interval usage for electricity, gas, and water as NAESB ESPI Atom feeds, authorized by the customer over OAuth 2.0.

Request accessPricing ↗

About

Green Button Connect My Data is the NAESB REQ.21 Energy Services Provider Interface (ESPI), carried forward by the Green Button Alliance. A utility, the Data Custodian, publishes a customer's electricity, natural gas, or water usage as Atom/XML feeds. The Retail Customer authorizes a registered Third Party over OAuth 2.0, sets how long the authorization lasts, and can revoke it at any time. Download My Data is the same XML, fetched by the customer from the utility's own website.

Through Fibric, an operator reads UsagePoint, MeterReading, and IntervalBlock entries as each Data Custodian publishes them and sets the intervals beside bills, submeters, and tariffs. It proposes findings for your review. Nothing is written back to the utility.

This is a reference listing. It documents what Fibric would read from Green Button Connect My Data and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • UsagePoint entries for an authorized customer through GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint
  • MeterReading, ReadingType, and IntervalBlock entries under each UsagePoint, at whatever interval the utility publishes
  • UsageSummary and ElectricPowerQualitySummary entries under a UsagePoint
  • LocalTimeParameters, which give the time zone and daylight saving rules for interval timestamps
  • Bulk transfers through GET /espi/1_1/resource/Batch/Bulk/{bulkId} once the Data Custodian posts to /espi/1_1/Notification
  • Authorization records and their state through GET /espi/1_1/resource/Authorization/{authorizationId}
  • Download My Data XML files a customer hands you, which use the same Atom feed structure without OAuth

Proposed actions

Read-only. Actions need a separate connector.

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Reconcile the bill against the meter

    IntervalBlock entries for the billing period are summed and set beside the invoice. When the total or the demand charge does not match, the operator proposes a query to the utility with the intervals attached.

    With Bill Reconcile

  • Check submeters against the utility meter

    The utility's MeterReading is the reference. When your submeters drift away from it over a week, the operator proposes which meter to inspect and shows the gap.

    With Submeter Drift

  • Pick a rate from a year of intervals

    Twelve months of IntervalBlock data, priced under each tariff you are eligible for, shows which rate would have cost least. The operator proposes the switch with the comparison attached.

    With Rate Switch

  • Charge tenants for what they used

    Where a tenant authorizes their own UsagePoint, the operator reads it and proposes the chargeback line for the month, with the intervals as evidence.

    With Utility Chargeback

Requirements

  • A utility (Data Custodian) that offers Green Button Connect My Data, and a Third Party registration with it
  • A Retail Customer who completes the authorization and chooses its length; they can revoke it at any time
  • An HTTPS endpoint that accepts POST /espi/1_1/Notification from each Data Custodian
  • A parser for Atom/XML feeds in the http://naesb.org/espi namespace, with rel self, up, and related links
Authentication
OAuth 2.0 per RFC 6749: the Retail Customer authorizes your registered Third Party at the Data Custodian's authorization server, and a bearer token per RFC 6750 accompanies each request.

Limits

  • Read-only. The Data Custodian resource endpoints are GET only; there is no path to write anything to the utility
  • Interval granularity is the utility's choice, from 1-minute to monthly; you receive what the Data Custodian publishes
  • Each utility registers Third Parties on its own terms, so onboarding repeats per Data Custodian
  • New data is announced by notification and fetched as a Bulk transfer, not streamed

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Green Button Connect My Data ↗

Questions and answers

What is the difference between Connect My Data and Download My Data?
Connect My Data: the customer authorizes a Third Party over OAuth 2.0 and the utility publishes usage to it by API. Download My Data: the customer downloads an XML file from the utility's website. Both carry the same NAESB REQ.21 Atom/XML format.
How does new usage data reach us?
The Data Custodian sends POST /espi/1_1/Notification to your Third Party endpoint with resource URIs. You then fetch GET /espi/1_1/resource/Batch/Bulk/{bulkId} or GET /espi/1_1/resource/Batch/Subscription/{subscriptionId} and parse the Atom feed.
Which utilities offer it?
Utilities that implement NAESB REQ.21. The Green Button Alliance runs a testing program for Data Custodian implementations of Connect My Data and Download My Data and lists regions including North America, Canada, the European Union, and Korea. Ask your utility how it registers Third Parties.
Ask about Green Button Connect My Data

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with Green Button Connect My Data through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy