NAESB REQ.21 Energy Services Provider Interface (ESPI)

The NAESB REQ.21 ESPI Model Business Practices define the data exchange protocol for transferring retail energy usage information from a utility (Data Custodian) to a Third Party with the Retail Customer's authorization. ESPI is the industry-consensus standard that is the basis of every Green Button implementation in North America and is the standard endorsed by the Green Button Alliance. NAESB publishes the standard; it does not operate an ESPI endpoint — each Data Custodian utility hosts its own, so there is no NAESB base URL. The Atom/XML payload schemas (NAESBespiSchema.xsd and retailcustomer.xsd, v3.3 and v4.0) are released under the Apache License 2.0 as a one-time exception to the NAESB Copyright Policy and are harvested here verbatim. The narrative Model Business Practices themselves are copyright-protected and must be purchased or obtained through NAESB membership. The v4.0 schema encodes an OAuth 2.0 authorization model directly — ApplicationInformation carries authorizationServerAuthorizationEndpoint, authorizationServerTokenEndpoint, authorizationServerRegistrationEndpoint, GrantType, TokenEndPointMethod, scope and OAuthError.

API entry from apis.yml

apis.yml Raw ↑
aid: naesb:naesb-espi-green-button
name: NAESB REQ.21 Energy Services Provider Interface (ESPI)
description: The NAESB REQ.21 ESPI Model Business Practices define the data exchange protocol for transferring
  retail energy usage information from a utility (Data Custodian) to a Third Party with the Retail Customer's
  authorization. ESPI is the industry-consensus standard that is the basis of every Green Button implementation
  in North America and is the standard endorsed by the Green Button Alliance. NAESB publishes the standard;
  it does not operate an ESPI endpoint — each Data Custodian utility hosts its own, so there is no NAESB
  base URL. The Atom/XML payload schemas (NAESBespiSchema.xsd and retailcustomer.xsd, v3.3 and v4.0) are
  released under the Apache License 2.0 as a one-time exception to the NAESB Copyright Policy and are
  harvested here verbatim. The narrative Model Business Practices themselves are copyright-protected and
  must be purchased or obtained through NAESB membership. The v4.0 schema encodes an OAuth 2.0 authorization
  model directly — ApplicationInformation carries authorizationServerAuthorizationEndpoint, authorizationServerTokenEndpoint,
  authorizationServerRegistrationEndpoint, GrantType, TokenEndPointMethod, scope and OAuthError.
humanURL: https://www.naesb.org/ESPI_Standards.asp
tags:
- Green Button
- ESPI
- Energy Usage
- Smart Metering
- OAuth
- Retail Electric
properties:
- type: XMLSchema
  url: schemas/naesb-espi_v4.xsd
- type: XMLSchema
  url: schemas/naesb-customer_v4.xsd
- type: XMLSchema
  url: schemas/naesb-espi.xsd
- type: XMLSchema
  url: schemas/naesb-customer.xsd
- type: Documentation
  url: https://www.naesb.org/ESPI_Standards.asp
- type: Pricing
  url: https://www.naesb.org//misc/naesb_matl_order_espi_standards.pdf
- type: TermsOfService
  url: https://www.naesb.org/copyright.asp
- type: AgentSkill
  name: Authorize and retrieve Green Button energy usage under NAESB ESPI
  url: skills/naesb-espi-green-button-authorization.md