How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenADR Alliance

OpenADR Alliance Vens API

The vens API from OpenADR Alliance — 4 operation(s) for vens.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenADR Alliance Vens API is one of 9 APIs that OpenADR Alliance publishes 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 vens. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.

This API exposes 10 operations across 4 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: http://localhost:8081/openadr3, http://localhost:8081/openadr3/3.0.1, https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0.

10 operations 4 paths 33 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
http://localhost:8081/openadr3
http://localhost:8081/openadr3/3.0.1
https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0
Authentication
OAuth 2.0, HTTP Bearer
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

OpenADR Alliance Vens API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 6 scopes. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • oAuth2ClientCredentials — Client credential flow.

Paths & Operations 10

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

vens 10
GET
/vens
search vens
searchVens 4 params → 200400403500
POST
/vens
create ven
createVen body → 201400403409500
GET
/vens/{venID}
search vens by ID
searchVenByID 1 param → 200400403500
PUT
/vens/{venID}
update ven
updateVen 1 param body → 200400403409500
DELETE
/vens/{venID}
delete ven
deleteVen 1 param → 200400403500
GET
/vens/{venID}/resources
search ven resources
searchVenResources 5 params → 200400403500
POST
/vens/{venID}/resources
create resource
createResource 1 param body → 201400403409500
GET
/vens/{venID}/resources/{resourceID}
search ven resources by ID
searchVenResourceByID 2 params → 200400403500
PUT
/vens/{venID}/resources/{resourceID}
update ven resource
updateVenResource 2 params body → 200400403409500
DELETE
/vens/{venID}/resources/{resourceID}
delete ven resource
deleteVenResource 2 params → 200400403500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ven_2 (8 properties), resource (8 properties), ven (8 properties), resource_2 (8 properties). Each schema is shown below with its type and property counts.

valuesMap
object
Represents one or more values associated with a type. E.g. a type of PRICE contains a single float value.
2 properties 2 required
ven
object
Ven represents a client with the ven role.
8 properties 1 required
dateTime
stringnull
datetime in ISO 8601 format
resource
object
A resource is an energy device or system subject to control by a VEN.
8 properties 1 required
problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
objectID
string
URL safe VTN assigned object ID.
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties 2 required
valuesMap_2
object
Represents one or more values associated with a type. E.g. a type of PRICE contains a single float value.
2 properties 2 required
ven_2
object
Ven represents a client with the ven role.
8 properties 1 required
dateTime_2
string
datetime in ISO 8601 format
resource_2
object
A resource is an energy device or system subject to control by a VEN.
8 properties 1 required
point_2
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties 2 required
valuesMap_3
object
Represents one or more values associated with a type. See enumerations in Definitions for defined string values, or use privately defined strings
2 properties 2 required
venRequest
target
string
User generated target string.
objectTypes
string
Types of objects addressable through API.
objectMetadata
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties 4 required
BlVenRequest
object
Business Logic provided representation of ven.
5 properties 3 required
point_3
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties 2 required
dateTime_3
string
datetime in RFC 3339 format
VenVenRequest
object
VEN provided representation of ven.
3 properties 2 required
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
ven_3
object
Server provided representation of ven
problem_2
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
valuesMap_4
object
Represents one or more values associated with a type. See enumerations in Definitions for defined string values, or use privately defined strings
2 properties 2 required
objectMetadata_2
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties 4 required
BlVenRequest_2
object
Business Logic provided representation of ven.
5 properties 3 required
point_4
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties 2 required
dateTime_4
string
datetime in RFC 3339 format
VenVenRequest_2
object
VEN provided representation of ven.
3 properties 2 required
ven_4
object
Server provided representation of ven
problem_3
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openadr-alliance-vens-api-openapi.yml Raw ↑

Other APIs OpenADR Alliance publishes across the network.

OpenADR Alliance Auth API
AE Profile APIs.io
OpenADR Alliance Events API
AE Profile APIs.io
OpenADR Alliance MQTT Notifier API
AE Profile APIs.io
OpenADR Alliance Notifiers API
AE Profile APIs.io
OpenADR Alliance Programs API
AE Profile APIs.io
OpenADR Alliance Reports API
AE Profile APIs.io
OpenADR Alliance Resources API
AE Profile APIs.io
OpenADR Alliance Subscriptions API
AE Profile APIs.io
#vens
← Back to O APIs
API Details
ID
openadr-alliance:openadr-alliance-vens-api
Server
http://localhost:8081/openadr3
Docs
https://www.openadr.org/specification
Provider
OpenADR Alliance
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openadr-alliance-vens-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openadr-alliance-vens-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Alliance Vens 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.