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 UsagePoint API

Logical metered points that produce energy usage data for a service.

Xcel Energy UsagePoint 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 UsagePoint. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 10 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.

6 operations 6 paths 10 schemas 6 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 UsagePoint 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 6

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

UsagePoint 6

Logical metered points that produce energy usage data for a service.

GET
/Subscription/{subscriptionId}/UsagePoint
List UsagePoints for a subscription
listUsagePoints 5 params → 200401403
GET
/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
Retrieve a single UsagePoint
getUsagePoint 2 params → 200401404
GET
/upt
List read-only UsagePoints
listUsagePoints → 200
GET
/upt/{uptId}
Get a UsagePoint
getUsagePoint 1 param → 200404
GET
/upt/{uptId}/mr
List MeterReadings for a UsagePoint
listMeterReadings 1 param → 200
GET
/upt/{uptId}/mr/{mrId}/r
List Readings for a MeterReading
listReadings 4 params → 200

Schemas 10

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

Link
object
Link to another resource in the IEEE 2030.5 graph.
1 property
UsagePointFeed
UsagePoint_2
AtomFeed
object
Atom feed envelope used to wrap collections of ESPI resource entries.
5 properties
UsagePointList
UsagePoint
Resource
object
Base IEEE 2030.5 Resource type that all resources inherit from.
1 property
ReadingList
AtomEntry
object
Atom entry envelope used to wrap ESPI resource payloads.
6 properties
MeterReadingList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xcel-energy-usagepoint-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 DER 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