External API Integration
Which API should you use? This guide is for zone admins — accounts scoped to a single zone or property. It pairs with the Zone Admin API Reference. If you are a system admin with full-system access, follow the System Admin integration guide and use the System Admin API Reference instead.
Introduction
Ecovolt lets you connect your own applications to your zone's data using a simple API key–based workflow. As a zone admin your key is scoped to the zone (or zones) you manage, so every request you make returns only the data you are authorized to see.
This guide explains how to obtain your API key, how to include it in your requests, and how to find the resource IDs you need to call zone- and room-level endpoints.
Using Ecovolt authentication, you can:
- Authenticate API requests with a single secure API key
- Retrieve energy usage and device data for your zone and its rooms
- Integrate quickly using standard HTTP headers and lightweight request formats
Before You Begin
- Ecovolt account with zone admin access. The access your key grants matches your account's scope.
- Access to the Ecovolt dashboard to generate and manage your API keys.
- Basic knowledge of HTTP requests (headers, methods, response formats) using tools such as Postman or your preferred language.
Getting Your API Key
Follow these steps to obtain an API key:
Step 1: Sign in to the Ecovolt dashboard
Go to the Ecovolt dashboard and sign in with your Ecovolt account credentials.
Step 2: Navigate to API Keys
In the dashboard menu, select External Integration > Manage API Keys.
Step 3: Generate a new API key
Click Generate API Key. Your key inherits your zone admin scope.
Step 4: Save your API key securely
Copy the key immediately — you will not be able to view it again for security reasons. Store it in an environment variable or a secret management system.
Making Your First Authenticated Request
Include your API key in the x-api-key header of every request.
Base URL
All Ecovolt API requests use the following base URL:
Code
Example Request
Code
Finding Resource IDs
Zone admin endpoints are scoped to a zone and the rooms inside it. (Tenant-level access is reserved for system admins, so there is no tenant ID at this level.) You may also need your system ID for system-scoped device endpoints.
There are two reliable ways to find any of these IDs.
1. From the dashboard URL (quickest)
Open the resource in the Ecovolt dashboard and read the ID from the page URL:
- System ID — shown when you view your system.
- Zone ID — open your zone.
- Room ID — open a room inside your zone.
2. From an API response
IDs are also embedded in the objects the API returns:
- A plug (or other device) response includes the
zoneandroomit belongs to.
Once you have the relevant ID, pass it as the path parameter — for example, hourly usage for a single room:
Code
Explore More Endpoints
Use the Zone Admin API Reference to explore every endpoint available to your account, including required parameters, request headers, example responses, and notes on scopes and error handling.