Build an OpenADR 3.0 VEN client that subscribes to programs, polls for events, and submits opt responses via the REST API

domain: openadr.org · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Register a client credential with the VTN's OAuth 2.0 authorization server (client_credentials grant); OpenADR 3.0 uses a RESTful API defined in the openadr3.yaml OpenAPI spec — all payloads are JSON, replacing the SOAP/XML of 2.0b.
  2. Call GET /programs to discover available demand response programs; parse the array of Program objects and store programID values for the programs your VEN participates in.
  3. Poll GET /events?programID={id} on a configurable interval (check VTN documentation for recommended polling frequency); process each Event object, which includes eventName, intervals (an array with dtstart, duration, and payloads), and priorities.
  4. For each active event, evaluate the payload against your DER's operating constraints; submit a POST /reports body with an oadrReport containing your baseline and actual consumption or curtailment telemetry if the program requires reporting.
  5. Submit an opt response via POST /subscriptions or by posting to the VTN's opt endpoint with an Opt object containing optType ('optIn' or 'optOut'), programID, eventID, and venID.
  6. Implement exponential backoff with jitter on polling; on HTTP 429 responses honor the Retry-After header if present, and log events with their intervals to a local store so that a temporary poll failure does not cause missed event processing.

Known gotchas

Related routes

Build an OpenADR 3.0 VEN client that subscribes to program events and submits usage reports
openadr.org · 5 steps · unrated
register a Virtual End Node (VEN) and subscribe to reports from a Virtual Top Node (VTN) using the OpenADR 3.0/3.1 REST API
openadr.org · 6 steps · unrated
Create and publish a demand response program and event as a VTN using the OpenADR 3.0 REST API.
openadr.org · 6 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans