Smartmaster API

Overview

Smartmaster’s REST APIs let you read live and aggregated energy data, configure assets, and activate smart services across your portfolio—without depending on our UI. Integrate directly with Smartmaster Home, Smartmaster Pro, and Smartbirds installations to build your own apps, dashboards, and automations.

What you get

• Live data (minute-level) for fast feedback loops and operational views.
• Aggregated data (15-min, hourly, daily, monthly) for analytics and reporting.
• Device & asset control to apply limits and update configurations.
• Service activation to enable optimization features programmatically.  

 

Access & security 

API access is managed via environment-scoped API keys, keeping client data isolated by environment.  

 

Core objects in the Smartmaster ecosystem

Below is the canonical glossary of objects you’ll encounter in endpoints and responses. It’s intentionally product-level and implementation-agnostic so you can map it to your data model quickly. 

Environment 

A logical boundary for deployments (e.g., sandbox vs. production). API keys are issued per environment, isolating data and operations. Used in base URLs and authentication scope.  

Client 

An organization (utility, installer, partner, or enterprise) that owns sites, devices, users, and services. Used for tenancy, permissions, and billing contexts.  

 

Site

A physical location (home, building, depot, solar park) where Smartmaster manages energy flows. A site has a topology, contains devices and assets, and produces time-series data. Multiple Smartmaster units can serve a single complex site.  

 

Topology

The graph describing how meters, inverters, batteries, EV chargers and other assets are connected on a site. Topology can be updated post-commissioning by adding/removing devices and syncing the configuration.  

 

Device

A controllable hardware or gateway that communicates with Smartmaster. Includes:

• Smartmaster Pro (business-grade controller)
• Smartmaster Home (residential controller)
• Smartbirds (smart-meter dongle)

Devices expose measurements, status and control points.

 

Asset

A logical/physical energy component managed at a site, typically behind a device. Common asset types:

• Grid meter / sub-meter
• PV inverter / plant
• Battery energy storage (with SoC)
• EV charger / charging point
• Flexible loads (e.g., heat pump)
• Assets define capabilities (readings, setpoints, limits) and are the primary source of energy data.

Third-party equipment reachable via supported protocols/templates. See our compatibility list.

 

Measurement (Live Data)

Minute-level telemetry captured per asset/device (power, current, voltage, temperatures, status, SoC, etc.). Optimized for operational views and quick decisions.

 

Timeseries (Aggregated Data)

Rollups of measurements into predefined windows (15-min, hourly, daily, monthly) to simplify storage, visualization, and analytics. Ideal for dashboards and reports.

 

Configuration

The set of parameters describing assets and site behavior (tariffs, control limits, PV/battery characteristics, etc.). Changes require synchronization to take effect on the controller.

 

Control Limit

A constraint applied to an asset or site (e.g., charge/discharge rates, export caps, site power ceiling). Used by optimization services to remain within grid and contractual limits.  

 

Tariff / Dynamic Tariff

Pricing models (fixed or time-varying) used by services to optimize schedules (e.g., EV charging, battery charge windows). Configurable at site or asset level.

 

Service

Cloud-based optimization features (e.g., solar curtailment, EV load shifting, battery scheduling). Services can be activated per device/asset; they exchange data with the device and provide service-level outputs via the API.

 

Status

Operational state of a device or asset (online/offline, healthy/faulted, active/idle). Often paired with last-seen timestamps to assess connectivity and data freshness.

 

Event / Alert

Time-stamped notifications about significant conditions (offline devices, configuration mismatches, constraint breaches). Useful for monitoring and incident workflows.

 

User

An authenticated human operator with scoped access to clients and sites via the portal or API. Permissions govern read/write operations and data export.

 

API Key

A credential tied to an environment and often a client or integration. Required in request headers to authenticate and authorize API calls.

 

Protocol / Template

Support packages enabling Smartmaster to talk to third-party assets. New templates are added continuously; bespoke integrations are possible on request.

 

Typical data flows

1. Ingest — Devices stream live measurements per asset.
2. Aggregate — The platform derives timeseries windows for analytics.
3. Optimize — Services use topology, tariffs, and control limits to compute actions.
4. Act — Commands/limits are applied to devices/assets; status/events confirm outcomes.