This reference provides a comprehensive overview of the Enode API endpoints for accessing and controlling its hardware and features. The API follows REST principles, and uses OAuth 2.0.
This page features detailed documentation for each of our endpoints. You can also explore our API through our updated OpenAPI specifications or Postman collection.
The API is versioned, and all documentation on this page, including the links to the OpenAPI specifications and Postman collection is specific to the selected version.
Environments
We provide multiple environments, each with unique data access policies, and live/mocked vendors.
Environments are isolated from each other. Client credentials are tied to a specific environment and cannot be reused across environments.
Enode API access begins with a client and its corresponding client ID and client secret. Clients organize data, are separate, and relate to a specific environmentAPI.
After requesting the token URL, you'll receive an access token in the response. Cache this token on your server until it expires and needs refreshingAPI. Keep the access token secret.
For resources specific to a user, include an additional header with the user ID along with the general authorization header. For versions newer than 2023-08-01, this is no longer required.
Enode resources like Schedules and Locations have response times of <200ms. However, vehicle interactions involve various delays and timing characteristics.
Understanding the range of possible timings without diving into vendor-specific causes, helps you account for these factors in your UX design.
Get Vehicles and List Vehicles are fast operations since all data is prefetched by Enode and shared from a cache.
On API versions prior to 2023-08-01 it is possible to request a synchronous update where data is fetched directly from the vendor. Such requests have longer response times, sometimes 30 seconds or more, depending on the characteristics of the underlying vendor APIs. From 2023-08-01 onwards this has been replaced by the refresh hintAPI mechanism.
The Login step usually takes <2 seconds, but can rarely take up to 30 seconds due to background negotiations, retries, and initial vehicle data fetching.
The final Accept step experiences similar delays as List Vehicles.
Charging commands show significant timing variability among vendors. Initiating the action is instant, but the updated charging state typically takes 20 seconds to appear. Occasionally the action may take 5 minutes or more to confirm.
Webhooks typically involve polling and dynamically adjust the polling rate based on various factors to balance prompt updates with avoiding unnecessary load on the vehicle.
The maximum baseline delay between a real-world change (e.g., a vehicle being plugged in) and the resulting webhook notification is typically 7 minutes. However, actual delays can vary depending on factors such as vehicle activity and network conditions. Below is a general guide for typical webhook delays:
Vehicle context
Typical delay
default
~7 minutes
charging
~2-5 minutes
smartcharge PLAN:*
~2 minutes
sleeping
~20 minutes
If you'd like to request a faster refresh, you can call the various /refresh-hint endpoints found on devices to queue an accelerated data refresh.
Scopes
Access to the data and controls of a device are scoped by an inclusive scopes structure. The scopes are requested in the Link user endpoint via the scopes parameter. Scopes are presented to your user in Link UI, and explained through example data and examples of features enabled by each scope. Your user is not able to de-select or configure scopes themselves in Link UI.
Data scopes include all data and states we fetch from the device, excluding location data, and is always required (e.g vehicle:read:data)
Location scopes include the location coordinates of the device (e.g. vehicle:read:location)
Control scopes are always explicit to the type of control that is requested (e.g. vehicle:control:charging)
The applied scopes are surfaced through the scopes object in device responses (see example below).
Reads the battery data, such as the charge state, configuration and general information
Charger
charger:control:charging
Controls the charging of the charger, including start/stop, setting max current, and setting a charge rate limit
charger:read:data
Reads the charger data, such as the charge state and general information
HVAC
hvac:control:mode
Controls the mode (permanent hold or follow schedule) of the HVAC unit
hvac:read:data
Reads the HVAC data, such as the information, thermostat state and temperature state
Inverter
inverter:control:power_limit
Controls the power limits of an inverter. This is an early adopter feature - reach out to your customer success manager if you are interested in participating.
inverter:read:data
Reads the inverter data, such as the production state and general information
inverter:read:location
Reads the GPS coordinates of the inverter
Meter
meter:read:location
Reads the GPS coordinates of the meter
meter:read:data
Reads the meter data, such as energy state and general information
Vehicle
vehicle:control:charging
Controls the charging of the vehicle
vehicle:read:data
Reads the vehicle data, such as charge state, odometer and general information
Copy linkThe relationship between scopes and capabilities
If a device is missing a scope, e.g. a charger that does not have the charger:control:charging scope set, will always have the charging related capabilities will always be set as isCapable: false with no intervention specified.
Some part of the request was malformed. See associated detail message for more information.
Enode Controlled Entity
This entity is currently managed by Smart Charging or Schedules and cannot accept manual commands. Either disable the feature controlling the target, or force charging to start through our External Start APIAPI.
Entity Not Found
The requested entity was not found on the user's account.
Forbidden
The current context is not allowed to access the requested resource.
Not Found
The requested entity was not found on the user's account. If requesting vendor entities, ensure you're using the top level id field and not information.id. information.id is the ID the vendor uses to refer to the entity and changes over time.
Server Error
A critical error has occurred. An employee has been alerted and will work to remedy the situation
Service Unavailable
The service is currently unavailable. Most likely the service was slow to respond, might be overloaded or down for maintenance. Other endpoints might still be available.
You may want to retry the request using a randomized backoff delay.
Check the Enode Status page if this problem persists.
Timeout
A request timed out. If this problem was returned by a route that tried to communicate with vendor APIs, remove the fields query parameter to fetch the Enode hosted cache. This cache is updated every 10 minutes.
Unauthorized
The request contained an invalid or expired token.
Validation Error
The response we prepared failed to pass outgoing validation. An employee has been alerted and will work to remedy the situation.
Versioning
Enode's REST API is versioned. A dated version is released when breaking changes occur, while new features and bug fixes (additive changes) are available in all supported API versions.
You can view all available versions and updates in the changelog.
API clients are pinned to the latest API version upon creation, affecting all API requests and webhook events. API responses include an Enode-Version header, and webhook events have a version field.
You can override the API version on a specific request by sending an Enode-Version in the request header.
Breaking changes will be released as a new version. When a new version is released, the previous version is supported for six months before deactivation. Enode staff will notify you in advance. Each API version comes with a migration guide explaining changes and upgrade suggestions.
We consider the following breaking changes
Changing a request’s authorization or authentication requirements
Adding a new required input parameter
Changing input validation
Removing an HTTP route or method
Removing or renaming a response parameter
All other additive changes are considered backwards compatible.
This is the latest API version, recommended for all customers.
It is the default version for new clients and the default version documented in our API Reference.
There is only ever one Current API version.
Deprecated
This version has been superseded by a newer version. Multiple Deprecated versions can exist.
Customers can still choose this version for new clients or webhook subscriptions at developers.enode.com.
Documentation will be marked as Deprecated.
New functionality may not be released to Deprecated versions and supported exclusively on the Current API version.
We recommend you to upgrade to the Current version as soon as possible.
Legacy
This version has been deprecated for 6 months. Multiple Legacy versions can exist.
Customers cannot select this version for new clients or webhook subscriptions.
Documentation will not be accessible from the API Reference. You can review Legacy documentation by logging in to your organization dashboard and selecting a client with a Legacy version.
Functionality may be degraded, and no new features will be added.
4 weeks after entering Legacy status, we will begin preparations for automatically upgrading clients on this version. Enode will conduct API brownouts for clients still using Legacy versions at this time. During these brownouts, we will randomly reject API requests using the Legacy API version.
8 weeks after entering Legacy status, clients and webhooks using this version will be automatically upgraded to the Current API version.
This product or endpoint is now feature complete and the implementation will not change. There may be bugs or stability issues but they are actively being worked on. We are still open to receiving feedback before delivering a stable release.
Individual features, endpoints, or fields tagged as Deprecated will be removed in a future version of the API. If you are using deprecated functionality you should update your application to use alternative features or methods we provide.
Pagination
Enode endpoints returning collections of a specific type of resource, such as GET /vehicles, will return a paginated response. Each response will consist of a subset of the resources, called a page. To retrieve the entire collection, subsequent pages need to be fetched.
Each response includes two properties: data and pagination. The data property contains the records of the current page and the pagination property contains cursors that can be used to fetch additional pages. These cursors, before and after, are unique identifiers for specific records in the dataset that help you keep track of your position and navigate through the pages.
All of these pagination query parameters are optional. If pageSize is not provided, the default page size of 50 is used. If neither before nor after are provided, the returned page will contain the first set of resources in the collection.
The before and after parameters are mutually exclusive. If both are supplied, the API will return an error.
Responses from most paginated endpoints are sorted in descending order according to when the resource was created. Hence, for a request like GET /vehicles, the most recently linked vehicles appear on the first page.
Copy linkHow to navigate through paginated API responses
The pagination property in a paginated response typically looks like this:
In this example, the data array includes the resource records for the current page. The pagination object provides the cursors for navigating to adjacent pages.
Images
Enode provides product images for vehicles and other assets. Image URLs are returned in the imageUrl field of API responses, such as GET /vehicles/{vehicleId} and webhook payloads.
Images are served through a global CDN with on-the-fly transformations including resizing, format conversion, and quality adjustment.
Images are served with long-lived cache headers. Transformed images are cached on the CDN, so subsequent requests for the same transformation are served directly from cache.
User management
Endpoints used to link and unlink users or vendors.
Whether the provided credentials are currently valid. A false value here indicates that a credential has become invalidated, and Link UserAPI should be used to get new credentials from this user.
Unlink user
DELETE /users/{userId}
Deletes a User and all of their data permanently and invalidates any associated sessions, authorization codes, and access/refresh tokens.
Disconnect a specific vendor type from the User's account. Assets of this type from that Vendor will be removed. If no other types from that vendor remain, all its stored data will be deleted.
Creates a short-lived (24 hours), single-use device linking session. Use the returned linkUrl to present Link UI to your user via mobile in-app browsers or web redirects, or use the linkToken to present Link UI via the Link SDKs.
A unique identifier of your choice representing your user, e.g. a stable UUID you keep in your datastore. If a user entity matching the provided userId does not exist in your client, it will be created before the link session is created.
The scope(s) you wish to request access to when linking an asset (learn more). The scopes will be presented for user consent in Link UI in the review data access step. The <assetType>:read:data scope is required for any asset type (e.g. if you wish to link a battery, you must request battery:read:data).
Sets the language for Link UI. We recommend matching this to the language of your application. If your language is not yet supported, you can specify browser which will assess your user's browser language via the Accept-Language header (learn more). Passing in browser will fall back to en-US if no match is found.
The URI your user will be redirected to after clicking "Complete" at the linking flow (from the last step in the Link UI flow). Only used in Link UI sessions that were not opened via the Link SDKs.
Sets the color scheme (light or dark) of Link UI. If your UI is only available in one of the color schemes, and does not follow the operating system color scheme, we recommend setting either light or dark. Defaults to system, which follows the users operating system settings.
A list of validation issues which occurred while validating some component of the network payload.
Show child attributes
Relink asset
POST /assets/{assetId}/relink
Creates a short-lived (24 hours), single-use device linking session specifically tailored for relinking. See our relinking guide for more details. Use the returned linkUrl to present Link UI to your user via mobile in-app browsers or web redirects, or use the linkToken to present Link UI via the Link SDKs.
Sets the language for Link UI. We recommend matching this to the language of your application. If your language is not yet supported, you can specify browser which will assess your user's browser language via the Accept-Language header (learn more). Passing in browser will fall back to en-US if no match is found.
The URI your user will be redirected to after clicking "Complete" at the linking flow (from the last step in the Link UI flow). Only used in Link UI sessions that were not opened via the Link SDKs.
Sets the color scheme (light or dark) of Link UI. If your UI is only available in one of the color schemes, and does not follow the operating system color scheme, we recommend setting either light or dark. Defaults to system, which follows the users operating system settings.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].chargeState.batteryLevelnumber or null
Copy linkdata[].chargeState.isPluggedInboolean or null
Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)
Copy linkdata[].chargeState.isChargingboolean or null
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkdata[].chargeState.isFullyChargedboolean or null
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkdata[].chargeState.batteryCapacitynumber or null
Vehicle's usable battery capacity in kWh.
Copy linkdata[].chargeState.chargeLimitnumber or null
Charge limit, as a percent of batteryCapacity.
When null, the vendor did not report a charge limit when we last received data from them. We recommend assuming the limit is 100%.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkdata[].chargeState.chargeTimeRemainingnumber or null
Estimated time until the current charging intent is completed, in minutes.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Time of last received charge state update
Copy linkdata[].chargeState.maxCurrentnumber or nullDeprecated
Deprecated: Use chargeRateLimit instead.
The maximum current that the vehicle can draw from the charger, in amps.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linkdata[].smartChargingPolicy.deadlinestring or null
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.location.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.odometer.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.smartCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.refreshState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].chargeState.batteryLevelnumber or null
Copy linkdata[].chargeState.isPluggedInboolean or null
Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)
Copy linkdata[].chargeState.isChargingboolean or null
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkdata[].chargeState.isFullyChargedboolean or null
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkdata[].chargeState.batteryCapacitynumber or null
Vehicle's usable battery capacity in kWh.
Copy linkdata[].chargeState.chargeLimitnumber or null
Charge limit, as a percent of batteryCapacity.
When null, the vendor did not report a charge limit when we last received data from them. We recommend assuming the limit is 100%.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkdata[].chargeState.chargeTimeRemainingnumber or null
Estimated time until the current charging intent is completed, in minutes.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Time of last received charge state update
Copy linkdata[].chargeState.maxCurrentnumber or nullDeprecated
Deprecated: Use chargeRateLimit instead.
The maximum current that the vehicle can draw from the charger, in amps.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linkdata[].smartChargingPolicy.deadlinestring or null
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.location.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.odometer.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.smartCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.refreshState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkchargeState.isFullyChargedboolean or null
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkchargeState.batteryCapacitynumber or null
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linksmartChargingPolicy.deadlinestring or null
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.location.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.odometer.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.smartCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.refreshState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Set the max current the vehicle is allowed to consume during charging. Currently only supported for Tesla vehicles and behind a feature flag. Reach out to Customer Success to get access.
This request creates an Action that will retry until the vehicle's maxCurrent matches the expected value. The Action must complete before any further commands are sent to the vehicle. Only one Action can be active for a specific vehicle at a time. If a new Action is created, the previous Action will be automatically cancelled and transitioned to the CANCELLED state. Transitions can be tracked via the user:vendor-action:updated webhook event or Get Vehicle ActionAPI.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A list of validation issues which occurred while validating some component of the network payload.
Show child attributes
Set charge rate limitEarly Adopter
POST /vehicles/{vehicleId}/charge-rate-limit
Sets the charge rate limit for a vehicle in kW. The vehicle must be plugged into a charger that supports this capability. Creates an Action that retries until the vehicle's chargeRateLimit matches the target value. Setting chargeRateLimit also changes maxCurrent.
Only one Action can be active for a specific vehicle at a time. If a new Action is created, the previous Action will be automatically cancelled and transitioned to the CANCELLED state. Track transitions via the user:vendor-action:updated webhook event or Get Vehicle ActionAPI.
If you are interested in joining the Early Adopter program, please reach out to Enode with a short description of your use case.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
Cancels a pending vehicle action, halting any further attempts by Enode to execute it.
Note: This only updates the action's status to CANCELLED within Enode and does not reflect a change in the vendor's cloud. Thus any pending action in the vendor's cloud might still be executed.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A human-readable explanation of why the action was unsuccessful.
Refresh vehicle data
POST /vehicles/{vehicleId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified vehicle.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].chargeState.isPluggedInboolean or null
Indicates whether the charger has a vehicle plugged into it (regardless of whether that vehicle is actually charging)
Copy linkdata[].chargeState.isChargingboolean or null
Indicates whether the charger is currently delivering power to the vehicle and actively charging its battery.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW.
This property is only available when the charger is actively charging a vehicle, and is null any other time.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Time of latest charge state update
Copy linkdata[].chargeState.maxCurrentnumber or nullDeprecated
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Copy linkdata[].information.imageUrlstring or null
URL to an image of the charger model. null when not available.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].chargeState.isPluggedInboolean or null
Indicates whether the charger has a vehicle plugged into it (regardless of whether that vehicle is actually charging)
Copy linkdata[].chargeState.isChargingboolean or null
Indicates whether the charger is currently delivering power to the vehicle and actively charging its battery.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW.
This property is only available when the charger is actively charging a vehicle, and is null any other time.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Time of latest charge state update
Copy linkdata[].chargeState.maxCurrentnumber or nullDeprecated
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Copy linkdata[].information.imageUrlstring or null
URL to an image of the charger model. null when not available.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.information.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.chargeState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.startCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.stopCharging.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setMaxCurrent.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setChargeRateLimit.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Register for a change of the maxCurrent field on a charger. This request creates an Action that will retry until the charger's maxCurrent matches the expected value. The Action must complete before any further commands are sent to the charger. Only one Action can be active for a specific charger at a time. If a new Action is created, the previous Action will be automatically cancelled and transitioned to the CANCELLED state. Transitions can be tracked via the user:vendor-action:updated webhook event or Get Charger ActionAPI.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A list of validation issues which occurred while validating some component of the network payload.
Show child attributes
Set charge rate limitBeta
POST /chargers/{chargerId}/charge-rate-limit
Sets the charge rate limit for a charger in kW. Creates an Action that retries until the charger's chargeRateLimit matches the target value. Setting chargeRateLimit also changes maxCurrent.
Only one Action can be active per charger - creating a new one cancels the previous action (state: CANCELLED). The Action must complete before sending further commands. Track transitions via the user:vendor-action:updated webhook or Get Charger ActionAPI.
We recommend updating this setting no more than once every 15 minutes. Frequent changes to the charge rate limit may cause the vehicle to interrupt the charging session.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
Cancels a pending Action, halting any further attempts by Enode to execute it.
Note: This only updates the Action's status to CANCELLED within Enode and does not reflect a change in the vendor's cloud. Thus any pending Action in the vendor's cloud might still be executed.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A human-readable explanation of why the action was unsuccessful.
Refresh charger data
POST /chargers/{chargerId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified charger.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
The Battery object represents a residential energy storage unit, like a Tesla Powerwall or Enphase IQ. It offers detailed insights into the battery's operation and allows you to instruct the battery on handling its stored energy.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Copy linkdata[].chargeState.batteryCapacitynumber or null
Battery capacity in kWh.
Copy linkdata[].chargeState.batteryLevelnumber or null
Remaining battery charge level in percent.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW. A positive value indicates that the battery is charging.
Copy linkdata[].chargeState.dischargeLimitnumber or null
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Copy linkdata[].config.operationModestring or null
The current operation mode of the battery.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.exportFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.importFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.timeOfUse.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.selfReliance.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.idle.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Copy linkdata[].chargeState.batteryCapacitynumber or null
Battery capacity in kWh.
Copy linkdata[].chargeState.batteryLevelnumber or null
Remaining battery charge level in percent.
Copy linkdata[].chargeState.chargeRatenumber or null
The current charge rate in kW. A positive value indicates that the battery is charging.
Copy linkdata[].chargeState.dischargeLimitnumber or null
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkdata[].chargeState.lastUpdatedstring<date-time> or null
Copy linkdata[].config.operationModestring or null
The current operation mode of the battery.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.exportFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.importFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.timeOfUse.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.selfReliance.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.idle.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkchargeState.lastUpdatedstring<date-time> or null
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.exportFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.importFocus.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.timeOfUse.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.selfReliance.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.idle.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Set operation mode for batteryBeta
POST /batteries/{batteryId}/operation-mode
Request an operationMode change for a battery. This request creates an Action that will retry until the battery's operationMode matches the expected value. The Action must complete before any further commands can be sent to the battery. Only one Action can be active for a specific battery at a time. If a new Action is created, the previous Action will be automatically cancelled and transitioned to the CANCELLED state. Regardless of operation mode, the battery's charge limit will not fall below dischargeLimit except in emergency power situations. Transitions can be tracked via the user:vendor-action:updated webhook event or Get Operation Mode ActionAPI.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
Cancels a pending battery Action, halting any further attempts by Enode to execute it.
Note: This only updates the Action's status to CANCELLED within Enode and does not reflect a change in the vendor's cloud. Thus any pending Action in the vendor's cloud might still be executed.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
The real-time status of an action executed on a target.
CONFIRMED: Successful transition of the target to the desired state.
FAILED: The target did not respond to the action before timing out. Enode has ceased sending additional commands.
CANCELLED: A required precondition was not met during the action's timeout window or another action has been sent to the target, overriding this one.
Possible enum values:
CONFIRMEDFAILEDCANCELLED
Refresh battery dataBeta
POST /batteries/{batteryId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified battery.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
HVAC units (heaters, heat pumps, air conditioning, thermostats, etc.) are controlled by altering the mode & target setpoints. This can be done directly using the Set Permanent HoldAPI endpoint or Return to ScheduleAPI.
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkdata[].information.groupNamestring or null
Name of the group the device belongs to, as set by the user on the device/vendor. Groups are typically presented as "rooms" or "zones".
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].temperatureState.currentTemperaturenumber or null
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setFollowSchedule.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setPermanentHold.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkdata[].information.groupNamestring or null
Name of the group the device belongs to, as set by the user on the device/vendor. Groups are typically presented as "rooms" or "zones".
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].temperatureState.currentTemperaturenumber or null
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setFollowSchedule.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.setPermanentHold.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linktemperatureState.currentTemperaturenumber or null
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setFollowSchedule.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setPermanentHold.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linktemperatureState.currentTemperaturenumber or null
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setFollowSchedule.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.setPermanentHold.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
Cancels a pending HVAC action, halting any further attempts by Enode to execute it.
Note: This only updates the action's status to CANCELLED within Enode and does not reflect a change in the vendor's cloud. Thus any pending action in the vendor's cloud might still be executed.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A human-readable explanation of why the action was unsuccessful.
Set HVAC unit to follow device schedule
POST /hvacs/{hvacId}/follow-schedule
Tell an HVAC unit to follow the schedule set on the device. Only available if the target's capabilities.setFollowSchedule.isCapable is set to true. This endpoint can be used to cancel permanent holds. We retry sending the command until the HVAC unit's fields transition to the expected values. Note that this request will complete before any commands are sent to the HVAC unit. You may react to transitions by listening for the user:vendor-action:updated webhook event or polling the HVAC action endpointAPI.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A list of validation issues which occurred while validating some component of the network payload.
Show child attributes
Refresh HVAC unit data
POST /hvacs/{hvacId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified HVAC unit.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
Tell an HVAC unit to enter a permanent hold. Only available if the target's capabilities.setPermanentHold.isCapable is set to true. We retry sending the command until the HVAC unit's target field transition to the expected value. Note that this request will complete before any commands are sent to the HVAC unit. You may react to transitions by listening for the user:vendor-action:updated webhook event or polling the HVAC action endpointAPI.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the HVAC unit cannot perform the action or the setpoints are invalid.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].productionState.productionRatenumber or null
The current production rate in kW.
Copy linkdata[].productionState.isProducingboolean or null
Whether the solar inverter is actively producing energy or not.
Copy linkdata[].productionState.totalLifetimeProductionnumber or null
The total lifetime production in kWh.
Copy linkdata[].productionState.lastUpdatedstring<date-time> or null
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.productionState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.productionStatistics.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkdata[].productionState.productionRatenumber or null
The current production rate in kW.
Copy linkdata[].productionState.isProducingboolean or null
Whether the solar inverter is actively producing energy or not.
Copy linkdata[].productionState.totalLifetimeProductionnumber or null
The total lifetime production in kWh.
Copy linkdata[].productionState.lastUpdatedstring<date-time> or null
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.productionState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.productionStatistics.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkproductionState.productionRatenumber or null
The current production rate in kW.
Copy linkproductionState.isProducingboolean or null
Whether the solar inverter is actively producing energy or not.
Copy linkproductionState.totalLifetimeProductionnumber or null
The total lifetime production in kWh.
Copy linkproductionState.lastUpdatedstring<date-time> or null
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.productionState.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.productionStatistics.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Refresh inverter data
POST /inverters/{inverterId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified inverter.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
The Meter object represents a unit responsible for measuring energy usage. It provides detailed information about the meter itself and the energy consumption data it records.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.measuresConsumption.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcapabilities.measuresProduction.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Refresh meter dataBeta
POST /meters/{meterId}/refresh-hint
Use this endpoint to initiate an expedited data refresh for the specified meter.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.measuresConsumption.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.measuresProduction.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.measuresConsumption.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkdata[].capabilities.measuresProduction.interventionIdsarray of string
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
HEM Systems (Home Energy Management Systems) track flows between various assets such as solar inverters, batteries, and meters. They provide information and status details for the system and also support historical metrics through statistics for solar generation, household consumption, grid import/export, battery levels, and charge/discharge. Refer to the Guide for details on how to enable this functionality on your account.
Use this endpoint to initiate an expedited data refresh for the specified HEM System.
Note: The Enode platform keeps data automatically up-to-date and detects changes in the OEM APIs within seconds to a few minutes. We change the refresh interval dynamically based on a number of heuristics. This ensures we find the best trade-off between the stability of the connection to the OEM and freshness of the data. This method overrides most of our heuristics and should therefore be used with caution. You may use it when you have a strong reason to believe the data might be stale.
Returns time-bucketed metrics for a specific HEM System, including solar generation, household consumption, grid import/export, battery level, and charge/discharge.
The endpoint supports querying by DAY (YYYY-MM-DD), MONTH (YYYY-MM), and YEAR (YYYY) intervals from the system’s installation date up to the current date. DAY queries return the most granular available resolution, MONTH queries report daily buckets, and YEAR queries report monthly buckets. All timestamps are localized to the HEM system’s configured timezone. For energy/power series, buckets < 1 hour (e.g., PT5M, PT15M) report average power (kW); buckets ≥ 1 hour report energy (kWh). When data is not available, isAvailable will be false with a reason. Note: Battery level is only available for DAY interval queries and is reported as state-of-charge (%).
Copy linktimeseries.generation.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Copy linktimeseries.consumption.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Copy linktimeseries.batteryLevel.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Locations are used to assign devices to a geographical group. This is useful for optimization, as target behavior usually depends on a common locality of demand (charging, heating, cooling, etc.) and supply (tariff, battery, inverter, etc.) of energy.
Create a Location for a User. Each Location defines a geofence with a 200 m enter radius and a 270 m exit radius. A user's Locations must be at least 200 m apart. The API rejects any new Location whose coordinates fall within the geofence of an existing one.
An IANA TZ database timezone name. This value will be used to convert rules and deadlines for tariffs, smart charging, and schedules into local time. Defaults to UTC.
Updates a Location. Note: the API does not re-validate the minimum distance constraint on update. If you move a Location's coordinates, ensure they remain at least 200 m from any other Location belonging to the same user.
Preferred BCP47 language code - Request translation for the specified language. Falls back to en-US if not provided or provided language code is unsupported.
Preferred BCP47 language code - Request translation for the specified language. Falls back to en-US if not provided or provided language code is unsupported.
The action to be taken by the user to resolve the intervention, such as relinking their account (Link) or linking an additional asset like a charger (LinkAdditionalAsset). See resolving interventions.
If provided, webhook payloads will be generated for this version. If not provided or null, the default API version of the client will be used when generating webhook payloads. Valid versions: 2024-10-01
If provided, webhook payloads will be generated for this version. If not provided or null, the default API version of the client will be used when generating webhook payloads. Valid versions: 2024-10-01
A list of validation issues which occurred while validating some component of the network payload.
Show child attributes
Service health
Endpoints that return information about the health of Enode and our integrations.
List supported vendors per asset type
GET /integrations
Lists available vendors across asset types. The list of available vendors can be customized in your client. Learn more about vendors requiring activation.
At least one functionality of the system is not operating nominally.
Statistics
Endpoints returning timeseries data collected from linked devices.
Get HEM system statisticsBeta
GET /hem-systems/{hemSystemId}/statistics
Returns time-bucketed metrics for a specific HEM System, including solar generation, household consumption, grid import/export, battery level, and charge/discharge.
The endpoint supports querying by DAY (YYYY-MM-DD), MONTH (YYYY-MM), and YEAR (YYYY) intervals from the system’s installation date up to the current date. DAY queries return the most granular available resolution, MONTH queries report daily buckets, and YEAR queries report monthly buckets. All timestamps are localized to the HEM system’s configured timezone. For energy/power series, buckets < 1 hour (e.g., PT5M, PT15M) report average power (kW); buckets ≥ 1 hour report energy (kWh). When data is not available, isAvailable will be false with a reason. Note: Battery level is only available for DAY interval queries and is reported as state-of-charge (%).
Copy linktimeseries.generation.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Copy linktimeseries.consumption.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
Copy linktimeseries.batteryLevel.dataarray of object
Timeseries of HEM System statistics per timezone of the system. The first bucket of a day starts at midnight, localtime and the final bucket of a day ends at midnight, local time. Example: For data with a PT5M resolution and a timezone offset of +02:00, the first and last bucket would be 2025-05-05T00:00:00+02:00 and 2025-05-05T23:55:00+02:00.
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
Create a tariff. The tariff ID is client-provided. If a tariff with the same ID and definition already exists, the existing tariff is returned. A newly created tariff is empty — push rate data separately via the timeseries endpoint.
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
Tariff is referenced by one or more location formulas and cannot be deleted.
Get tariff timeseries
GET /flex/tariffs/{tariffId}/timeseries
Get a tariff's rate data as a timeseries over a time range. The from and to parameters are local dates. The timezoneName parameter is required to interpret the date boundaries and annotate response values with UTC offsets. The query range must not exceed 90 days. The response is capped at 51840 values; narrow the range if this limit is exceeded.
The unit of the tariff. 'kWh' indicates a rate in currency per kilowatt-hour (e.g., 0.28 EUR/kWh). 'scalar' indicates a dimensionless multiplier used in formulas (e.g., 1.15 for a 15% markup).
The timeseries values marking rate changes. Each value indicates the rate from that timestamp until the next value (or until 'to'). Values are ordered chronologically.
The requested range would return too many timeseries points.
Push tariff timeseries data
PUT /flex/tariffs/{tariffId}/timeseries
Push rate data to a tariff. The provided values replace all data in the window [firstValue.at, to). Each value defines a step-function rate from its timestamp until the next value. Values must be strictly ascending by at, and the final value's at must be before to. The first value must be within the current hour or later. Timestamps must be timezone-aware (ISO 8601 with UTC offset). An Idempotency-Key header is required to deduplicate client retries. Completed idempotency records are retained for 24 hours; in-progress locks expire after 3 minutes.
Required key used to deduplicate retries for identical push requests. Completed idempotency records are retained for 24 hours, while in-progress locks expire after 3 minutes.
End of the replacement window (exclusive). All existing data in [firstValue.at, to) is replaced with the provided values. Data outside this window is untouched.
The timeseries values for this window. At least one value is required. Values must be strictly ascending by at (no duplicates), and the final value's at must be before to. Each value defines the rate from its timestamp until the next value (or until 'to'). The first value's 'at' defines the start of the replacement window.
Invalid request. Idempotency-Key may be missing/invalid, values must be strictly ascending by timestamp, the final value must be before to, at least one value is required, timestamps may be invalid, or the first value is before the current hour.
Create or replace the tariff formula for a location and direction. The formula defines how tariffs combine to compute the final rate. The API validates formula syntax, confirms the formula evaluates to a rate (currency/kWh), verifies that the variables map and formula references match, and checks that all referenced tariffs exist and share the same currency and direction.
Invalid formula. The formula may have syntax errors, reference non-existent tariffs, have invalid dimensional analysis (e.g., adding a scalar to a rate), or reference tariffs with mismatched currencies or directions.
Evaluate the location's tariff formula over a time range and return the computed rate at each interval. Interval timestamps include UTC offsets for unambiguous DST handling. Unresolved intervals indicate missing tariff data. The query range must not exceed 90 days. Supports cursor pagination with pageSize, after, and before.
The time intervals with their rates. Intervals are contiguous and non-overlapping. Resolved intervals contain computed rates; unresolved intervals indicate missing data.
Location not found or no formula configured for the specified direction.
Solar configurations
Solar Configurations describe the physical characteristics of a solar installation. These characteristics are used to forecast solar generation and to enable solar charging of vehicles.
Create solar configuration
POST /solar-configurations
Create a Solar Configuration for a given location. A location may have multiple Solar Configurations to represent individual arrays of panels (for example, varying azimuths or tilt).
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Compass direction the solar panels face, measured in degrees relative to true north. Valid values are 0–359, where 0 = north, 90 = east, 180 = south, and 270 = west.
Flexible EV Charging allows you to setup constraints for local optimization for your EVs, while providing flexibility to the Flex Shape API.
Create policy
POST /flex/vehicle-policies
Create a new Flexible EV Charging Policy, associated with one location and vehicle pair. Only one policy can be created per unique pair of location and vehicle. A Flex Policy cannot be enabled on a vehicle controlled by other Enode features, like Schedules or Smart Charging.
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkrestrictionSchedulearray of objectOptional
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkrestrictionSchedule[].weekdaysarray of integerRequired
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkrestrictionSchedule[].weekdaysarray of integer
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Vehicle controlled by a Schedule or has active Smart Charging Plan.
List policies
GET /flex/vehicle-policies
Lists all Flexible EV Charging Policies, optionally filtered by location and/or user. See our Pagination documentationAPI for information on how to paginate the results.
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkdata[].restrictionSchedulearray of object
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkdata[].restrictionSchedule[].weekdaysarray of integer
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkrestrictionSchedule[].weekdaysarray of integer
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Performs a partial update of a Flexible EV Charging Policy. The update will first emit a Flex Policy UpdatedAPI event, then a Flex Policy StatusAPI event as the Policy Status gets re-calculated.
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkrestrictionSchedulearray of objectOptional
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkrestrictionSchedule[].weekdaysarray of integerRequired
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkrestrictionSchedule[].weekdaysarray of integer
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Deletes a Flexible EV Charging Policy. The deletion will first emit a Flex Policy DeletedAPI event, then a Flex Policy StatusAPI event as the Policy Status gets re-calculated.
Flexible EV Charging Sessions provide visibility into a vehicle's charging session lifecycle, including real-time targets, outcomes, charge blocks, and energy delivery statistics.
List settled sessions
GET /flex/vehicle-policies/sessions
Lists settled Flexible EV Charging Sessions, optionally filtered by policy, location, or vehicle. When filtering by vehicleId, each real-world charging event appears once — the managed session is returned if one exists, otherwise the unmanaged session. See our Pagination documentationAPI for information on how to paginate the results.
Filter sessions by vehicle ID. Each real-world charging event appears once — the managed session is returned if one exists, otherwise the unmanaged session.
Extensible enum. Whether the block represents active charging or an intended restriction pause.
CHARGING: The block represents active or planned charging.
RESTRICTION: The block represents a period where charging is intended to be paused due to a restriction. It normally carries no energy, but may have positive kWh if charging continued anyway, for example because a stop command failed or was delayed.
Extensible enum. The type of charge block. UNKNOWN is energy delivered in a period the session did not plan for: charging the system did not initiate, for example the vehicle charging on its own. Only appears on settled sessions, and always reported with source: UNKNOWN, flexibility: NONE.
Extensible enum. Where this block came from. POLICY and USER_OVERRIDE mirror the target source. UNKNOWN means the charging was not initiated by the schedule or the user, so its origin is unknown; it always pairs with type: UNKNOWN.
The total energy delivered during this block in kWh. For completed and in-progress blocks, this is the actual energy delivered. For future (tentative) blocks, this is the system's estimate.
While ACTIVE, this is when the block started (if past) or is tentatively planned to start (if future). While SETTLED, this is when the block actually started.
While ACTIVE, this is when the block ended (if past) or is tentatively planned to end (if future). While SETTLED, this is when the block actually ended.
The latest target configuration. Null for unmanaged sessions (e.g. public charging) where the system did not control the charge. Use type to distinguish between REGULAR and IMMEDIATE_START targets.
The final outcome assessment. Null for unmanaged sessions. Use type to distinguish between REGULAR and IMMEDIATE_START outcomes, then state to distinguish ON_TARGET from OFF_TARGET within regular outcomes.
Copy linkdata[].restrictions.currentobject or null
The restriction currently constraining charging, or null if none is in effect. When both a POLICY and a USER_OVERRIDE window are active, USER_OVERRIDE takes precedence. When the session is in ACTIVE:IMMEDIATE_START, current is null because the immediate-start override suppresses restriction enforcement; the underlying schedule windows remain visible in all. Reflects the restriction state at the time the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
All restriction windows for this session, sorted by startsAt. Covers at least the next 24 hours. Includes policy-scheduled and user-override restrictions. Empty for settled sessions; their historic restriction periods appear as RESTRICTION-mode entries in blocks. Active sessions project POLICY windows from the restriction schedule snapshotted at plug-in, so mid-session policy edits do not affect them. Upcoming sessions project POLICY windows from the current policy schedule. Reflects the restriction state when the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
Tariff-based cost and savings analysis for this session. Null when no tariff formula is configured for the charging location, or when the configured tariff's price data did not cover the session.
The energy cost of this session based on when charging actually occurred. Calculated by multiplying the energy delivered in each 15-minute interval by the tariff rate at that time.
Get the current active or upcoming Flexible EV Charging Session for a policy. The session provides real-time visibility into what the system is charging towards (target), whether it will succeed (outcome), the actual charge windows (blocks), and energy delivery data (statistics).
Discrete windows of active charging within the session. Empty while UPCOMING. While ACTIVE, blocks represent a mix of past charging and planned future charging — past blocks are final, future blocks are tentative and may shift as the schedule re-optimizes.
Extensible enum. Whether the block represents active charging or an intended restriction pause.
CHARGING: The block represents active or planned charging.
RESTRICTION: The block represents a period where charging is intended to be paused due to a restriction. It normally carries no energy, but may have positive kWh if charging continued anyway, for example because a stop command failed or was delayed.
Extensible enum. The type of charge block. UNKNOWN is energy delivered in a period the session did not plan for: charging the system did not initiate, for example the vehicle charging on its own. Only appears on settled sessions, and always reported with source: UNKNOWN, flexibility: NONE.
Extensible enum. Where this block came from. POLICY and USER_OVERRIDE mirror the target source. UNKNOWN means the charging was not initiated by the schedule or the user, so its origin is unknown; it always pairs with type: UNKNOWN.
The total energy delivered during this block in kWh. For completed and in-progress blocks, this is the actual energy delivered. For future (tentative) blocks, this is the system's estimate.
While ACTIVE, this is when the block started (if past) or is tentatively planned to start (if future). While SETTLED, this is when the block actually started.
While ACTIVE, this is when the block ended (if past) or is tentatively planned to end (if future). While SETTLED, this is when the block actually ended.
The latest target configuration. Null for unmanaged sessions (e.g. public charging) where the system did not control the charge. Use type to distinguish between REGULAR and IMMEDIATE_START targets.
The latest outcome assessment. Null before the first estimate is available. Use type to distinguish between REGULAR and IMMEDIATE_START outcomes, then state to distinguish ON_TARGET from OFF_TARGET within regular outcomes.
The restriction currently constraining charging, or null if none is in effect. When both a POLICY and a USER_OVERRIDE window are active, USER_OVERRIDE takes precedence. When the session is in ACTIVE:IMMEDIATE_START, current is null because the immediate-start override suppresses restriction enforcement; the underlying schedule windows remain visible in all. Reflects the restriction state at the time the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
All restriction windows for this session, sorted by startsAt. Covers at least the next 24 hours. Includes policy-scheduled and user-override restrictions. Empty for settled sessions; their historic restriction periods appear as RESTRICTION-mode entries in blocks. Active sessions project POLICY windows from the restriction schedule snapshotted at plug-in, so mid-session policy edits do not affect them. Upcoming sessions project POLICY windows from the current policy schedule. Reflects the restriction state when the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
GET /flex/vehicle-policies/{policyId}/sessions/{sessionId}
Get a settled Flexible EV Charging Session, either managed or unmanaged. The session provides the actual charge windows (blocks), energy delivery data (statistics), and final outcome.
Extensible enum. Whether the block represents active charging or an intended restriction pause.
CHARGING: The block represents active or planned charging.
RESTRICTION: The block represents a period where charging is intended to be paused due to a restriction. It normally carries no energy, but may have positive kWh if charging continued anyway, for example because a stop command failed or was delayed.
Extensible enum. The type of charge block. UNKNOWN is energy delivered in a period the session did not plan for: charging the system did not initiate, for example the vehicle charging on its own. Only appears on settled sessions, and always reported with source: UNKNOWN, flexibility: NONE.
Extensible enum. Where this block came from. POLICY and USER_OVERRIDE mirror the target source. UNKNOWN means the charging was not initiated by the schedule or the user, so its origin is unknown; it always pairs with type: UNKNOWN.
The total energy delivered during this block in kWh. For completed and in-progress blocks, this is the actual energy delivered. For future (tentative) blocks, this is the system's estimate.
While ACTIVE, this is when the block started (if past) or is tentatively planned to start (if future). While SETTLED, this is when the block actually started.
While ACTIVE, this is when the block ended (if past) or is tentatively planned to end (if future). While SETTLED, this is when the block actually ended.
The latest target configuration. Null for unmanaged sessions (e.g. public charging) where the system did not control the charge. Use type to distinguish between REGULAR and IMMEDIATE_START targets.
The final outcome assessment. Null for unmanaged sessions. Use type to distinguish between REGULAR and IMMEDIATE_START outcomes, then state to distinguish ON_TARGET from OFF_TARGET within regular outcomes.
The restriction currently constraining charging, or null if none is in effect. When both a POLICY and a USER_OVERRIDE window are active, USER_OVERRIDE takes precedence. When the session is in ACTIVE:IMMEDIATE_START, current is null because the immediate-start override suppresses restriction enforcement; the underlying schedule windows remain visible in all. Reflects the restriction state at the time the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
All restriction windows for this session, sorted by startsAt. Covers at least the next 24 hours. Includes policy-scheduled and user-override restrictions. Empty for settled sessions; their historic restriction periods appear as RESTRICTION-mode entries in blocks. Active sessions project POLICY windows from the restriction schedule snapshotted at plug-in, so mid-session policy edits do not affect them. Upcoming sessions project POLICY windows from the current policy schedule. Reflects the restriction state when the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
Tariff-based cost and savings analysis for this session. Null when no tariff formula is configured for the charging location, or when the configured tariff's price data did not cover the session.
The energy cost of this session based on when charging actually occurred. Calculated by multiplying the energy delivered in each 15-minute interval by the tariff rate at that time.
Create a restriction (pause) on an active or upcoming session. The system immediately requests charging to stop and plans charging around the restriction window. If a restriction already exists, the new one replaces it. Creating a restriction while an immediate-start override is active cancels the immediate start.
Returns the energy delivered by settled Flexible EV Charging Sessions, grouped by type, source, and flexibility, then bucketed over time by resolution.
A session falls in the bucket that contains its sessionEndTime. Only settled sessions are counted; active and upcoming sessions are excluded.
Each request must set locationId, vehicleId, or both. A single request can span up to 90 days at DAY resolution, or 6 months at MONTH resolution.
Inclusive start of the report window in local time, as an RFC3339 timestamp. Truncated to the bucket boundary: local start of day for DAY, local start of month for MONTH.
Exclusive end of the report window in local time, as an RFC3339 timestamp. Truncated to the bucket boundary: local start of day for DAY, local start of month for MONTH.
Optionally limit the report to sessions for this vehicle. If provided without locationId, the vehicle's active Flex Policy determines the location and bucket timezone.
One row per (type, source, flexibility) combination the system can produce. Combinations with no energy in this bucket are reported with kwhSum: 0 rather than omitted. The set of combinations may grow in future releases.
Extensible enum. Category of the underlying session blocks.
BATTERY_RESERVE: Charging up to the battery reserve level. Policy-driven and always reported with flexibility: NONE.
REGULAR: Flexible charging that follows the schedule. Each block reports FULL, LIMITED, or NONE, based on how much room it had to move when planned.
IMMEDIATE_START: Charging triggered by a user override. Always reported with flexibility: NONE.
RESTRICTION: A window where charging was meant to be paused. Normally carries no energy, but may report positive kWh if the vehicle kept charging anyway, for example because a stop command failed or was delayed.
UNKNOWN: Energy that does not match any planned charging, either delivered outside a planned window or impossible to tie to a specific block. This row keeps each bucket's total complete, so every delivered kWh is accounted for. Always reported with source: UNKNOWN, flexibility: NONE.
Extensible enum. Whether the block was driven by the policy schedule or a user override.
POLICY: The block came from the policy's weekly schedule.
USER_OVERRIDE: The block came from a user override of the target.
UNKNOWN: Energy with no known origin: charging the schedule and the user did not initiate, plus energy that cannot be tied to a specific block. Always reported with type: UNKNOWN, flexibility: NONE.
Bad request. Returns the validation-error problem type when query parameters fail schema validation (wrong type, format, or enum value). Returns the bad-request problem type when parameters are valid but violate a business rule, such as exceeding the allowed date range.
Configure zones and locations, then push price signals to drive optimization. Zones represent market bidding zones (e.g., NO1, BE, SE3) with a configured currency. Locations must be assigned to a zone before optimization can run. Price signals are scoped to a zone — each push may trigger re-optimization of affected assets.
Set location zone
PUT /flex/locations/{locationId}
Assign a location to a zone. The zone determines which price signal and optimization context applies to this location.
The zone identifier. Corresponds to a market bidding zone.
Push price signal
PUT /flex/price-signals/{zoneId}
Push a price signal for a zone. Replaces all existing data in the window [firstValue.at, to) with the provided values. Each push may trigger re-optimization of all assets in the zone.
ISO 4217 currency code. The first accepted revision establishes the price-signal stream currency; later revisions must match it. Enode does not perform currency conversion.
When the customer or upstream price provider issued this revision. This is source provenance only; Enode uses its own receipt order to determine what was known at a point in time.
The price signal values. Between 1 and 10,000 values are accepted. Values must be ordered chronologically. Each value defines the price from its timestamp until the next value (step function). The first value's 'at' defines the start of the replacement window.
The currency of the price values. Legacy data received before currency provenance was persisted retains the historical EUR response fallback until the first accepted revision establishes the stream currency.
The price signal values whose validity overlaps the queried range. Includes the last value before from when it is still in effect at from (step-function carry-forward), so its at can precede the queried range.
The Flex Shape API exposes an aggregated controllable energy load per zone. Trading algorithms use the shape to construct bid curves.
Set location dimension group
PUT /flex/locations/{locationId}/dimensions/{dimensionId}
Assign a location to a group in a Flex Shape segmentation dimension. Dimensions and their groups are configured by Enode and agreed upfront with your organization. A location belongs to at most one group per dimension; assigning a new group replaces the previous assignment, and repeating an assignment is idempotent. Dimensions prefixed with system: are managed by Enode and cannot be modified.
PUT /flex/locations/dimensions/{dimensionId}/assignments
Assign many locations to groups in one Flex Shape segmentation dimension. Dimensions and their groups are configured by Enode and agreed upfront with your organization. Each location belongs to at most one group per dimension; assigning a new group replaces the previous assignment, and repeating unchanged assignments is idempotent. Locations not included in the request keep their current assignments. The request is applied atomically: validation failures reject the entire batch without partial writes. Dimensions prefixed with system: are managed by Enode and cannot be modified.
Get the flex shape for a zone. Returns the total flexible load forecast — one HTTP request per zone returns everything needed to construct bid curves.
Revision identifier derived from the underlying forecast data. Changes when a recomputation produces different data; identical data yields the same identifier.
Per-chunk accounting of how requested relative setpoints map to claimed asset schedules. This field is only included for clients with the flexShapeDeliverableAccounting feature flag enabled, and is omitted otherwise.
Apply constraint changes to the flex shape. Sets or clears relative setpoint constraints on individual chunks. Changes take effect on the next shape computation.
GET /flex/shape/{zoneId}/dimensions/{dimensionId}/groups
Get the flex shape for a zone segmented by one configured dimension. The response contains one entry per group plus an unassigned bucket for assets that have not been assigned to any group.
Revision identifier derived from the underlying forecast data. Changes when a recomputation produces different data; identical data yields the same identifier.
The total shape across all assets in the zone. For each curve in each chunk, the group shapes and unassigned bucket reconcile with the total within ceil(1000 * (8 * Number.EPSILON * max(1, abs(totalKw)) * bucketCount + (bucketCount + 1) * 0.000501)) / 1000 kW, where bucketCount is the number of groups plus the unassigned bucket. Their asset counts sum exactly to total.assetCount.
The group identifier within the requested dimension. For system:asset_composition the configured groups are ev (households with at least an EV) and ev_pv (households with an EV and physical or virtual solar).
Get the historical realized fleet load and envelope for a zone over a time range. The realized counterpart to the GET /flex/shape forecast. Pass groupBy to segment the realized load by a configured dimension (one entry per group plus an unassigned bucket, with membership frozen when each chunk is measured); omit it for the total-only response.
Segment the realized load by a configured dimension. When set, the response is broken down into one entry per group plus an unassigned bucket, with membership frozen when each chunk is measured. Customer-configured dimensions snapshot location assignments; system:asset_composition snapshots the Enode user's household composition for the EV/EV+solar split. Omit for the total-only response.
Invalid query parameters, or the Flex Shape API is not activated for this client.
Preview shape update
POST /flex/shape/{zoneId}/preview
Preview the effect of constraint changes on the flex shape without persisting them. Returns the shape as it would look after applying the provided chunk updates.
Revision identifier derived from the underlying forecast data. Changes when a recomputation produces different data; identical data yields the same identifier.
Per-chunk accounting of how requested relative setpoints map to claimed asset schedules. This field is only included for clients with the flexShapeDeliverableAccounting feature flag enabled, and is omitted otherwise.
Occurs whenever a new vehicle is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkvehicle.chargeState.batteryLevelnumber or nullRequired
Remaining battery in percent
Copy linkvehicle.chargeState.rangenumber or nullRequired
Estimated remaining kilometers
Copy linkvehicle.chargeState.isPluggedInboolean or nullRequired
Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)
Copy linkvehicle.chargeState.isChargingboolean or nullRequired
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkvehicle.chargeState.isFullyChargedboolean or nullRequired
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkvehicle.chargeState.batteryCapacitynumber or nullRequired
Vehicle's usable battery capacity in kWh.
Copy linkvehicle.chargeState.chargeLimitnumber or nullRequired
Charge limit, as a percent of batteryCapacity.
When null, the vendor did not report a charge limit when we last received data from them. We recommend assuming the limit is 100%.
Copy linkvehicle.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.chargeTimeRemainingnumber or nullRequired
Estimated time until the current charging intent is completed, in minutes.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of last received charge state update
Copy linkvehicle.chargeState.maxCurrentnumber or nullDeprecated
Deprecated: Use chargeRateLimit instead.
The maximum current that the vehicle can draw from the charger, in amps.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linkvehicle.smartChargingPolicy.deadlinestring or nullRequired
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.location.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.odometer.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.smartCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.refreshState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkvehicle.chargeState.batteryLevelnumber or nullRequired
Remaining battery in percent
Copy linkvehicle.chargeState.rangenumber or nullRequired
Estimated remaining kilometers
Copy linkvehicle.chargeState.isPluggedInboolean or nullRequired
Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)
Copy linkvehicle.chargeState.isChargingboolean or nullRequired
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkvehicle.chargeState.isFullyChargedboolean or nullRequired
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkvehicle.chargeState.batteryCapacitynumber or nullRequired
Vehicle's usable battery capacity in kWh.
Copy linkvehicle.chargeState.chargeLimitnumber or nullRequired
Charge limit, as a percent of batteryCapacity.
When null, the vendor did not report a charge limit when we last received data from them. We recommend assuming the limit is 100%.
Copy linkvehicle.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.chargeTimeRemainingnumber or nullRequired
Estimated time until the current charging intent is completed, in minutes.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of last received charge state update
Copy linkvehicle.chargeState.maxCurrentnumber or nullDeprecated
Deprecated: Use chargeRateLimit instead.
The maximum current that the vehicle can draw from the charger, in amps.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linkvehicle.smartChargingPolicy.deadlinestring or nullRequired
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.location.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.odometer.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.smartCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.refreshState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Latest information about the electric or hybrid battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkvehicle.chargeState.batteryLevelnumber or nullRequired
Remaining battery in percent
Copy linkvehicle.chargeState.rangenumber or nullRequired
Estimated remaining kilometers
Copy linkvehicle.chargeState.isPluggedInboolean or nullRequired
Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)
Copy linkvehicle.chargeState.isChargingboolean or nullRequired
Indicates whether the vehicle is currently receiving power from the charger and actively charging its battery.
Copy linkvehicle.chargeState.isFullyChargedboolean or nullRequired
Indicates whether the vehicle is fully charged. 'Fully charged' may be a batteryLevel of less than 100 if a chargeLimit has been configured in the vehicle. This will be null when powerDeliveryState is UNKNOWN.
Copy linkvehicle.chargeState.batteryCapacitynumber or nullRequired
Vehicle's usable battery capacity in kWh.
Copy linkvehicle.chargeState.chargeLimitnumber or nullRequired
Charge limit, as a percent of batteryCapacity.
When null, the vendor did not report a charge limit when we last received data from them. We recommend assuming the limit is 100%.
Copy linkvehicle.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.chargeTimeRemainingnumber or nullRequired
Estimated time until the current charging intent is completed, in minutes.
This property is only available when the vehicle is charging, and is null any other time.
Copy linkvehicle.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of last received charge state update
Copy linkvehicle.chargeState.maxCurrentnumber or nullDeprecated
Deprecated: Use chargeRateLimit instead.
The maximum current that the vehicle can draw from the charger, in amps.
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The vehicle is actively receiving power from the charger, causing the battery level to increase.
PLUGGED_IN:COMPLETE: The charging process has finished and the vehicle's battery has reached the target charge limit.
PLUGGED_IN:STOPPED: The charging process has been intentionally stopped by either the vehicle or the charger. The vehicle is still plugged in and waiting for the charging process to resume.
PLUGGED_IN:NO_POWER: The vehicle attempted to initialize charging, however no external power was available. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The vehicle is actively discharging by giving power to the home/grid, causing the battery level to decrease.
When enabled, this vehicle's charging status may be controlled by Smart Charging
Copy linkvehicle.smartChargingPolicy.deadlinestring or nullRequired
The hour-minute deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. If a timezone is set on the location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.
Proceed to charge promptly, disregarding energy prices, until the vehicle achieves this preset minimum limit. Please note that this limit cannot exceed the vehicle's maximum charge limit. The default setting is zero. The unit of measure is percentage.
A collection of descriptors that describe the capabilities of this specific vehicle.
When the vehicle is paired with a linked charger, each capability's interventionIds merge interventions from both assets. See Step 4: Handle unified interventions for how charger interventions are surfaced, when vehicle interventions are suppressed, and how the recommended LinkAdditionalAsset ("link a charger") intervention behaves.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.location.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.odometer.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.smartCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.refreshState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkvehicle.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkcharger.chargeState.isPluggedInboolean or nullRequired
Indicates whether the charger has a vehicle plugged into it (regardless of whether that vehicle is actually charging)
Copy linkcharger.chargeState.isChargingboolean or nullRequired
Indicates whether the charger is currently delivering power to the vehicle and actively charging its battery.
Copy linkcharger.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the charger is actively charging a vehicle, and is null any other time.
Copy linkcharger.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of latest charge state update
Copy linkcharger.chargeState.maxCurrentnumber or nullDeprecated
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Copy linkcharger.information.imageUrlstring or nullRequired
URL to an image of the charger model. null when not available.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkcharger.chargeState.isPluggedInboolean or nullRequired
Indicates whether the charger has a vehicle plugged into it (regardless of whether that vehicle is actually charging)
Copy linkcharger.chargeState.isChargingboolean or nullRequired
Indicates whether the charger is currently delivering power to the vehicle and actively charging its battery.
Copy linkcharger.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the charger is actively charging a vehicle, and is null any other time.
Copy linkcharger.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of latest charge state update
Copy linkcharger.chargeState.maxCurrentnumber or nullDeprecated
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Copy linkcharger.information.imageUrlstring or nullRequired
URL to an image of the charger model. null when not available.
Latest information about the charger. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkcharger.chargeState.isPluggedInboolean or nullRequired
Indicates whether the charger has a vehicle plugged into it (regardless of whether that vehicle is actually charging)
Copy linkcharger.chargeState.isChargingboolean or nullRequired
Indicates whether the charger is currently delivering power to the vehicle and actively charging its battery.
Copy linkcharger.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW.
This property is only available when the charger is actively charging a vehicle, and is null any other time.
Copy linkcharger.chargeState.lastUpdatedstring<date-time> or nullRequired
Time of latest charge state update
Copy linkcharger.chargeState.maxCurrentnumber or nullDeprecated
The current state of power delivery between the vehicle and charger.
UNKNOWN: The state of power delivery is currently unknown or chargeState.lastUpdated is more than 7 days ago.
UNPLUGGED: The vehicle is not connected to the charger.
PLUGGED_IN:INITIALIZING: The charging station is preparing to deliver power to the vehicle. It is expected for this state to shortly transition into PLUGGED_IN:CHARGING.
PLUGGED_IN:CHARGING: The charger is actively delivering power to the vehicle, causing the battery level to increase.
PLUGGED_IN:STOPPED: The vehicle is plugged in, but the charger has been stopped. It is possible to transition into a charging state by sending a start command.
PLUGGED_IN:NO_POWER: The charger attempted to initialize charging, however no external power was accepted by the vehicle. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:FAULT: A malfunction in the charging process is preventing power from being delivered. Possible causes include a charging cable not being properly locked, extreme temperatures, or malfunctions in either the charging station or the vehicle's internal system. It is not possible to transition into a charging state with a remote command until there is some user intervention to resolve the issue.
PLUGGED_IN:DISCHARGING: The charger is actively discharging by giving power to the home/grid, causing the battery level to decrease.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.information.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.chargeState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.startCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.stopCharging.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setMaxCurrent.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkcharger.capabilities.setChargeRateLimit.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Charger serial number. Most chargers have this, but some do not expose it. When missing we default to a vendor provided ID, which may be visible to the end user in their app.
Copy linkcharger.information.imageUrlstring or nullRequired
URL to an image of the charger model. null when not available.
The subscriber should return 200 OK to acknowledge the webhook has been received
user:hvac:discovered
Occurs whenever a new HVAC is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Indicates whether Enode can currently access live data from the HVAC. If the HVAC is not reachable, data updates will be delayed.
Copy linkhvac.consumptionRatenumber or nullRequired
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkhvac.information.groupNamestring or nullRequired
Name of the group the device belongs to, as set by the user on the device/vendor. Groups are typically presented as "rooms" or "zones".
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkhvac.temperatureState.currentTemperaturenumber or nullRequired
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setFollowSchedule.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setPermanentHold.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Indicates whether Enode can currently access live data from the HVAC. If the HVAC is not reachable, data updates will be delayed.
Copy linkhvac.consumptionRatenumber or nullRequired
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkhvac.information.groupNamestring or nullRequired
Name of the group the device belongs to, as set by the user on the device/vendor. Groups are typically presented as "rooms" or "zones".
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkhvac.temperatureState.currentTemperaturenumber or nullRequired
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setFollowSchedule.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setPermanentHold.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Indicates whether Enode can currently access live data from the HVAC. If the HVAC is not reachable, data updates will be delayed.
Copy linkhvac.consumptionRatenumber or nullRequired
The current rate of energy consumption in kW. An inactive HVAC will have a consumption rate of 0. HVACs not supporting consumption rate will report null. This value is currently only supported by a small number of devices.
Name of the device, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkhvac.information.groupNamestring or nullRequired
Name of the group the device belongs to, as set by the user on the device/vendor. Groups are typically presented as "rooms" or "zones".
Latest information about temperature. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkhvac.temperatureState.currentTemperaturenumber or nullRequired
Current air temperature reported by device in degrees Celsius.
Latest information about the thermostat state. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setFollowSchedule.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkhvac.capabilities.setPermanentHold.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The subscriber should return 200 OK to acknowledge the webhook has been received
user:inverter:discovered
Occurs whenever a new inverter is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkinverter.productionState.productionRatenumber or nullRequired
The current production rate in kW.
Copy linkinverter.productionState.isProducingboolean or nullRequired
Whether the solar inverter is actively producing energy or not.
Copy linkinverter.productionState.totalLifetimeProductionnumber or nullRequired
The total lifetime production in kWh.
Copy linkinverter.productionState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionStatistics.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkinverter.location.idstring<uuid> or nullRequired
ID of the location the solar inverter is currently positioned at (if any).
Copy linkinverter.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkinverter.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkinverter.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkinverter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkinverter.productionState.productionRatenumber or nullRequired
The current production rate in kW.
Copy linkinverter.productionState.isProducingboolean or nullRequired
Whether the solar inverter is actively producing energy or not.
Copy linkinverter.productionState.totalLifetimeProductionnumber or nullRequired
The total lifetime production in kWh.
Copy linkinverter.productionState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionStatistics.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkinverter.location.idstring<uuid> or nullRequired
ID of the location the solar inverter is currently positioned at (if any).
Copy linkinverter.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkinverter.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkinverter.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkinverter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about solar production. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkinverter.productionState.productionRatenumber or nullRequired
The current production rate in kW.
Copy linkinverter.productionState.isProducingboolean or nullRequired
Whether the solar inverter is actively producing energy or not.
Copy linkinverter.productionState.totalLifetimeProductionnumber or nullRequired
The total lifetime production in kWh.
Copy linkinverter.productionState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionState.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkinverter.capabilities.productionStatistics.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Copy linkinverter.location.idstring<uuid> or nullRequired
ID of the location the solar inverter is currently positioned at (if any).
Copy linkinverter.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkinverter.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkinverter.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkinverter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Time bucket start as a RFC3339 timestamp. Offset may be Z or ±hh:mm. In the unlikely event that an inverter changes timezone, the offset from when the data was retrieved is used, not the inverter's current timezone.
Copy linkstatistics.resolutions.QUARTER_HOUR.data[].valuenumber or nullRequired
The energy produced (kWh) in the specified interval. Null if no data is available.
Time bucket start as a RFC3339 timestamp. Offset may be Z or ±hh:mm. In the unlikely event that an inverter changes timezone, the offset from when the data was retrieved is used, not the inverter's current timezone.
Copy linkstatistics.resolutions.DAY.data[].valuenumber or nullRequired
The energy produced (kWh) in the specified interval. Null if no data is available.
The subscriber should return 200 OK to acknowledge the webhook has been received
user:battery:discovered
Occurs whenever a new battery is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkbattery.chargeState.statusstring or nullRequired
The power delivery state of the battery.
Possible enum values:
CHARGINGDISCHARGINGIDLEFAULTUNKNOWN
Copy linkbattery.chargeState.batteryCapacitynumber or nullRequired
Battery capacity in kWh.
Copy linkbattery.chargeState.batteryLevelnumber or nullRequired
Remaining battery charge level in percent.
Copy linkbattery.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW. A positive value indicates that the battery is charging.
Copy linkbattery.chargeState.dischargeLimitnumber or nullRequired
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkbattery.chargeState.lastUpdatedstring<date-time> or nullRequired
Copy linkbattery.config.operationModestring or nullRequired
The current operation mode of the battery.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.exportFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.importFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.timeOfUse.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.selfReliance.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.idle.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkbattery.location.idstring<uuid> or nullRequired
ID of the location the battery is currently positioned at (if any).
Copy linkbattery.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkbattery.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkbattery.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkbattery.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkbattery.chargeState.statusstring or nullRequired
The power delivery state of the battery.
Possible enum values:
CHARGINGDISCHARGINGIDLEFAULTUNKNOWN
Copy linkbattery.chargeState.batteryCapacitynumber or nullRequired
Battery capacity in kWh.
Copy linkbattery.chargeState.batteryLevelnumber or nullRequired
Remaining battery charge level in percent.
Copy linkbattery.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW. A positive value indicates that the battery is charging.
Copy linkbattery.chargeState.dischargeLimitnumber or nullRequired
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkbattery.chargeState.lastUpdatedstring<date-time> or nullRequired
Copy linkbattery.config.operationModestring or nullRequired
The current operation mode of the battery.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.exportFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.importFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.timeOfUse.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.selfReliance.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.idle.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkbattery.location.idstring<uuid> or nullRequired
ID of the location the battery is currently positioned at (if any).
Copy linkbattery.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkbattery.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkbattery.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkbattery.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Latest information about the battery. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkbattery.chargeState.statusstring or nullRequired
The power delivery state of the battery.
Possible enum values:
CHARGINGDISCHARGINGIDLEFAULTUNKNOWN
Copy linkbattery.chargeState.batteryCapacitynumber or nullRequired
Battery capacity in kWh.
Copy linkbattery.chargeState.batteryLevelnumber or nullRequired
Remaining battery charge level in percent.
Copy linkbattery.chargeState.chargeRatenumber or nullRequired
The current charge rate in kW. A positive value indicates that the battery is charging.
Copy linkbattery.chargeState.dischargeLimitnumber or nullRequired
Minimum charge level for a battery, expressed as a percentage. Batteries will not discharge below this user-set reserve level except in emergency power situations.
Copy linkbattery.chargeState.lastUpdatedstring<date-time> or nullRequired
Copy linkbattery.config.operationModestring or nullRequired
The current operation mode of the battery.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritizes using own energy from solar or battery for household consumption before importing from grid. Energy may be exported to the grid from solar, depending on excess solar and your user's settings in the OEM app.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined schedule matching a utility rate plan. Energy may be consumed from solar, battery, or grid sources, depending on the current prices and your user's settings in the OEM app. Energy may be exported to the grid from solar or battery sources, depending on current prices and your user's settings in the OEM app.
IMPORT_FOCUS: Prioritizes charging the battery. Uses excess solar energy for charging and will charge from grid if possible. Leveraged energy sources depend on the configuration of the battery. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the household and any excess to the grid. Grid exports often depend on local regulation and might require agreements with grid providers to be supported. Note: Focus modes target a certain battery behavior but are ultimately internal to the battery. Actual behavior might differ from the focus mode.
IDLE: Prevents the battery from charging or discharging. The battery remains inactive and maintains its current state of charge, even if there is available solar generation or energy demand from household consumption.
UNKNOWN: The mode of the battery is currently unknown. It might be possible to switch out of this mode and into one of the known modes. Actively returning to this mode is not possible.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.exportFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.importFocus.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.timeOfUse.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.selfReliance.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkbattery.capabilities.idle.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkbattery.location.idstring<uuid> or nullRequired
ID of the location the battery is currently positioned at (if any).
Copy linkbattery.location.longitudenumber or nullRequired
Longitude in degrees
Copy linkbattery.location.latitudenumber or nullRequired
Latitude in degrees
Copy linkbattery.location.lastUpdatedstring<date-time> or nullRequired
Time of last received location state update
Copy linkbattery.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
The subscriber should return 200 OK to acknowledge the webhook has been received
user:meter:discovered
Occurs whenever a new meter is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkmeter.energyState.powernumber or nullRequired
The current power measured by the meter in kW.
Positive value: Power is imported from the grid to the site, indicating consumption.
Negative value: Power is exported to the grid, typically when the site generates excess electricity (e.g. from solar panels, or battery discharge).
Copy linkmeter.energyState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresConsumption.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresProduction.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkmeter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkmeter.energyState.powernumber or nullRequired
The current power measured by the meter in kW.
Positive value: Power is imported from the grid to the site, indicating consumption.
Negative value: Power is exported to the grid, typically when the site generates excess electricity (e.g. from solar panels, or battery discharge).
Copy linkmeter.energyState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresConsumption.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresProduction.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkmeter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
Name of the site, as set by the user on the device/vendor. If no user-specified name is available, we construct a fallback name using the vendor/device/model names.
Latest information about meter load. null values indicate we are unable to determine a value for the field based on the information coming from the vendor.
Show child attributes
Copy linkmeter.energyState.powernumber or nullRequired
The current power measured by the meter in kW.
Positive value: Power is imported from the grid to the site, indicating consumption.
Negative value: Power is exported to the grid, typically when the site generates excess electricity (e.g. from solar panels, or battery discharge).
Copy linkmeter.energyState.lastUpdatedstring<date-time> or nullRequired
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresConsumption.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
The entity is fully capable of providing this data or functionality. If false, support is partial or missing. A capable entity (true) may still list recommended interventions in interventionIds.
Copy linkmeter.capabilities.measuresProduction.interventionIdsarray of stringRequired
IDs of interventions the user can make to alter the availability of this capability. Interventions may be present even when isCapable is true (recommended, non-blocking actions). See the interventions guide.
Copy linkmeter.hemSystemIdstring<uuid> or nullRequired
ID of the HEM system the asset is associated with. This field is present when the HEM System feature is enabled and the asset is linked to a HEM system.
NO_RESPONSE: The device did not react to our commands within the action's timeout window.
FAILED_PRECONDITION: The device did not meet all required preconditions for this action to be executed during the action's timeout window.
UNNECESSARY: The action was not carried out given that the device was already in the desired state.
CONFLICT: A newer action for this device has been created. This action is now abandoned.
REQUESTED_CANCELLATION: This action was cancelled by request of the controlling owner. The controlling owner may refer to another Enode entity which initiated the command, such as a schedule or smart override.
NOT_FOUND: The device was deleted while the action was PENDING.
The subscriber should return 200 OK to acknowledge the webhook has been received
user:hem-system:discovered
Occurs whenever a new HEM System is discovered for a user. Only information properties will be populated. All other properties will be null. Shortly after discovery, you'll receive an :updated event that contains additional data.
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkpolicy.restrictionSchedulearray of objectRequired
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkpolicy.restrictionSchedule[].weekdaysarray of integerRequired
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkpolicy.restrictionSchedulearray of objectRequired
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkpolicy.restrictionSchedule[].weekdaysarray of integerRequired
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The vehicle's charge limit as last observed at this policy's location. Defaults to 100 until first observed. Used for validating that targets do not exceed the vehicle's charge limit at this location.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Copy linkpolicy.restrictionSchedulearray of objectRequired
A list of recurring restriction windows where the system plans and requests charging to pause. At most 20 entries; entries must not overlap on the same weekday. Use 24:00 as the endTime of an entry to indicate end of day (midnight).
Extensible enum. The type of restriction. Currently only FULL is supported.
Copy linkpolicy.restrictionSchedule[].weekdaysarray of integerRequired
Days of the week on which the restriction is active, encoded as 0=Monday through 6=Sunday (ISO 8601 ordering, zero-indexed). Must contain at least one day, with no duplicates. The restriction applies only on these days and only between startTime and endTime on each of them.
Start time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from this time until endTime on each day listed in weekdays.
End time of the restriction window in HH:MM format, interpreted in the location's local time. The restriction is active from startTime until this time on each day listed in weekdays. Use 24:00 to indicate end of day (midnight).
UNAVAILABLE: The vehicle is unavailable for Flexible EV Charging for some reason, for example, because it is not plugged in, or not the Policy's location.
IMMEDIATE:OVERRIDE: The vehicle is charging to some target battery level because of a temporary override.
SCHEDULE:BATTERY_RESERVE: The vehicle is charging to a battery reserve level, and will stop after reaching that level.
SCHEDULE:REGULAR: The vehicle is following the regular schedule and actively participating in Flexible EV Charging.
SCHEDULE:OVERRIDE: The vehicle is following a schedule override, and is still actively participating in Flexible EV Charging.
SCHEDULE:INFLEXIBLE: The vehicle doesn't have enough time to charge to the target battery level, so there isn't any opportunity to flex the charging.
Upon arrival at the location, the vehicle will immediately charge to this battery level without regard to prices or flexibility demands. This charging is reflected in the Policy Status State as SCHEDULE:BATTERY_RESERVE. Must be between 0% and 20%. Note: For Mercedes-Benz vehicles, batteryReserve must be set to 50, as these vehicles always charge to 50% SOC upon plug-in.
The upcoming deadline represented as a RFC3339 UTC timestamp.
Copy linkpolicyStatus.settings.regularSchedule.minimumChargeTargetnumber or nullRequired
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
An override applied to a Flex Policy, shown as a part of the Flex Status entity. The override is either a next-day schedule override or an immediate start override.
The minimum acceptable battery level the user needs to reach by their deadline on a specific day of the week. The vehicle may, under some circumstances, charge to a higher battery level than the minimumChargeTarget. If the minimumChargeTarget is higher than the vehicle's chargeLimit, the vehicle will charge to the chargeLimit instead. Must be greater than or equal to the batteryReserve. For Mercedes-Benz vehicles, the minimumChargeTarget minimum is 50%, see batteryReserve for more details.
Discrete windows of active charging within the session. Empty while UPCOMING. While ACTIVE, blocks represent a mix of past charging and planned future charging — past blocks are final, future blocks are tentative and may shift as the schedule re-optimizes.
Extensible enum. Whether the block represents active charging or an intended restriction pause.
CHARGING: The block represents active or planned charging.
RESTRICTION: The block represents a period where charging is intended to be paused due to a restriction. It normally carries no energy, but may have positive kWh if charging continued anyway, for example because a stop command failed or was delayed.
Extensible enum. The type of charge block. UNKNOWN is energy delivered in a period the session did not plan for: charging the system did not initiate, for example the vehicle charging on its own. Only appears on settled sessions, and always reported with source: UNKNOWN, flexibility: NONE.
Extensible enum. Where this block came from. POLICY and USER_OVERRIDE mirror the target source. UNKNOWN means the charging was not initiated by the schedule or the user, so its origin is unknown; it always pairs with type: UNKNOWN.
The total energy delivered during this block in kWh. For completed and in-progress blocks, this is the actual energy delivered. For future (tentative) blocks, this is the system's estimate.
While ACTIVE, this is when the block started (if past) or is tentatively planned to start (if future). While SETTLED, this is when the block actually started.
While ACTIVE, this is when the block ended (if past) or is tentatively planned to end (if future). While SETTLED, this is when the block actually ended.
The latest target configuration. Null for unmanaged sessions (e.g. public charging) where the system did not control the charge. Use type to distinguish between REGULAR and IMMEDIATE_START targets.
The latest outcome assessment. Null before the first estimate is available. Use type to distinguish between REGULAR and IMMEDIATE_START outcomes, then state to distinguish ON_TARGET from OFF_TARGET within regular outcomes.
Copy linksession.restrictions.currentobject or nullRequired
The restriction currently constraining charging, or null if none is in effect. When both a POLICY and a USER_OVERRIDE window are active, USER_OVERRIDE takes precedence. When the session is in ACTIVE:IMMEDIATE_START, current is null because the immediate-start override suppresses restriction enforcement; the underlying schedule windows remain visible in all. Reflects the restriction state at the time the session was last updated. For live updates, subscribe to the flex.session.updated webhook.
Copy linksession.restrictions.allarray of objectRequired
All restriction windows for this session, sorted by startsAt. Covers at least the next 24 hours. Includes policy-scheduled and user-override restrictions. Empty for settled sessions; their historic restriction periods appear as RESTRICTION-mode entries in blocks. Active sessions project POLICY windows from the restriction schedule snapshotted at plug-in, so mid-session policy edits do not affect them. Upcoming sessions project POLICY windows from the current policy schedule. Reflects the restriction state when the session was last updated. For live updates, subscribe to the flex.session.updated webhook.