OpenADR 3 is the RESTful third generation of the OpenADR protocol, defined in full by a single OpenAPI 3.0 document published by the OpenADR Alliance. It supports energy-retailer-to-energy-customer demand response programs through operations to create, update, delete, and search programs, events, reports, subscriptions, VENs (Virtual End Nodes), and VEN resources, plus an /auth/token endpoint. Version 3.1.0 adds MQTT notifier topics, VEN-scoped topics for object privacy, and VTN discovery. Security is OAuth 2.0 client credentials with JWT bearer tokens and role-scoped grants that separate what a Business Logic (BL/VTN) client may write from what a VEN may write. This is a protocol contract, not an Alliance-hosted service — every implementer (a utility, aggregator, or vendor VTN) stands up its own base URL, so no single baseURL exists. The specification documents themselves are distributed by the Alliance through a registration form; the OpenAPI files harvested here came from a public Apache-2.0 copy of the Alliance release.
OpenADR 3 API is published by OpenADR Alliance on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Demand Response, OpenADR, Energy, and DER. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.
This API exposes
45 operations
across 27 paths,
organized into 9 resource areas,
and defines 48 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0.
45 operations27 paths48 schemas6 DELETE26 GET7 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
OpenADR 3 API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 9 scopes.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
oAuth2ClientCredentials — Client credential flow.
Paths & Operations 45
Across 27 paths, the API surfaces 45 operations — 6 DELETE, 26 GET, 7 POST, 6 PUT. They span 9 resource areas: programs, reports, events, subscriptions, vens, resources, Auth, notifiers, MQTT_notifier. Each is listed below with its method, path, parameters, and response codes.
The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are reportDescriptor (11 properties), eventRequest (9 properties), reportPayloadDescriptor (6 properties), programRequest (6 properties). Each schema is shown below with its type and property counts.
program
object
Server provided representation of program
programRequest
object
Client provided description of program
6 properties1 required
report
object
Server provided representation of report
reportRequest
object
report object.
5 properties3 required
event
object
Server provided representation of event
eventRequest
object
Event object to communicate a Demand Response request to VEN. If intervalPeriod is present, sets default start time and duration of intervals.
9 properties1 required
subscription
object
Server provided representation of subscription
subscriptionRequest
object
An object created by a client to receive notification of operations on objects. Clients may subscribe to be notified when a type of object is created, updated,…
4 properties2 required
ven
object
Server provided representation of ven
venRequest
BlVenRequest
object
Business Logic provided representation of ven.
5 properties3 required
VenVenRequest
object
VEN provided representation of ven.
3 properties2 required
resource
object
Server provided representation of resource
resourceRequest
BlResourceRequest
object
Business Logic provided representation of ven resource.
5 properties3 required
VenResourceRequest
object
Business Logic provided representation of ven resource.
3 properties2 required
objectMetadata
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties4 required
interval
object
An object defining a temporal window and a list of valuesMaps. if intervalPeriod present may set temporal aspects of interval or override event.intervalPeriod.
3 properties2 required
intervalPeriod
object
Defines temporal aspects of intervals. A start of "0001-01-01" or "0001-01-01T00:00:00" may indicate 'now'. See User Guide. A duration of "P9999Y" may indicate…
3 properties
valuesMap
object
Represents one or more values associated with a type. See enumerations in Definitions for defined string values, or use privately defined strings
2 properties2 required
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties2 required
eventPayloadDescriptor
object
Contextual information used to interpret event valuesMap values. E.g. a PRICE payload simply contains a price value, an associated descriptor provides necessar…
4 properties2 required
reportPayloadDescriptor
object
Contextual information used to interpret report payload values. E.g. a USAGE payload simply contains a usage value, an associated descriptor provides necessary…
6 properties2 required
reportDescriptor
object
An object that may be used to request a report from a VEN.
11 properties1 required
objectID
string
URL safe VTN assigned object ID.
clientID
string
ClientID as provisioned by Auhtentication Service and associated with client's bearer token
venName
string
User generated identifier, may be VEN identifier provisioned out-of-band. venName is expected to be unique within the scope of a VTN
clientName
string
User generated identifier, may be VEN identifier provisioned out-of-band.
target
string
User generated target string.
resourceName
string
User generated identifier. A value of AGGREGATEDREPORT indicates an aggregation of more that one resource's data
units
string
Units of measure.
readingType
string
Represents the type of reading. See enumerations in Definitions for defined string values, or use privately defined strings
notification
object
VTN generated object included in request to subscription callbackUrl.
4 properties3 required
objectTypes
string
Types of objects addressable through API.
dateTime
string
datetime in RFC 3339 format
duration
string
duration in ISO 8601 format
clientCredentialRequest
object
Body of POST request to /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
4 properties3 required
clientCredentialResponse
object
Body response from /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
5 properties2 required
authError
object
error response on HTTP 400 from auth/token per https://www.rfc-editor.org/rfc/rfc6749
3 properties1 required
authServerInfo
object
1 property1 required
problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
notifiersResponse
object
Provides details of each notifier binding supported
2 properties1 required
mqttNotifierBindingObject
object
Details of MQTT binding for messaging protocol support
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of OpenADR 3 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.
