Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xcel Energy DER API

Distributed Energy Resource programs, controls, and settings.

Xcel Energy DER API is one of 29 APIs that Xcel Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DER. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.1.0.

Requests are made against 2 base URLs: https://api.xcelenergy.com/DataCustodian/espi/1_1/resource, https://developer-apim.aws.xcelenergy.com/DataCustodian/espi/1_1/resource.

4 operations 4 paths 6 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1.0
Base URL
https://api.xcelenergy.com
Authentication
OAuth 2.0, OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Xcel Energy DER API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (accessToken) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (clientAccessToken) using the clientCredentials flow, exposing 1 scope. It accepts HTTP bearer tokens (Registration Access Token) (registrationAccessToken).

  • accessToken — Customer-scoped access token issued via the OAuth 2.0 authorization-code grant.
  • clientAccessToken — Application-scoped client access token used for management endpoints (Authorization list, Bulk, ServiceStatus).
  • registrationAccessToken — Token issued at application registration; used to read or update ApplicationInformation.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

DER 4

Distributed Energy Resource programs, controls, and settings.

GET
/derp
List DER programs
listDERPrograms 2 params → 200
GET
/derp/{derpId}
Get a DER program
getDERProgram 1 param → 200404
GET
/derp/{derpId}/derc
List DERControls for a DER program
listDERControls 1 param → 200
GET
/der
List Distributed Energy Resources
listDERs 2 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Link (1 property), Resource (1 property). Each schema is shown below with its type and property counts.

Resource
object
Base IEEE 2030.5 Resource type that all resources inherit from.
1 property
Link
object
Link to another resource in the IEEE 2030.5 graph.
1 property
DERList
DERProgramList
DERProgram
DERControlList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xcel-energy-der-api-openapi.yml Raw ↑

Other APIs Xcel Energy publishes across the network.

Xcel Energy ApplicationInformation API
Xcel Energy Authorization API
Xcel Energy Batch API
Xcel Energy Configuration API
Xcel Energy DemandResponse API
Xcel Energy DeviceCapability API
Xcel Energy DeviceInformation API
Xcel Energy DeviceStatus API
Xcel Energy ElectricPowerQualitySummary API
Xcel Energy ElectricPowerUsageSummary API
Xcel Energy EndDevice API
Xcel Energy FunctionSetAssignments API