Enode API 2023-02-01

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.

Copy linkProduction

Features the latest stable software, live vendors, and strict data access controls.

Name	URL
API	https://enode-api.production.enode.io
OAuth Authorization	https://oauth.production.enode.io/oauth2/auth
OAuth Token	https://oauth.production.enode.io/oauth2/token
Link UI	https://link.production.enode.io

Copy linkSandbox

Includes the latest stable software and mocked vendors/vehicles/chargers.

Name	URL
API	https://enode-api.sandbox.enode.io
OAuth Authorization	https://oauth.sandbox.enode.io/oauth2/auth
OAuth Token	https://oauth.sandbox.enode.io/oauth2/token
Link UI	https://link.sandbox.enode.io

Authentication

The Enode API uses OAuth 2.0 client access tokens for authenticating server requests.

Copy linkAPI credentials

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.

API credentials are used to obtain an access tokenAPI for accessing client-wide endpointsAPI and user-specific endpointsAPI.

Key	Description
Client ID	The identifier for your client, referred to as the `client_id`.
Client secret	The secret for your client, referred to as the `client_secret`.

Copy linkGetting an access token

The access token authorizes client access to all data and functionality. Obtain it via the OAuth 2.0 client credentials grant using the API credentialsAPI and the relevant OAuth URLsAPI for your client's environment.

Token request example

curl https://oauth.{YOUR_CLIENT_ENVIRONMENT}.enode.io/oauth2/token \
-X POST \
-u {YOUR_CLIENT_ID}:{YOUR_CLIENT_SECRET} \
-d "grant_type=client_credentials"

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.

Token response example

{
	"access_token": "{YOUR_ACCESS_TOKEN}",
	"expires_in": 3599,
	"scope": "",
	"token_type": "bearer"
}

Copy linkRefreshing access tokens

Access tokens expire hourly, indicated by the expires_in key in the response. When expired, obtain a new tokenAPI.

Copy linkAccessing the API with the access token

Authenticate all API requests using a bearer authentication header. This header accesses client-wide endpoints (service healthAPI, tariffsAPI, user managementAPI, and webhooksAPI).

Type	Value
Header	`Authorization: Bearer {YOUR_ACCESS_TOKEN}`

Client resource request example

curl https://enode-api.{YOUR_CLIENT_ENVIRONMENT}.enode.io/health/ready \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \

Copy linkAccessing user-specific endpoints

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.

Use this additional header for general user endpoints (locationsAPI, usersAPI, schedulesAPI, statisticsAPI) and device-specific endpoints (chargersAPI, HVACsAPI, solar invertersAPI, and vehiclesAPI).

Type	Value
Header	`Enode-User-Id: {USER_ID}`

User resource request example

curl https://enode-api.{YOUR_CLIENT_ENVIRONMENT}.enode.io/me \
-X GET \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
-H "Enode-User-Id: {USER_ID}" \

Response times

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.

Copy linkAPI GET requests

Copy linkGet Vehicle

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.

Copy linkLink User

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.

Copy linkCharging commands

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.

Copy linkWebhooks

Webhooks usually involve polling and dynamically adjust the polling rate based on different situations to provide prompt updates without overloading the vehicle.

The maximum baseline delay between a real-world change (e.g., a vehicle being plugged in) and the resulting webhook notification is 7 minutes.

Vehicle context	Maximum delay
default	7 minutes
charging	2 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.

Errors and problems

Copy linkOAuth Authorization Request

Upon completing the Enode Link authorization process, the user will be redirected to your configured redirect URI. If an issue occurs, query parameters error and error_description will be set as described in Section 4.1.2.1 of the OAuth 2.0 specification:

Error	Error description
`invalid_request`	The request has a missing or invalid parameter, duplicate parameters, or is malformed.
`unauthorized_client`	The client isn't authorized to request an authorization code with this method.
`access_denied`	The resource owner or authorization server denied the request.
`unsupported_response_type`	The authorization server doesn't support obtaining an authorization code with this method.
`invalid_scope`	The requested scope is invalid, unknown, or malformed.
`server_error`	The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
`temporarily_unavailable`	The authorization server is temporarily unable to handle the request due to overloading or maintenance.

Sample

https://website.example/oauth_callback?state=e0a86fe5&error=access_denied&error_description=The+resource+owner+or+authorization+server+denied+the+request.

Copy linkErrors when accessing a User's resources

When using an access_token to access a user's resources, you may encounter the following 4XX range HTTP Status Codes:

HTTP Status Code	Explanation
400 Bad Request	The request payload failed schema validation or parsing
401 Unauthorized	Missing or invalid authentication details
403 Forbidden	Authentication succeeded, but the user lacks access to the resource due to a missing control scope.
404 Not Found	Requested resource doesn't exist
405 Method Not Allowed	Vendor unavailability prevented request completion
408 Request Timeout	Vendor timeout prevented request completion
409 Conflict	Vendor rejection prevented request completion
424 Failed Dependency	Failed vendor requests prevented request completion
429 Too Many Requests	Vendor rate limiting prevented request completion

In all cases, an RFC7807 Problem Details body is returned to aid in debugging.

Sample

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
{
  "type": "https://docs.enode.io/problems/bad-request",
  "title": "Payload validation failed",
  "detail": "\"authorizationRequest.scope\" is required",
}

Copy linkProblems

Title	Description
Bad request	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 ocurred. 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

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

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
Adding a new case to a response field documented as an enum.

All other additive changes are considered backwards compatible.

Deprecation

Deprecated means that a particular feature, endpoint, or field is marked for removal in a future version of the API. When something is marked as deprecated, it's a signal for you to update your application to use alternative features or methods we provide. While the deprecated item will continue to work in the current version, it will be removed in a future version of the API. When we deprecate an item, we will mark it as deprecated through all the previous versions. Once a version without the item is released, the deprecated feature, endpoint, or field will still be supported in the previous version for six months. After six months, using the deprecated item will return an error. Enode staff will notify you before any item is removed.

Batteries

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.

List Batteries

Beta

GET /batteries

Returns a paginated list of all Batteries.

Request

Query parameters

pageSize number Optional

Number of records to return per page

before string Optional

Encoded cursor used to fetch previous page. Cannot be used together with after. Refer to PaginationAPI for more information.

after string Optional

Encoded cursor used to fetch next page. Cannot be set together with before. Refer to PaginationAPI for more information.

Response

200

Attributes

array of Object

Paginated list of batteries

object

Cursors to the pages before and after current page. See the PaginationAPI section for reference.

Sample

{
  "data": [
    {
      "id": "54d827e1-8355-4fed-97b5-55940d1d09ba",
      "userId": "4f6fecd0-bdae-49be-b6e8-ee442e1e3da9",
      "vendor": "TESLA",
      "locationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
      "lastSeen": "2020-04-07T17:04:26Z",
      "isReachable": true,
      "chargeState": {
        "status": "CHARGING",
        "batteryCapacity": 13.5,
        "batteryLevel": 80,
        "chargeRate": 4.6,
        "lastUpdated": "2020-04-07T17:04:26Z"
      },
      "config": {
        "operationMode": "IMPORT_FOCUS",
        "lastUpdated": "2020-04-07T17:04:26Z"
      },
      "information": {
        "id": "7deb27f8-794f-467b-855e-5c61dd9f2cb3",
        "brand": "string",
        "model": "Powerwall",
        "siteName": "Powerwall Home",
        "installationDate": "2020-04-07T17:04:26Z"
      },
      "location": {
        "longitude": 10.7197486,
        "latitude": 59.9173985
      },
      "capabilities": {
        "exportFocus": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "importFocus": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "timeOfUse": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "selfReliance": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        }
      },
      "scopes": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after": "MjAyMy0wNy0xOFQxMDowODowMi4zNzNa",
    "before": "MjAyMy0wNi0xNlQwOTowMzowMS4yNjJa"
  }
}

List User Batteries

Beta

GET /users/{userId}/batteries

Returns a paginated list of batteries for the given userId.

Request

Path parameters

userId string Required

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.

Query parameters

pageSize number Optional

Number of records to return per page

before string Optional

Encoded cursor used to fetch previous page. Cannot be used together with after. Refer to PaginationAPI for more information.

after string Optional

Encoded cursor used to fetch next page. Cannot be set together with before. Refer to PaginationAPI for more information.

Response

200

Attributes

array of Object

Paginated list of batteries

object

Cursors to the pages before and after current page. See the PaginationAPI section for reference.

Sample

{
  "data": [
    {
      "id": "54d827e1-8355-4fed-97b5-55940d1d09ba",
      "userId": "4f6fecd0-bdae-49be-b6e8-ee442e1e3da9",
      "vendor": "TESLA",
      "locationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
      "lastSeen": "2020-04-07T17:04:26Z",
      "isReachable": true,
      "chargeState": {
        "status": "CHARGING",
        "batteryCapacity": 13.5,
        "batteryLevel": 80,
        "chargeRate": 4.6,
        "lastUpdated": "2020-04-07T17:04:26Z"
      },
      "config": {
        "operationMode": "IMPORT_FOCUS",
        "lastUpdated": "2020-04-07T17:04:26Z"
      },
      "information": {
        "id": "7deb27f8-794f-467b-855e-5c61dd9f2cb3",
        "brand": "string",
        "model": "Powerwall",
        "siteName": "Powerwall Home",
        "installationDate": "2020-04-07T17:04:26Z"
      },
      "location": {
        "longitude": 10.7197486,
        "latitude": 59.9173985
      },
      "capabilities": {
        "exportFocus": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "importFocus": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "timeOfUse": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "selfReliance": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        }
      },
      "scopes": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after": "MjAyMy0wNy0xOFQxMDowODowMi4zNzNa",
    "before": "MjAyMy0wNi0xNlQwOTowMzowMS4yNjJa"
  }
}

Get Battery

Beta

GET /batteries/{batteryId}

Request

Path parameters

batteryId string Required

The ID of the battery to look up.

Response

200

Attributes

id string<uuid>

Unique identifier for the battery object

userId string

The ID of the user that linked this battery.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of TESLA or ENPHASE

locationId string<uuid> or null

ID of the location the battery is currently positioned at (if any).

lastSeen string<date-time>

The last time Enode successfully communicated with the vendor or when the battery was initially linked.

isReachable boolean

Whether live data from the battery is currently reachable from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the battery's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the battery

object

Battery's GPS coordinates

object

A collection of descriptors that describe the capabilities of this specific battery

scopes array of string

Scopes that the user has granted for this battery.

Sample

{
  "id": "54d827e1-8355-4fed-97b5-55940d1d09ba",
  "userId": "4f6fecd0-bdae-49be-b6e8-ee442e1e3da9",
  "vendor": "TESLA",
  "locationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
  "lastSeen": "2020-04-07T17:04:26Z",
  "isReachable": true,
  "chargeState": {
    "status": "CHARGING",
    "batteryCapacity": 13.5,
    "batteryLevel": 80,
    "chargeRate": 4.6,
    "lastUpdated": "2020-04-07T17:04:26Z"
  },
  "config": {
    "operationMode": "IMPORT_FOCUS",
    "lastUpdated": "2020-04-07T17:04:26Z"
  },
  "information": {
    "id": "7deb27f8-794f-467b-855e-5c61dd9f2cb3",
    "brand": "string",
    "model": "Powerwall",
    "siteName": "Powerwall Home",
    "installationDate": "2020-04-07T17:04:26Z"
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985
  },
  "capabilities": {
    "exportFocus": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "importFocus": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "timeOfUse": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "selfReliance": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "scopes": [
    "string"
  ]
}

Set Operation Mode for Battery

Beta

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. Transitions can be tracked via the user:vendor-action:updated webhook event or Get Operation Mode ActionAPI.

Request

Path parameters

batteryId string Required

The ID of the battery being targeted.

Attributes

operationMode string Required

Desired operation mode of the battery.

IMPORT_FOCUS: Prioritizes charging the battery. Draws power from the grid and any excess solar for charging.
EXPORT_FOCUS: Prioritizes discharging energy stored in the battery back to the grid.
TIME_OF_USE: Maximizes energy cost savings in accordance with a user-defined 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.
SELF_RELIANCE: Minimizes household reliance on the grid. Prioritize 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.

One of IMPORT_FOCUS, EXPORT_FOCUS, TIME_OF_USE, or SELF_RELIANCE

Sample

{
  "operationMode": "IMPORT_FOCUS"
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the battery which this action is controlling.

targetType string

One of battery

object

Target battery operation mode

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "ac03a513-5494-4e1c-9dd7-2a29dc024312",
  "targetType": "battery",
  "targetState": {
    "operationMode": "IMPORT_FOCUS"
  }
}

Other responses

Response 400

A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the battery cannot perform the action.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Operation Mode Action

Beta

GET /batteries/actions/{actionId}

Returns the current state of the requested Action.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the battery which this action is controlling.

targetType string

One of battery

object

Target battery operation mode

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "ac03a513-5494-4e1c-9dd7-2a29dc024312",
  "targetType": "battery",
  "targetState": {
    "operationMode": "IMPORT_FOCUS"
  }
}

Other responses

Response 404

Action not found.

Cancel Battery Action

Beta

POST /batteries/actions/{actionId}/cancel

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.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the battery which this action is controlling.

targetType string

One of battery

object

Target battery operation mode

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "ac03a513-5494-4e1c-9dd7-2a29dc024312",
  "targetType": "battery",
  "targetState": {
    "operationMode": "IMPORT_FOCUS"
  }
}

Other responses

Response 404

Action not found.

Response 409

Action already in a resolved state and can therefore not be cancelled.

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

targetId string

ID of the battery which this action is controlling.

targetType string

One of battery

object

Target battery operation mode

state string

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.

One of CONFIRMED, FAILED, or CANCELLED

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "targetId": "ac03a513-5494-4e1c-9dd7-2a29dc024312",
  "targetType": "battery",
  "targetState": {
    "operationMode": "IMPORT_FOCUS"
  },
  "state": "CONFIRMED"
}

Refresh Battery Data

Beta

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.

Request

Path parameters

batteryId string Required

The ID of the battery being targeted.

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified battery was not found.

Chargers

EV Chargers provide charging data and can be controlled via Control ChargingAPI and Schedules

List Chargers

GET /chargers

List all available Chargers for the User.

Response

200

Attributes

List of string array of string

Charger IDs

Sample

[
  "string"
]

Get Charger

GET /chargers/{chargerId}

Request

Path parameters

chargerId string Required

ID of the Charger.

Query parameters

string or array Deprecated Optional

Functionality moved in Api Version 2023-08-01 to endpoint POST /chargers/{chargerId}/refresh-hint.

If you specify any fields here, we make a request to the Charger's OEM APIs and return the updated data.

This will slow down your integration. In cases of vendor downtime requests with fields may take up to a minute to complete, while requests without fields will always be fast. Enode polls all devices connected to our platform, so any cached data returned will not be older than 10 minutes (unless the vendor APIs are unavailable, in which case you can consult the lastSeen & isReachable fields on the charger).

By default, no fields are included, and the latest cached full Charger object will be returned.

Response

200

Attributes

id string

Charger ID

userId string

The ID of the user that linked this charger.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, or ENELX

lastSeen string<date-time>

The last time Enode communicated with the charger.

isReachable boolean

Whether live data from the charger is currently reachable from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the charger's cloud service if that service has determined that its cache is valid.

chargingLocationId string<uuid> or null

ID of the charging location the charger is currently positioned at (if any).

object

Descriptive information about the Charger

object

A collection of descriptors that describe the capabilities of this specific charger

scopes array of string

Scopes that the user has granted for this charger.

Sample

{
  "id": "2211e263-0362-4235-83f4-887bdf3ee414",
  "userId": "d381faac-5283-44a1-9eb1-36cab2ace670",
  "vendor": "ZAPTEC",
  "lastSeen": "2023-03-21T21:08:27.596Z",
  "isReachable": true,
  "chargingLocationId": "2211e263-d6d4-d6d4-d6d4-dbdd77ec82b6",
  "chargeState": {
    "isPluggedIn": true,
    "isCharging": true,
    "chargeRate": 6.939,
    "lastUpdated": "2023-03-21T16:39:20.000Z",
    "maxCurrent": 16,
    "powerDeliveryState": "PLUGGED_IN:CHARGING"
  },
  "information": {
    "id": "2211e263-0362-4235-83f4-887bdf3ee414",
    "brand": "Zaptec",
    "model": "ZAPTEC PRO",
    "year": null
  },
  "capabilities": {
    "information": {
      "isCapable": true,
      "interventionIds": []
    },
    "chargeState": {
      "isCapable": true,
      "interventionIds": []
    },
    "startCharging": {
      "isCapable": true,
      "interventionIds": []
    },
    "stopCharging": {
      "isCapable": true,
      "interventionIds": []
    },
    "setMaxCurrent": {
      "isCapable": false,
      "interventionIds": [
        "dbdd77ec82b6-d6d4-d6d4-d6d4-dbdd77ec82b6"
      ]
    }
  },
  "scopes": [
    "charger:control:charging",
    "charger:read:data"
  ]
}

Update Charger

Beta

PUT /chargers/{chargerId}

Update the chargingLocationId field on a Charger.

Request

Path parameters

chargerId string Required

ID of the Charger.

Attributes

chargingLocationId string<uuid> or null Required

Sample

{
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Response

200

Attributes

id string

Charger ID

userId string

The ID of the user that linked this charger.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, or ENELX

lastSeen string<date-time>

The last time Enode communicated with the charger.

isReachable boolean

Whether live data from the charger is currently reachable from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the charger's cloud service if that service has determined that its cache is valid.

chargingLocationId string<uuid> or null

ID of the charging location the charger is currently positioned at (if any).

object

Descriptive information about the Charger

object

A collection of descriptors that describe the capabilities of this specific charger

scopes array of string

Scopes that the user has granted for this charger.

Sample

{
  "id": "2211e263-0362-4235-83f4-887bdf3ee414",
  "userId": "d381faac-5283-44a1-9eb1-36cab2ace670",
  "vendor": "ZAPTEC",
  "lastSeen": "2023-03-21T21:08:27.596Z",
  "isReachable": true,
  "chargingLocationId": "2211e263-d6d4-d6d4-d6d4-dbdd77ec82b6",
  "chargeState": {
    "isPluggedIn": true,
    "isCharging": true,
    "chargeRate": 6.939,
    "lastUpdated": "2023-03-21T16:39:20.000Z",
    "maxCurrent": 16,
    "powerDeliveryState": "PLUGGED_IN:CHARGING"
  },
  "information": {
    "id": "2211e263-0362-4235-83f4-887bdf3ee414",
    "brand": "Zaptec",
    "model": "ZAPTEC PRO",
    "year": null
  },
  "capabilities": {
    "information": {
      "isCapable": true,
      "interventionIds": []
    },
    "chargeState": {
      "isCapable": true,
      "interventionIds": []
    },
    "startCharging": {
      "isCapable": true,
      "interventionIds": []
    },
    "stopCharging": {
      "isCapable": true,
      "interventionIds": []
    },
    "setMaxCurrent": {
      "isCapable": false,
      "interventionIds": [
        "dbdd77ec82b6-d6d4-d6d4-d6d4-dbdd77ec82b6"
      ]
    }
  },
  "scopes": [
    "charger:control:charging",
    "charger:read:data"
  ]
}

Control Charging

POST /chargers/{chargerId}/charging

Request for a charger to start or stop charging. This request creates an Action that will retry until the charger's powerDeliveryState 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.

This endpoint returns an error with status code 422 if the charger is controlled by a schedule. To restore user control, either disable the schedule or use Create Smart OverrideAPI to temporarily enable charging.

Request

Path parameters

chargerId string Required

ID of the Charger.

Attributes

action string Required

Charging action to perform

One of START or STOP

Sample

{
  "action": "START"
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

Other responses

Response 400

A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the charger cannot perform the action, is fully charged, or is already in the desired state.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Response 422

Charger controlled by a Schedule

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Set Max Current

POST /chargers/{chargerId}/max-current

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.

Request

Path parameters

chargerId string Required

ID of the Charger.

Attributes

maxCurrent number Required

Desired max current in ampere

Sample

{
  "maxCurrent": 10
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity which this action is controlling.

targetType string

One of vehicle or charger

object

Target maximum current for entity

object or null

Information about why was this action not executed successfully.

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "vehicle",
  "targetState": {
    "maxCurrent": 10
  },
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  }
}

Other responses

Response 400

A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the charger cannot perform the action.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Charger Action

GET /chargers/actions/{actionId}

Returns the current state of the requested Action.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

Other responses

Response 404

Action not found.

Cancel Charger Action

POST /chargers/actions/{actionId}/cancel

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.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

Other responses

Response 404

Action not found.

Response 409

Action already in a resolved state.

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

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.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified charger was not found.

Create External Start

Deprecated

POST /chargers/{chargerId}/external-start

Deprecated. Replaced by Create Smart OverrideAPI. The new name better reflects the functionality this endpoint offers.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

targetType string

One of charger

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA",
  "targetType": "charger"
}

End External Start

Deprecated

DELETE /chargers/{chargerId}/external-start

Deprecated. Replaced by Delete Smart OverrideAPI. The new name better reflects the functionality this endpoint offers.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

targetType string

One of charger

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA",
  "targetType": "charger"
}

Other responses

Response 404

No External Start Exists

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Create Smart Override

POST /chargers/{chargerId}/smart-override

Overrides an active smart feature by forcing the charger to start charging. This feature is meant to be used in situations where the user wants to charge immediately without disabling other smart features. The override remains active until the charger stops charging, or until the End Smart OverrideAPI endpoint is called. When the override ends, the overridden smart feature will regain control of the charger. This endpoint should not be used for standard charge control, use the Control ChargingAPI endpoint instead.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

targetType string

One of charger

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA",
  "targetType": "charger"
}

End Smart Override

DELETE /chargers/{chargerId}/smart-override

Ends any active Smart Override for the charger specified by chargerId. If previously configured, Schedules or Smart Charging will resume control over the target charger. Note that this does not mean the charger will stop charging, only that it will return to the state expected by the active Schedule or Smart Charging Plan.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

targetType string

One of charger

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA",
  "targetType": "charger"
}

Other responses

Response 404

No Smart Override Exists

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Smart Charging Policy

Beta

GET /chargers/{chargerId}/smart-charging-policy

Get the configured smart charging policy for this charger.

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

isEnabled boolean

When enabled, this charger's charging status may be controlled by Smart Charging

deadline string

The HH:MM deadline for the cycle. If a timezone is set on the charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

chargingDuration string

The HH:MM charging duration for each cycle.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "chargingDuration": "07:00"
}

Update Smart Charging Policy

Beta

PUT /chargers/{chargerId}/smart-charging-policy

Update the configured smart charging policy for this charger.

Request

Path parameters

chargerId string Required

ID of the Charger.

Attributes

isEnabled boolean Optional

When enabled, this charger's charging status may be controlled by Smart Charging

deadline string Optional

The HH:MM deadline for the cycle. If a timezone is set on the charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

chargingDuration string Optional

The HH:MM charging duration for each cycle.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "chargingDuration": "07:00"
}

Response

200

Attributes

isEnabled boolean

When enabled, this charger's charging status may be controlled by Smart Charging

deadline string

The HH:MM deadline for the cycle. If a timezone is set on the charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

chargingDuration string

The HH:MM charging duration for each cycle.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "chargingDuration": "07:00"
}

Get Smart Charging Status

Beta

GET /chargers/{chargerId}/smart-charging-status

Get the current smart charging status for this charger

Request

Path parameters

chargerId string Required

ID of the Charger.

Response

200

Attributes

chargerId string

Charger ID

userId string

User ID

state string

An enum value that describes the current smart charging state of the charger. Every charger is in exactly one state, at all times

One of DISABLED, CHARGER_NOT_REACHABLE, VEHICLE_NOT_PLUGGED_IN, CHARGING_PAUSED, CHARGING, or AWAITING_PRICES

array of Object

Charging intervals for this cycle

Sample

{
  "chargerId": "string",
  "userId": "string",
  "state": "DISABLED",
  "chargingIntervals": [
    {
      "status": "IN_PROGRESS",
      "startTime": "2023-03-21T21:08:27.596Z",
      "endTime": "2023-03-21T21:08:27.596Z"
    }
  ]
}

Charging Locations

A user creates charging locations to denote locations where they pay for the power used to charge their vehicle, heat their home, etc. Smart Charging is active at these locations only.

List Charging Locations

Deprecated

GET /charging-locations

Returns a list of Charging Locations registered to the User. Removed in version 2023-08-01. Endpoint moved to /locations.

Response

200

Attributes

List of object array of object

object object

name string

User-supplied name for the Charging Location

longitude number

Longitude in degrees

latitude number

Latitude in degrees

timezoneName string

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.

Sample

[
  {
    "name": "Enode",
    "latitude": 59.9173985,
    "longitude": 10.7197486,
    "timezoneName": "Europe/Oslo"
  }
]

Create Charging Location

Deprecated

POST /charging-locations

Create a Charging Location for a User. Removed in version 2023-08-01. Endpoint moved to /locations.

Request

Attributes

name string Required

User-supplied name for the Charging Location

longitude number Required

Longitude in degrees

latitude number Required

Latitude in degrees

timezoneName string Required

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

Response

200

Attributes

name string

User-supplied name for the Charging Location

longitude number

Longitude in degrees

latitude number

Latitude in degrees

timezoneName string

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

Get Charging Location

Deprecated

GET /charging-locations/{chargingLocationId}

Fetch a Charging Location. Removed in version 2023-08-01. Endpoint moved to /locations/{locationId}.

Request

Path parameters

chargingLocationId string Required

ID of the ChargingLocation.

Response

200

Attributes

name string

User-supplied name for the Charging Location

longitude number

Longitude in degrees

latitude number

Latitude in degrees

timezoneName string

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

Delete Charging Location

Deprecated

DELETE /charging-locations/{chargingLocationId}

Delete a Charging Location. Removed in version 2023-08-01. Endpoint moved to /locations/{locationId}.

Request

Path parameters

chargingLocationId string Required

ID of the ChargingLocation.

Response

200

Attributes

name string

User-supplied name for the Charging Location

longitude number

Longitude in degrees

latitude number

Latitude in degrees

timezoneName string

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

Update Charging Location

Deprecated

PUT /charging-locations/{chargingLocationId}

Updates a charging location with new configuration. Removed in version 2023-08-01. Endpoint moved to /locations/{locationId}.

Request

Path parameters

chargingLocationId string Required

ID of the ChargingLocation.

Attributes

name string Optional

User-supplied name for the Charging Location

longitude number Optional

Longitude in degrees

latitude number Optional

Latitude in degrees

timezoneName string Optional

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

Response

200

Attributes

name string

User-supplied name for the Charging Location

longitude number

Longitude in degrees

latitude number

Latitude in degrees

timezoneName string

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.

Sample

{
  "name": "Enode",
  "latitude": 59.9173985,
  "longitude": 10.7197486,
  "timezoneName": "Europe/Oslo"
}

HVAC

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, Return to ScheduleAPI, or via Schedules.

List HVAC units

GET /hvacs

List of User HVAC unit IDs

Response

200

Attributes

List of string array of string

HVAC IDs

Sample

[
  "string"
]

Get Action

GET /hvacs/actions/{actionId}

Returns the current state of the requested action.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "coolSetpoint": 0,
    "mode": "COOL",
    "holdType": "PERMANENT"
  }
}

Other responses

Response 404

Action not found.

Cancel HVAC Action

POST /hvacs/actions/{actionId}/cancel

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.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "coolSetpoint": 0,
    "mode": "COOL",
    "holdType": "PERMANENT"
  }
}

Other responses

Response 404

Action not found.

Response 409

Action already in a resolved state.

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "coolSetpoint": 0,
    "mode": "COOL",
    "holdType": "PERMANENT"
  }
}

Get HVAC Unit

GET /hvacs/{hvacId}

Request

Path parameters

hvacId string Required

ID of the HVAC unit.

Response

200

Attributes

id string

HVAC unit ID

userId string

The ID of the user that linked this hvac.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of TADO, MILL, ADAX, ECOBEE, SENSIBO, HONEYWELL, RESIDEO, MITSUBISHI, MICROMATIC, NIBE, PANASONIC, TOSHIBA, DAIKIN, NEST, FUJITSU, or BOSCH

lastSeen string<date-time>

The last time Enode successfully communicated with the vendor or when the HVAC unit was initially linked.

isReachable boolean

Whether live data from the HVAC unit is currently reachable from Enode's perspective. It can happen that this 'reachability' refers to reading from a cache operated by the vendor's cloud service, if that service has determined that its cache is valid.

consumptionRate number or null

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.

object

Descriptive information about the HVAC unit

object

An object describing valid states for this HVAC unit.

object

An object grouping the latest temperature information. These values replace the deprecated top-level fields and include a freshness indicator.

object

An object grouping the latest thermostat state. These values replace the deprecated top-level fields and include a freshness indicator.

mode string Deprecated

Replaced by thermostatState.mode. The HVAC's mode.

One of OFF, AUTO, COOL, or HEAT

heatSetpoint number or null Deprecated

Replaced by thermostatState.heatSetpoint. If mode allows, heat when currentTemperature falls below this point.

coolSetpoint number or null Deprecated

Replaced by thermostatState.coolSetpoint. If mode allows, cool when currentTemperature rises above this point.

holdType string Deprecated

Replaced by thermostatState.holdType. The duration the setpoints and mode are expected to be held. If SCHEDULED, the device is being controlled by an OEM schedule configured on the device.

One of PERMANENT or SCHEDULED

isActive boolean Deprecated

Replaced by temperatureState.isActive. Whether the HVAC unit is actively heating or cooling.

currentTemperature number or null Deprecated

Replaced by temperatureState.currentTemperature. Current air temperature reported by device in degrees Celsius.

scopes array of string

Scopes that the user has granted for this HVAC unit.

object Deprecated

Replaced with coolSetpoint and heatSetpoint. Target temperature for an HVAC unit.

chargingLocationId string<uuid> or null

ID of the charging location the HVAC unit is housed at (if any)

Sample

{
  "id": "string",
  "userId": "string",
  "vendor": "ADAX",
  "lastSeen": "2020-04-07T17:04:26Z",
  "isReachable": true,
  "consumptionRate": 0,
  "information": {
    "brand": "string",
    "model": "string",
    "displayName": "string",
    "groupName": "string",
    "category": "HEATING"
  },
  "capabilities": {
    "capableModes": [
      "OFF"
    ],
    "capableHoldTypes": [
      "PERMANENT"
    ],
    "coolSetpointRange": {
      "min": 0,
      "max": 0
    },
    "heatSetpointRange": {
      "min": 0,
      "max": 0
    },
    "setpointDifferenceRange": {
      "min": 0,
      "max": 0
    },
    "setFollowSchedule": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "setPermanentHold": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "temperatureState": {
    "currentTemperature": 0,
    "isActive": true,
    "lastUpdated": "2020-04-07T17:04:26Z"
  },
  "thermostatState": {
    "mode": "OFF",
    "heatSetpoint": 0,
    "coolSetpoint": 0,
    "holdType": "PERMANENT",
    "lastUpdated": "2020-04-07T17:04:26Z"
  },
  "mode": "OFF",
  "heatSetpoint": 0,
  "coolSetpoint": 0,
  "holdType": "PERMANENT",
  "isActive": true,
  "currentTemperature": 0,
  "scopes": [
    "string"
  ],
  "targetTemperature": {
    "temperature": 22,
    "deadband": 4
  },
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

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 SCHEDULED is present in the target's capabilities.capableHoldType. 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.

Request

Path parameters

hvacId string Required

ID of the HVAC unit.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "holdType": "SCHEDULED"
  }
}

Other responses

Response 400

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.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Response 422

HVAC unit controlled by an Enode Schedule

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

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.

Request

Path parameters

hvacId string Required

ID of the HVAC unit.

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified hvac was not found.

Set HVAC unit Mode as Permanent Hold

POST /hvacs/{hvacId}/permanent-hold

Tell an HVAC unit to enter a permanent hold. Only available if PERMANENT is present in the target's capabilities.capableHoldType. 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.

Request

Path parameters

hvacId string Required

ID of the HVAC unit.

Attributes

Target mode for an HVAC unit

coolSetpoint number Required

mode string Required

One of COOL

Sample

{
  "coolSetpoint": 0,
  "mode": "COOL"
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "coolSetpoint": 0,
    "mode": "COOL",
    "holdType": "PERMANENT"
  }
}

Other responses

Response 400

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.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Response 422

HVAC unit controlled by an Enode Schedule

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Set Temperature for HVAC unit

Deprecated

POST /hvacs/{hvacId}/temperature

This endpoint has been replaced with the Set Permanent HoldAPI and [Follow Schedule] endpoints. A future release will remove this endpoint.

Register a request for a change of the targetTemperature field on an HVAC unit. We retry sending the command until the HVAC unit's targetTemperature field transitions to the expected value. Note that this request will complete before any commands are sent to the HVAC unit. There can only be one action active for any one target id at a time. If a new action is created, the old action transitions to the CANCELLED state. You may react to transitions by listening for the user:vendor-action:updated webhook event or polling the HVAC action endpointAPI.

This endpoint returns an error with status code 422 if the HVAC unit is controlled by a schedule. To restore user control you must first disable the schedule.

Request

Path parameters

hvacId string Required

ID of the HVAC unit.

Attributes

temperature number or null Required

Desired temperature.

deadband number or null Required

Size of the optional deadband centered around temperature.

For example, with a temperature of 22.0 and a deadband of 4.0, an HVAC unit will receive a heating setpoint of 20.0 and a cooling setpoint of 24.0

Sample

{
  "temperature": 22,
  "deadband": 4
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity asset (HVAC) which this action is controlling.

targetType string

One of hvac

object Deprecated

Replaced with coolSetpoint and heatSetpoint. Target temperature for an HVAC unit.

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "hvac",
  "target": {
    "temperature": 22,
    "deadband": 4
  }
}

Other responses

Response 422

HVAC unit controlled by a Schedule

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Interventions

Endpoints that return information about interventions. More information and examples are available in the Interventions guide.

List Interventions

GET /interventions

Returns a list of all known interventions.

The language parameter can be used to specify the language of the resolution title and description.

Request

Query parameters

language string Optional

Preferred BCP47 language code - Request translation for the specified language. Falls back to en-US if not provided or provided language code is unsupported.

One of en-US, en-GB, de-DE, fr-FR, es-ES, pt-PT, nl-NL, nb-NO, sv-SE, da-DK, fi-FI, or ro-RO

Response

200

Attributes

List of object array of object

object object

id string<uuid>

string

Machine-friendly representation of the OEM's name.

One of APSYSTEMS, CSISolar, Deye, ENPHASE, FOXESS, FRONIUS, GOODWE, GROWATT, Hoymiles, HUAWEI, INVT, SMA, SOFAR, SOLAREDGE, SOLAX, SOLIS, SOLPLANET, SUNGROW, SUNSYNK, TESLA, TSUN, AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, TADO, MILL, ADAX, ECOBEE, SENSIBO, HONEYWELL, RESIDEO, MITSUBISHI, MICROMATIC, NIBE, PANASONIC, TOSHIBA, DAIKIN, NEST, FUJITSU, BOSCH, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, ENPHASE, ENPHASE, or TESLA

One of

APSYSTEMSCSISolarDeyeENPHASEFOXESSFRONIUSGOODWEGROWATTHoymilesHUAWEIINVTSMASOFARSOLAREDGESOLAXSOLISSOLPLANETSUNGROWSUNSYNKTESLATSUNAUDIBMWHONDAHYUNDAIJAGUARLANDROVERKIAMERCEDESMININISSANPEUGEOTPORSCHERENAULTSEATSKODATESLAVOLKSWAGENVOLVOFORDOPELDSTOYOTALEXUSCITROENCUPRAVAUXHALLFIATRIVIANNIOCHEVROLETGMCCADILLACXPENGTADOMILLADAXECOBEESENSIBOHONEYWELLRESIDEOMITSUBISHIMICROMATICNIBEPANASONICTOSHIBADAIKINNESTFUJITSUBOSCHZAPTECEASEEWALLBOXEOCHARGEAMPSEVBOXGOECHARGEPOINTENELXTESLAENPHASEENPHASETESLA

vendorType string

Type of device this intervention relates to.

One of vehicle, charger, hvac, inverter, battery, or meter

string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of APsystems, CSISolar, Deye, Enphase, FOXESS, Fronius, GoodWe, Growatt, Hoymiles, Huawei, INVT, SMA, Sofar, SolarEdge, Solax, Solis, Solplanet, Sungrow, SUNSYNK, Tesla, TSUN, Audi, BMW, Honda, Hyundai, Jaguar, Land Rover, Kia, Mercedes, MINI, Nissan, Peugeot, Porsche, Renault, SEAT, ŠKODA, Tesla, Volkswagen, Volvo, Ford, Opel, DS, Toyota, Lexus, Citroën, Cupra, Vauxhall, Fiat, Rivian, Nio, Chevrolet, GMC, Cadillac, XPENG, Tado, Mill, ADAX, Ecobee, Sensibo, Honeywell TCC, Resideo, Mitsubishi, Micro Matic, NIBE, Panasonic, Toshiba, DAIKIN, Nest, Fujitsu, Bosch, Zaptec, Easee, Wallbox, EO, EVBox, Charge Amps, go-e, ChargePoint, Enel X, Tesla, Enphase, Enphase, or Tesla

One of

APsystemsCSISolarDeyeEnphaseFOXESSFroniusGoodWeGrowattHoymilesHuaweiINVTSMASofarSolarEdgeSolaxSolisSolplanetSungrowSUNSYNKTeslaTSUNAudiBMWHondaHyundaiJaguarLand RoverKiaMercedesMININissanPeugeotPorscheRenaultSEATŠKODATeslaVolkswagenVolvoFordOpelDSToyotaLexusCitroënCupraVauxhallFiatRivianNioChevroletGMCCadillacXPENGTadoMillADAXEcobeeSensiboHoneywell TCCResideoMitsubishiMicro MaticNIBEPanasonicToshibaDAIKINNestFujitsuBoschZaptecEaseeWallboxEOEVBoxCharge Ampsgo-eChargePointEnel XTeslaEnphaseEnphaseTesla

introducedAt string<date-time>

ISO 8601 timestamp of when the intervention was introduced.

domain string

The domain the intervention is related to. i.e. Is the intervention related to the vendor service account or a setting on the device.

One of Account or Device

object

Sample

[
  {
    "id": "9d90a9ad-9b24-4ce0-94e9-e888b1b877f4",
    "vendor": "AUDI",
    "vendorType": "vehicle",
    "brand": "Audi",
    "introducedAt": "2023-03-16T00:00:00",
    "domain": "Account",
    "resolution": {
      "title": "Accept the Audi terms and conditions",
      "description": "To gain access to your vehicle's telemetry data, it's necessary to accept Audi's terms and conditions. Follow these steps to proceed:<br><br>1. Open the **myAudi app** on your phone<br>2. Follow the prompts to accept Audi's terms and conditions",
      "access": "Remote",
      "agent": "User"
    }
  }
]

Get Intervention

GET /interventions/{interventionId}

Returns a single intervention.

The language parameter can be used to specify the language of the resolution title and description.

Request

Path parameters

interventionId string Required

ID of the intervention.

Query parameters

language string Optional

Preferred BCP47 language code - Request translation for the specified language. Falls back to en-US if not provided or provided language code is unsupported.

One of en-US, en-GB, de-DE, fr-FR, es-ES, pt-PT, nl-NL, nb-NO, sv-SE, da-DK, fi-FI, or ro-RO

Response

200

Attributes

id string<uuid>

string

Machine-friendly representation of the OEM's name.

One of APSYSTEMS, CSISolar, Deye, ENPHASE, FOXESS, FRONIUS, GOODWE, GROWATT, Hoymiles, HUAWEI, INVT, SMA, SOFAR, SOLAREDGE, SOLAX, SOLIS, SOLPLANET, SUNGROW, SUNSYNK, TESLA, TSUN, AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, TADO, MILL, ADAX, ECOBEE, SENSIBO, HONEYWELL, RESIDEO, MITSUBISHI, MICROMATIC, NIBE, PANASONIC, TOSHIBA, DAIKIN, NEST, FUJITSU, BOSCH, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, ENPHASE, ENPHASE, or TESLA

One of

APSYSTEMSCSISolarDeyeENPHASEFOXESSFRONIUSGOODWEGROWATTHoymilesHUAWEIINVTSMASOFARSOLAREDGESOLAXSOLISSOLPLANETSUNGROWSUNSYNKTESLATSUNAUDIBMWHONDAHYUNDAIJAGUARLANDROVERKIAMERCEDESMININISSANPEUGEOTPORSCHERENAULTSEATSKODATESLAVOLKSWAGENVOLVOFORDOPELDSTOYOTALEXUSCITROENCUPRAVAUXHALLFIATRIVIANNIOCHEVROLETGMCCADILLACXPENGTADOMILLADAXECOBEESENSIBOHONEYWELLRESIDEOMITSUBISHIMICROMATICNIBEPANASONICTOSHIBADAIKINNESTFUJITSUBOSCHZAPTECEASEEWALLBOXEOCHARGEAMPSEVBOXGOECHARGEPOINTENELXTESLAENPHASEENPHASETESLA

vendorType string

Type of device this intervention relates to.

One of vehicle, charger, hvac, inverter, battery, or meter

string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of APsystems, CSISolar, Deye, Enphase, FOXESS, Fronius, GoodWe, Growatt, Hoymiles, Huawei, INVT, SMA, Sofar, SolarEdge, Solax, Solis, Solplanet, Sungrow, SUNSYNK, Tesla, TSUN, Audi, BMW, Honda, Hyundai, Jaguar, Land Rover, Kia, Mercedes, MINI, Nissan, Peugeot, Porsche, Renault, SEAT, ŠKODA, Tesla, Volkswagen, Volvo, Ford, Opel, DS, Toyota, Lexus, Citroën, Cupra, Vauxhall, Fiat, Rivian, Nio, Chevrolet, GMC, Cadillac, XPENG, Tado, Mill, ADAX, Ecobee, Sensibo, Honeywell TCC, Resideo, Mitsubishi, Micro Matic, NIBE, Panasonic, Toshiba, DAIKIN, Nest, Fujitsu, Bosch, Zaptec, Easee, Wallbox, EO, EVBox, Charge Amps, go-e, ChargePoint, Enel X, Tesla, Enphase, Enphase, or Tesla

One of

APsystemsCSISolarDeyeEnphaseFOXESSFroniusGoodWeGrowattHoymilesHuaweiINVTSMASofarSolarEdgeSolaxSolisSolplanetSungrowSUNSYNKTeslaTSUNAudiBMWHondaHyundaiJaguarLand RoverKiaMercedesMININissanPeugeotPorscheRenaultSEATŠKODATeslaVolkswagenVolvoFordOpelDSToyotaLexusCitroënCupraVauxhallFiatRivianNioChevroletGMCCadillacXPENGTadoMillADAXEcobeeSensiboHoneywell TCCResideoMitsubishiMicro MaticNIBEPanasonicToshibaDAIKINNestFujitsuBoschZaptecEaseeWallboxEOEVBoxCharge Ampsgo-eChargePointEnel XTeslaEnphaseEnphaseTesla

introducedAt string<date-time>

ISO 8601 timestamp of when the intervention was introduced.

domain string

The domain the intervention is related to. i.e. Is the intervention related to the vendor service account or a setting on the device.

One of Account or Device

object

Sample

{
  "id": "9d90a9ad-9b24-4ce0-94e9-e888b1b877f4",
  "vendor": "AUDI",
  "vendorType": "vehicle",
  "brand": "Audi",
  "introducedAt": "2023-03-16T00:00:00",
  "domain": "Account",
  "resolution": {
    "title": "Accept the Audi terms and conditions",
    "description": "To gain access to your vehicle's telemetry data, it's necessary to accept Audi's terms and conditions. Follow these steps to proceed:<br><br>1. Open the **myAudi app** on your phone<br>2. Follow the prompts to accept Audi's terms and conditions",
    "access": "Remote",
    "agent": "User"
  }
}

Other responses

Response 404

Intervention not found.

Me

The Me endpoint returns metadata about the authenticated User.

Get My User

Deprecated

GET /me

Returns metadata about the authenticated User, including a list of vendors for which the User has provided credentials. Removed in version 2023-08-01. Endpoint moved to /users/{userId}.

Response

200

Attributes

id string

The user's userID.

array of Object

Sample

{
  "id": "123456789-ABc",
  "linkedVendors": [
    {
      "vendor": "TESLA",
      "vendorType": "vehicle",
      "isValid": true
    }
  ]
}

Disconnect Vendor

Deprecated

DELETE /me/vendors/{vendor}

Disconnect a single Vendor from the User's account.

All stored data about their Vendor account will be deleted, and any vehicles that were provided by that Vendor will disappear from the system. Removed in version 2023-08-01. Endpoint moved to /users/{userId}/vendors/{vendor}.

Request

Path parameters

vendor string Required

Vendor to be unlinked.

Response

204

No Content

Meters

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.

Get Meter

Beta

GET /meters/{meterId}

Request

Path parameters

meterId string Required

The ID of the meter you are looking up

Response

200

Attributes

id string<uuid>

Unique identifier for the meter object

userId string

The ID of the user that linked this meter.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of ENPHASE or TESLA

lastSeen string<date-time>

The last time Enode successfully communicated with the vendor or when the meter was initially linked.

isReachable boolean

Whether live data from the meter is currently reachable from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the meter's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the meter

object

Meter's GPS coordinates

object

The specific meter's capabilities for recording energy consumption and production data.

scopes array of string

Scopes that the user has granted for this meter.

Sample

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "userId": "string",
  "vendor": "TESLA",
  "lastSeen": "2020-04-07T17:04:26Z",
  "isReachable": true,
  "information": {
    "brand": "Tesla",
    "model": "Tesla Powerwall built-in meter",
    "siteName": "Powerwall Home",
    "installationDate": "2020-04-07T17:04:26Z"
  },
  "energyState": {
    "power": 2.2,
    "lastUpdated": "2022-03-01T12:34:56Z"
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985
  },
  "capabilities": {
    "measuresConsumption": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "measuresProduction": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "scopes": [
    "meter:read:data",
    "meter:read:location"
  ]
}

Refresh meter data

Beta

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.

Request

Path parameters

meterId string Required

The ID of the meter you are looking up

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified meter was not found.

List User Meters

Beta

GET /users/{userId}/meters

Returns a paginated list of meters for the given userId.

Request

Path parameters

userId string Required

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.

Query parameters

pageSize number Optional

Number of records to return per page

before string Optional

Encoded cursor used to fetch previous page. Cannot be used together with after. Refer to PaginationAPI for more information.

after string Optional

Encoded cursor used to fetch next page. Cannot be set together with before. Refer to PaginationAPI for more information.

Response

200

Attributes

array of Object

Paginated list of meters

object

Cursors to the pages before and after current page. See the PaginationAPI section for reference.

Sample

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "userId": "string",
      "vendor": "TESLA",
      "lastSeen": "2020-04-07T17:04:26Z",
      "isReachable": true,
      "information": {
        "brand": "Tesla",
        "model": "Tesla Powerwall built-in meter",
        "siteName": "Powerwall Home",
        "installationDate": "2020-04-07T17:04:26Z"
      },
      "energyState": {
        "power": 2.2,
        "lastUpdated": "2022-03-01T12:34:56Z"
      },
      "location": {
        "longitude": 10.7197486,
        "latitude": 59.9173985
      },
      "capabilities": {
        "measuresConsumption": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "measuresProduction": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        }
      },
      "scopes": [
        "meter:read:data",
        "meter:read:location"
      ]
    }
  ],
  "pagination": {
    "after": "MjAyMy0wNy0xOFQxMDowODowMi4zNzNa",
    "before": "MjAyMy0wNi0xNlQwOTowMzowMS4yNjJa"
  }
}

List Meters

Beta

GET /meters

Returns a paginated list of all Meters.

Request

Query parameters

pageSize number Optional

Number of records to return per page

before string Optional

Encoded cursor used to fetch previous page. Cannot be used together with after. Refer to PaginationAPI for more information.

after string Optional

Encoded cursor used to fetch next page. Cannot be set together with before. Refer to PaginationAPI for more information.

Response

200

Attributes

array of Object

Paginated list of meters

object

Cursors to the pages before and after current page. See the PaginationAPI section for reference.

Sample

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "userId": "string",
      "vendor": "TESLA",
      "lastSeen": "2020-04-07T17:04:26Z",
      "isReachable": true,
      "information": {
        "brand": "Tesla",
        "model": "Tesla Powerwall built-in meter",
        "siteName": "Powerwall Home",
        "installationDate": "2020-04-07T17:04:26Z"
      },
      "energyState": {
        "power": 2.2,
        "lastUpdated": "2022-03-01T12:34:56Z"
      },
      "location": {
        "longitude": 10.7197486,
        "latitude": 59.9173985
      },
      "capabilities": {
        "measuresConsumption": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        },
        "measuresProduction": {
          "isCapable": false,
          "interventionIds": [
            "4eaeb363-296d-4ccc-a973-7805e6f400bd"
          ]
        }
      },
      "scopes": [
        "meter:read:data",
        "meter:read:location"
      ]
    }
  ],
  "pagination": {
    "after": "MjAyMy0wNy0xOFQxMDowODowMi4zNzNa",
    "before": "MjAyMy0wNi0xNlQwOTowMzowMS4yNjJa"
  }
}

Schedules

Endpoints to manage schedules for Vehicles, Chargers and HVACs.

More information and examples are available in the Scheduling guide.

List Schedules

Deprecated

GET /schedules

Moved to GET /users/{userId}/schedules.

Returns a list of Schedules registered to the User.

Response

200

Attributes

List of Object array of Object

id string

isEnabled boolean

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean

When no rule is active, the default charge state for the target.

array of Object

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

chargeableId string Deprecated

Replaced by targetId.

chargeableType string Deprecated

Replaced by targetType.

One of vehicle or charger

entityId string Deprecated

Replaced by targetId.

entityType string Deprecated

Replaced by targetType.

targetId string

ID of the asset (Vehicle/Charger) to which this schedule applies

targetType string

One of vehicle or charger

chargingLocationId string<uuid> or null Deprecated

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

[
  {
    "id": "string",
    "isEnabled": true,
    "defaultShouldCharge": true,
    "rules": [
      {
        "hourMinute": {
          "from": "string",
          "to": "string"
        },
        "fromTimestamp": "2020-04-07T17:04:26Z",
        "toTimestamp": "2020-04-07T17:04:26Z",
        "weekdays": [
          0,
          1,
          2,
          3,
          4,
          5
        ],
        "shouldCharge": true
      }
    ],
    "chargeableId": "string",
    "chargeableType": "vehicle",
    "entityId": "string",
    "entityType": "string",
    "targetId": "string",
    "targetType": "vehicle",
    "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
  }
]

Create Schedule

Deprecated

POST /schedules

Moved to POST /users/{userId}/schedules.

Request

Attributes

isEnabled boolean Required

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean Required

When no rule is active, the default charge state for the target.

array of Object Required

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

entityId string Deprecated Required

Replaced by targetId.

entityType string Deprecated Required

Replaced by targetType.

chargingLocationId string<uuid> or null Deprecated Required

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

{
  "isEnabled": true,
  "defaultShouldCharge": true,
  "rules": [
    {
      "hourMinute": {
        "from": "string",
        "to": "string"
      },
      "fromTimestamp": "2020-04-07T17:04:26Z",
      "toTimestamp": "2020-04-07T17:04:26Z",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "shouldCharge": true
    }
  ],
  "entityId": "string",
  "entityType": "string",
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Response

200

Attributes

id string

isEnabled boolean

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean

When no rule is active, the default charge state for the target.

array of Object

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

chargeableId string Deprecated

Replaced by targetId.

chargeableType string Deprecated

Replaced by targetType.

One of vehicle or charger

entityId string Deprecated

Replaced by targetId.

entityType string Deprecated

Replaced by targetType.

targetId string

ID of the asset (Vehicle/Charger) to which this schedule applies

targetType string

One of vehicle or charger

chargingLocationId string<uuid> or null Deprecated

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

{
  "id": "string",
  "isEnabled": true,
  "defaultShouldCharge": true,
  "rules": [
    {
      "hourMinute": {
        "from": "string",
        "to": "string"
      },
      "fromTimestamp": "2020-04-07T17:04:26Z",
      "toTimestamp": "2020-04-07T17:04:26Z",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "shouldCharge": true
    }
  ],
  "chargeableId": "string",
  "chargeableType": "vehicle",
  "entityId": "string",
  "entityType": "string",
  "targetId": "string",
  "targetType": "vehicle",
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Get Schedule

GET /schedules/{scheduleId}

Request

Path parameters

scheduleId string Required

ID of the Schedule.

Response

200

Attributes

id string

isEnabled boolean

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean

When no rule is active, the default charge state for the target.

array of Object

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

chargeableId string Deprecated

Replaced by targetId.

chargeableType string Deprecated

Replaced by targetType.

One of vehicle or charger

entityId string Deprecated

Replaced by targetId.

entityType string Deprecated

Replaced by targetType.

targetId string

ID of the asset (Vehicle/Charger) to which this schedule applies

targetType string

One of vehicle or charger

chargingLocationId string<uuid> or null Deprecated

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

{
  "id": "string",
  "isEnabled": true,
  "defaultShouldCharge": true,
  "rules": [
    {
      "hourMinute": {
        "from": "string",
        "to": "string"
      },
      "fromTimestamp": "2020-04-07T17:04:26Z",
      "toTimestamp": "2020-04-07T17:04:26Z",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "shouldCharge": true
    }
  ],
  "chargeableId": "string",
  "chargeableType": "vehicle",
  "entityId": "string",
  "entityType": "string",
  "targetId": "string",
  "targetType": "vehicle",
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Update Schedule

PUT /schedules/{scheduleId}

Does a partial update of a schedule.

Request

Path parameters

scheduleId string Required

ID of the Schedule.

Attributes

isEnabled boolean Optional

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean Optional

When no rule is active, the default charge state for the target.

array of Object Optional

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

entityId string Deprecated Optional

Replaced by targetId.

entityType string Deprecated Optional

Replaced by targetType.

chargingLocationId string<uuid> or null Deprecated Optional

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

{
  "isEnabled": true,
  "defaultShouldCharge": true,
  "rules": [
    {
      "hourMinute": {
        "from": "string",
        "to": "string"
      },
      "fromTimestamp": "2020-04-07T17:04:26Z",
      "toTimestamp": "2020-04-07T17:04:26Z",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "shouldCharge": true
    }
  ],
  "entityId": "string",
  "entityType": "string",
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Response

200

Attributes

id string

isEnabled boolean

Whether this Schedule should be attempting to control the target's charge state.

defaultShouldCharge boolean

When no rule is active, the default charge state for the target.

array of Object

Each rule sets a value for shouldCharge, either true or false. All other properties of the rule are optional filters that limit the times to which this rule applies.

chargeableId string Deprecated

Replaced by targetId.

chargeableType string Deprecated

Replaced by targetType.

One of vehicle or charger

entityId string Deprecated

Replaced by targetId.

entityType string Deprecated

Replaced by targetType.

targetId string

ID of the asset (Vehicle/Charger) to which this schedule applies

targetType string

One of vehicle or charger

chargingLocationId string<uuid> or null Deprecated

Deprecated. Replaced by LocationId from version 2023-08-01. ID of the Charging Location to which this schedule applies. The behavior of a null value differs based on the targetType. For chargers, a null value is essentially ignored and the schedule is applied even if the charger isn't at a charging location. This is designed to prevent schedules from controlling vehicles at public chargers where the user doesn't pay for electricity.

Sample

{
  "id": "string",
  "isEnabled": true,
  "defaultShouldCharge": true,
  "rules": [
    {
      "hourMinute": {
        "from": "string",
        "to": "string"
      },
      "fromTimestamp": "2020-04-07T17:04:26Z",
      "toTimestamp": "2020-04-07T17:04:26Z",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "shouldCharge": true
    }
  ],
  "chargeableId": "string",
  "chargeableType": "vehicle",
  "entityId": "string",
  "entityType": "string",
  "targetId": "string",
  "targetType": "vehicle",
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Delete Schedule

DELETE /schedules/{scheduleId}

Delete a Schedule

Request

Path parameters

scheduleId string Required

ID of the Schedule.

Response

204

No Content

Get Schedule Status

GET /schedules/{scheduleId}/status

Request

Path parameters

scheduleId string Required

ID of the Schedule.

Response

200

Attributes

The state of a Charge Schedule at a particular point in time.

scheduleId string<uuid>

ID of the schedule.

scheduleType string

One of CHARGE

changedAt string<date-time>

Time at which any value of the status last changed

state string

An enum value that describes the current state of the Schedule

One of ALIGNED, MISALIGNED, PENDING, INACTIVE:OVERRIDDEN, INACTIVE:DISABLED, INACTIVE:AWAY, or INACTIVE:INCAPABLE

isCharging boolean

Whether the target is currently actually charging

isChargingExpected boolean

Whether the target is currently expected to be charging

object

Collection of booleans that - when combined via AND operator - forms the isChargingExpected value

array of Object

List of upcoming transitions of the shouldCharge or targetTemperature value. A maximum of 2 items are returned.

object or null Deprecated

Replaced by smartOverride.

Sample

{
  "scheduleId": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "scheduleType": "CHARGE",
  "changedAt": "2020-04-07T17:04:26Z",
  "state": "ALIGNED",
  "isCharging": true,
  "isChargingExpected": true,
  "isChargingExpectedParts": {
    "needsCharge": true,
    "isPluggedIn": true,
    "shouldCharge": true
  },
  "upcomingTransitions": [
    {
      "at": "2020-04-07T17:04:26Z",
      "shouldCharge": true
    }
  ],
  "externalStart": {
    "createdAt": "2020-04-07T17:04:26Z",
    "endedAt": "2020-04-07T17:04:26Z",
    "targetType": "vehicle",
    "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
    "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f"
  }
}

Service Health

Endpoints that return information about the health of Enode and our integrations.

Check Available Charger Vendors

GET /health/chargers

Lists the available charger vendors, including the activated vendors that your client has access to. Learn more about vendors requiring activation.

Response

200

Attributes

List of object array of object

object object

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, or ENELX

displayName string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of Zaptec, Easee, Wallbox, EO, EVBox, Charge Amps, go-e, ChargePoint, or Enel X

status string

Ready-state of the Vendor. Currently always READY.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

portalName string

The name of the first party service or app that the user normally logs into.

linkingStatus string

Ready-state for linking with the Vendor.

READY: The Vendor is ready to be linked with.
ELEVATED_ERROR_RATE: Multiple attempts may be needed to link successfully. We are showing a warning in Link UI.
OUTAGE: The Vendor is currently not available for linking. We will show an error in Link UI and not let the user attempt to link with the Vendor.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

Sample

[
  {
    "vendor": "EASEE",
    "displayName": "Easee",
    "portalName": "Easee",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "WALLBOX",
    "displayName": "Wallbox",
    "portalName": "Wallbox",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "ZAPTEC",
    "displayName": "Zaptec",
    "portalName": "Zaptec",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "EO",
    "displayName": "EO",
    "portalName": "EO",
    "status": "READY",
    "linkingStatus": "READY"
  }
]

Check Available Vehicle Vendors

GET /health/vehicles

Lists the available vehicle vendors, including the activated vendors that your client has access to. Learn more about vendors requiring activation.

Response

200

Attributes

List of object array of object

object object

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

displayName string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of Audi, BMW, Honda, Hyundai, Jaguar, Land Rover, Kia, Mercedes, MINI, Nissan, Peugeot, Porsche, Renault, SEAT, ŠKODA, Tesla, Volkswagen, Volvo, Ford, Opel, DS, Toyota, Lexus, Citroën, Cupra, Vauxhall, Fiat, Rivian, Nio, Chevrolet, GMC, Cadillac, or XPENG

status string

Ready-state of the Vendor. Currently always READY.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

portalName string

The name of the first party service or app that the user normally logs into.

linkingStatus string

Ready-state for linking with the Vendor.

READY: The Vendor is ready to be linked with.
ELEVATED_ERROR_RATE: Multiple attempts may be needed to link successfully. We are showing a warning in Link UI.
OUTAGE: The Vendor is currently not available for linking. We will show an error in Link UI and not let the user attempt to link with the Vendor.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

Sample

[
  {
    "vendor": "TESLA",
    "displayName": "Tesla",
    "portalName": "Tesla",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "BMW",
    "displayName": "BMW",
    "portalName": "My BMW",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "AUDI",
    "displayName": "Audi",
    "portalName": "myAudi",
    "status": "READY",
    "linkingStatus": "READY"
  }
]

Check Available Inverter Vendors

GET /health/inverter

Lists the available inverter vendors, including the activated vendors that your client has access to. Learn more about vendors requiring activation.

Response

200

Attributes

List of object array of object

object object

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of APSYSTEMS, CSISolar, Deye, ENPHASE, FOXESS, FRONIUS, GOODWE, GROWATT, Hoymiles, HUAWEI, INVT, SMA, SOFAR, SOLAREDGE, SOLAX, SOLIS, SOLPLANET, SUNGROW, SUNSYNK, TESLA, or TSUN

displayName string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of APsystems, CSISolar, Deye, Enphase, FOXESS, Fronius, GoodWe, Growatt, Hoymiles, Huawei, INVT, SMA, Sofar, SolarEdge, Solax, Solis, Solplanet, Sungrow, SUNSYNK, Tesla, or TSUN

status string

Ready-state of the Vendor. Currently always READY.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

portalName string

The name of the first party service or app that the user normally logs into.

linkingStatus string

Ready-state for linking with the Vendor.

READY: The Vendor is ready to be linked with.
ELEVATED_ERROR_RATE: Multiple attempts may be needed to link successfully. We are showing a warning in Link UI.
OUTAGE: The Vendor is currently not available for linking. We will show an error in Link UI and not let the user attempt to link with the Vendor.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

Sample

[
  {
    "vendor": "SOLAREDGE",
    "displayName": "SolarEdge",
    "portalName": "Solar Edge",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "SMA",
    "displayName": "SMA",
    "portalName": "SMA Energy",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "SOLIS",
    "displayName": "Solis",
    "portalName": "Solis",
    "status": "READY",
    "linkingStatus": "READY"
  },
  {
    "vendor": "FRONIUS",
    "displayName": "Fronius",
    "status": "READY",
    "linkingStatus": "READY",
    "portalName": "Fronius"
  }
]

Check Available Hvac Vendors

GET /health/hvacs

Lists the available HVAC vendors, including the activated vendors that your client has access to. Learn more about vendors requiring activation.

Response

200

Attributes

List of object array of object

object object

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of TADO, MILL, ADAX, ECOBEE, SENSIBO, HONEYWELL, RESIDEO, MITSUBISHI, MICROMATIC, NIBE, PANASONIC, TOSHIBA, DAIKIN, NEST, FUJITSU, or BOSCH

displayName string

A formatted and properly cased OEM brand name, suitable for reading by humans. May contain special characters.

One of Tado, Mill, ADAX, Ecobee, Sensibo, Honeywell TCC, Resideo, Mitsubishi, Micro Matic, NIBE, Panasonic, Toshiba, DAIKIN, Nest, Fujitsu, or Bosch

status string

Ready-state of the Vendor. Currently always READY.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

portalName string

The name of the first party service or app that the user normally logs into.

linkingStatus string

Ready-state for linking with the Vendor.

READY: The Vendor is ready to be linked with.
ELEVATED_ERROR_RATE: Multiple attempts may be needed to link successfully. We are showing a warning in Link UI.
OUTAGE: The Vendor is currently not available for linking. We will show an error in Link UI and not let the user attempt to link with the Vendor.

One of READY, ELEVATED_ERROR_RATE, or OUTAGE

Sample

[
  {
    "vendor": "MILL",
    "displayName": "Mill",
    "portalName": "Mill",
    "status": "READY",
    "linkingStatus": "READY"
  }
]

Check Service Readiness

GET /health/ready

Gets the combined health status of the service and all functionalities and dependencies.

Response

204

All functionalities are operating nominally.

Other responses

Response 503

At least one functionality of the system is not operating nominally.

Solar inverters

Solar inverters can be queried for current production state

List Solar Inverters

GET /inverters

Response

200

Attributes

List of string array of string

Solar inverter IDs

Sample

[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Get Solar Inverter

GET /inverters/{inverterId}

Request

Path parameters

inverterId string Required

ID of the solar inverter

Query parameters

string or array Deprecated Optional

Functionality moved in version 2023-08-01 to endpoint POST /chargers/{chargerId}/refresh-hint.

If you specify any fields here, we make a request to the Solar inverter's OEM APIs and return the updated data.

This will slow down your integration. In cases of vendor downtime requests with fields may take up to a minute to complete, while requests without fields will always be fast. Enode polls all devices connected to our platform, so any cached data returned will not be older than 10 minutes (unless the vendor APIs are unavailable, in which case you can consult the lastSeen & isReachable fields on the solar inverter).

By default, no fields are included, and the latest cached full solar inverter object will be returned.

Response

200

Attributes

id string<uuid>

Solar Inverter ID

userId string

The ID of the user that linked this inverter.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of APSYSTEMS, CSISolar, Deye, ENPHASE, FOXESS, FRONIUS, GOODWE, GROWATT, Hoymiles, HUAWEI, INVT, SMA, SOFAR, SOLAREDGE, SOLAX, SOLIS, SOLPLANET, SUNGROW, SUNSYNK, TESLA, or TSUN

chargingLocationId string<uuid> or null

ID of the charging location the solar inverter is currently positioned at (if any).

lastSeen string<date-time>

The last time Enode received live data or when the solar inverter was initially linked.

isReachable boolean

Whether live data from the solar inverter is currently reachable from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the solar inverter's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the solar inverter

object

Solar inverter's GPS coordinates

timezone string or null

IANA TZ database timezone name representing the location of this inverter.

scopes array of string

Scopes that the user has granted for this inverter.

Sample

{
  "id": "195d8649-ad12-4755-a9cc-44e2d40ce4d9",
  "userId": "f9d9b134-05f3-452a-80aa-be0deb22f492",
  "vendor": "ENPHASE",
  "chargingLocationId": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
  "lastSeen": "2020-04-07T17:04:26Z",
  "isReachable": true,
  "productionState": {
    "productionRate": 0,
    "isProducing": true,
    "totalLifetimeProduction": 100152.56,
    "lastUpdated": "2020-04-07T17:04:26Z"
  },
  "information": {
    "id": "7a18eb4e-ee65-4d5b-bb7c-d8e530006b18",
    "brand": "string",
    "model": "Sunny Boy",
    "siteName": "Sunny Plant",
    "installationDate": "2020-04-07T17:04:26Z"
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985
  },
  "timezone": "Europe/Oslo",
  "scopes": [
    "inverter:read:location",
    "inverter:read:data"
  ]
}

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.

Request

Path parameters

inverterId string Required

ID of the solar inverter

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified inverter was not found.

Statistics

Endpoints returning timeseries data collected from any linked devices.

Get User Charging Statistics

Deprecated

GET /statistics/charging

Moved to /users/{userId}/statistics/charging.

Returns a normalized time series of statistics about power consumption and price for the User.

If Smart Charging has shifted the consumption, the 'non-smart' price fields will show what the consumption would have cost if it had happened at the default time. If smart charging has resulted in savings, the value is reported in the estimatedSavings field. <CURRENCY> is an ISO4217 Alpha-3 currency code that is determined by client-wide configuration or the currency code provided during price data ingestion (such as Tariffs).

Request

Query parameters

startDate string Required

Earliest date to include in the response. Example: 2021-03-21T00:25:43.511Z

endDate string Optional

Latest date to include in the response (defaults to current date/time). Example: 2021-03-21T00:25:43.511Z

chargingLocationId string<uuid> Optional

Filter statistics to only include this charging location

resolution string Optional

The unit of time the data will be cut into before aggregate statistics are applied. Each entry in the response array corresponds to aggregated data of the time range specified.

One of QUARTER_HOUR, HALF_HOUR, HOUR, DAY, WEEK, MONTH, or YEAR

utcOffset string<float> Deprecated Optional

Offset (in hours) from UTC to adjust the timezone for viewing statistics. By default, all timestamps are in UTC, and period boundaries (day, week, month, year) are calculated in UTC. Providing utcOffset aligns these to the viewer's timezone. Accepts positive, negative, and fractional values. Note: utcOffset has no effect with resolutions QUARTER_HOUR, HALF_HOUR, or HOUR.

Deprecated: The use of utcOffset is discouraged as it doesn't handle time zones adequately. All data will be bucketed in UTC if utcOffset is not provided.

type string Optional

Get statistics for this hardware type. If omitted, statistics for the vehicle hardware type will be returned.

One of charger, vehicle, or hvac

id string Optional

Filter statistics to only include a specific entity. Hardware category of the entity must match the type parameter.

vehicleId string Deprecated Optional

Filter statistics to only include a specific vehicle. This parameter is deprecated in favor of id and type. If used together with id, this parameter will be ignored.

Response

200

Attributes

List of object array of object

object object

object

Aggregate statistics for charge rate in kW

kwhSum number

Total power consumption in kWh

object

Aggregate statistics for power price (<CURRENCY> per kWh)

costSum number

Total cost in <CURRENCY>

object

Aggregate statistics for power price (<CURRENCY> per kWh), calculated as if charging had occurred uninterrupted without being delayed by Smart Charging

nonSmartCostSum number or null Deprecated

Total cost for consumed energy in <CURRENCY>, calculated as if it had not been shifted by Smart Charging

estimatedSavings number or null

Total estimated savings in <CURRENCY>, achieved by Smart Charging. If null, no part of the time range was impacted by Smart Charging.

date string<date-time>

The start date of this sample

smartSession boolean Deprecated

Sample

[
  {
    "kw": {
      "min": 0,
      "max": 78,
      "mean": 61
    },
    "kwhSum": 120,
    "price": {
      "min": 13.8,
      "max": 14.4,
      "mean": 14.1
    },
    "nonSmartPrice": {
      "min": 12.9,
      "max": 16.7,
      "mean": 14.8
    },
    "smartSession": true,
    "costSum": 3.14,
    "nonSmartCostSum": 4.21,
    "estimatedSavings": 1.07,
    "date": "2021-01-19T09:37:36.845Z"
  }
]

Get User Charging Sessions Statistics

Deprecated

GET /statistics/charging/sessions

Moved to /users/{userId}/statistics/charging/sessions.

Returns a list of statistics about power consumption and price for the User binned by sessions.

Request

Query parameters

startDate string Required

Earliest date to include in the response. Example: 2021-03-21T00:25:43.511Z

endDate string Optional

Latest date to include in the response (defaults to current date/time). Example: 2021-03-21T00:25:43.511Z

chargingLocationId string<uuid> Optional

Filter statistics to only include this charging location

targetType string Optional

Get statistics for this hardware type. If omitted, statistics for the vehicle hardware type will be returned.

One of charger, vehicle, or hvac

targetId string Optional

Filter statistics to only include a specific entity.

Response

200

Attributes

List of object array of object

object object

object

Aggregate statistics for charge rate in kW

kwhSum number

Total power consumption in kWh

object

Aggregate statistics for power price (<CURRENCY> per kWh)

costSum number

Total cost in <CURRENCY>

id string

ID for this session.

targetId string

ID of the hardware type for this session.

chargingLocationId string<uuid> or null

Charging Location ID for this session.

from string<date-time>

Start time.

to string<date-time>

End time.

smartSession boolean Deprecated

object

Sample

[
  {
    "kw": {
      "min": 0,
      "max": 0,
      "mean": 0
    },
    "kwhSum": 120,
    "price": {
      "min": 0,
      "max": 0,
      "mean": 0
    },
    "costSum": 3.14,
    "id": "string",
    "targetId": "string",
    "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
    "from": "2020-04-07T17:04:26Z",
    "to": "2020-04-07T17:04:26Z",
    "smartSession": true,
    "smartStats": {
      "nonSmartPrice": {
        "min": 0,
        "max": 0,
        "mean": 0
      },
      "estimatedSavings": 1.07,
      "nonSmartCostSum": 4.21
    }
  }
]

Get User Production Statistics

Deprecated

GET /statistics/production

Moved to /users/{userId}/statistics/production.

Returns a normalized time series of statistics about power production and price for the User.

Request

Query parameters

startDate string Required

Earliest date to include in the response. Example: 2021-03-21T00:25:43.511Z

endDate string Optional

Latest date to include in the response (defaults to current date/time). Example: 2021-03-21T00:25:43.511Z

chargingLocationId string<uuid> Optional

Filter statistics to only include this charging location

resolution string Optional

The unit of time the data will be cut into before aggregate statistics are applied. Each entry in the response array corresponds to aggregated data of the time range specified.

One of QUARTER_HOUR, HALF_HOUR, HOUR, DAY, WEEK, MONTH, or YEAR

utcOffset string<float> Deprecated Optional

Offset (in hours) from UTC to adjust the timezone for viewing statistics. By default, all timestamps are in UTC, and period boundaries (day, week, month, year) are calculated in UTC. Providing utcOffset aligns these to the viewer's timezone. Accepts positive, negative, and fractional values. Note: utcOffset has no effect with resolutions QUARTER_HOUR, HALF_HOUR, or HOUR.

Deprecated: The use of utcOffset is discouraged as it doesn't handle time zones adequately. All data will be bucketed in UTC if utcOffset is not provided.

type string Optional

Get statistics for this hardware type.

One of inverter

id string Optional

Filter statistics to only include a specific entity. Hardware category of the entity must match the type parameter.

Response

200

Attributes

List of object array of object

object object

object

Aggregate statistics for production rate in kW

kwhSum number

Total power production in kWh

object

Aggregate statistics for power price (<CURRENCY> per kWh)

earningsSum number

Total earnings in <CURRENCY>

date string<date-time>

The start date of this sample

Sample

[
  {
    "kw": {
      "min": 0,
      "max": 78,
      "mean": 61
    },
    "kwhSum": 120,
    "price": {
      "min": 13.8,
      "max": 14.4,
      "mean": 14.1
    },
    "earningsSum": 3.14,
    "date": "2021-01-19T09:37:36.845Z"
  }
]

Get Vendor Statistics For Inverters

DeprecatedBeta

GET /inverters/{inverterId}/vendor-statistics

Moved to /users/{userId}/vendor-statistics.

Returns statistics about power production for the given inverter in the form of a time series, collected from vendor APIs.

This endpoint is currently in beta, undergoing active development. Please be aware that errors, inaccuracies, and breaking changes may occur without prior notice. For testing the endpoint or more information, contact our Product Manager Kristine at kristine@enode.io.

Since the statistics data provided by the vendors starts and ends at well defined offsets, the returned time series may start/end at an earlier/later time than requested. E.g. if hourly statistics are requested with startDate = 2023-06-17T09:30:00Z, the returned time series will start at 2023-06-17T09:00:00Z. Currently, we only support querying for 1 month of data.

Please note that currently, requests may take a long time to complete.

Request

Path parameters

inverterId string Required

ID of the Inverter.

Query parameters

resolution string Required

The duration of each time bucket the returned time series is divided into. Each entry in the response array corresponds to aggregated data of the specified time range.

One of HOUR or DAY

startDate string<date-time> Required

The earliest date (UTC) to include in the response. Cannot be greater than endDate. Example: 2021-03-21T02:00:00Z

endDate string<date-time> Optional

The latest date (UTC) to include in the response. Defaults to the current date/time. Example: 2021-03-21T05:00:00Z

Response

200

Attributes

object

Contains information about power production statistics.

Sample

{
  "production": {
    "unit": "kWh",
    "data": [
      {
        "date": "2024-01-19T09:00:00.000Z",
        "value": 11.1
      },
      {
        "date": "2024-01-19T10:00:00.000Z",
        "value": 15.4
      }
    ]
  }
}

Tariffs

Use the Tariffs API to submit pricing information to Enode. These prices will be preferred over market prices in Enode's smart products, like Smart HVACAPI, and will be used to calculate costs in StatisticsAPI.

Get Tariff

GET /tariffs/{tariffId}

Get a tariff using its ID.

Request

Path parameters

tariffId string Required

Response

200

Attributes

List of object array of object

object object

name string

Per-tariff unique interval name

cost string

Rate cost (decimal string)

Sample

[
  {
    "name": "PEAK",
    "cost": "13.37"
  },
  {
    "name": "OFF-PEAK",
    "cost": "12.34"
  }
]

Create a Tariff

PUT /tariffs/{tariffId}

Create a tariff using a list of names and prices. Before the tariff can be used in Enode products, it must be linked to a locationAPI.

Request

Path parameters

tariffId string Required

Attributes

List of object array of object Optional

object object Optional

name string Required

Per-tariff unique interval name

cost string Required

Rate cost (decimal string)

Sample

[
  {
    "name": "PEAK",
    "cost": "13.37"
  },
  {
    "name": "OFF-PEAK",
    "cost": "12.34"
  }
]

Response

204

Successfully updated.

Link Tariff to Location

PUT /charging-locations/{chargingLocationId}/tariff

Link a tariff to a LocationAPI using a daily schedule. Each new schedule overwrites any previous requests. Devices positioned at this location will use the schedule to calculate electricity costs.The schedule must ensure that there are no overlapping intervals, although gaps are permissible. In case of gaps, the system will default to market prices.

Request

Path parameters

chargingLocationId string Required

ID of the ChargingLocation.

Attributes

tariffId string Required

The Tariff ID

array of Object Required

List of time intervals at which to apply the specified tariff rates.

Sample

{
  "tariffId": "string",
  "tariffIntervals": [
    {
      "name": "OFF-PEAK-WEEKDAY",
      "from": "00:00",
      "to": "12:00",
      "weekdays": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    {
      "name": "PEAK-WEEKDAY",
      "from": "12:00",
      "to": "24:00",
      "weekdays": [
        0,
        1,
        2,
        3,
        4
      ]
    },
    {
      "name": "OFF-PEAK-WEEKEND",
      "weekdays": [
        5,
        6
      ],
      "from": "00:00",
      "to": "06:00"
    },
    {
      "name": "PEAK-WEEKEND",
      "weekdays": [
        5,
        6
      ],
      "from": "06:00",
      "to": "24:00"
    }
  ]
}

Response

204

Successful

Other responses

Response 400

Overlapping tariff schedule. Ensure that the schedule has no overlaps.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Response 404

Location or tariff not found.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Tariff Schedule

GET /charging-locations/{chargingLocationId}/tariff

Get the tariff schedule linked to a location.

Request

Path parameters

chargingLocationId string Required

ID of the ChargingLocation.

Response

200

Attributes

List of object array of object

object object

weekday integer

Weekday to apply the named tariff. A weekday starts with 0 for Monday, and ends with 6 for Sunday. If not specified, named tariff is applied for entire week

One of 0, 1, 2, 3, 4, 5, or 6

fromHourMinute string

Interval from time (inclusive, UTC)

toHourMinute string

Interval to time (exclusive, UTC)

tariffId string

Energy Provider Tariff ID

tariffName string

Rate name

Sample

[
  {
    "weekday": 0,
    "fromHourMinute": "00:00",
    "toHourMinute": "18:00",
    "tariffId": "FLEX-TARIFF-A",
    "tariffName": "OFF-PEAK"
  },
  {
    "weekday": 0,
    "fromHourMinute": "18:00",
    "toHourMinute": "24:00",
    "tariffId": "FLEX-TARIFF-A",
    "tariffName": "PEAK"
  }
]

Other responses

Response 404

Location not found

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

User Management

Endpoints used to link and unlink users or vendors.

Link User

POST /users/{userId}/link

Creates an Enode Link session attached to the provided User ID. If this User does not exist, it will be created. The returned linkUrl gives a Link UI session that is valid for 24 hours.

Request

Path parameters

userId string Required

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.

Attributes

string Optional

Skip the vendor selection screen and present the credential input for a specific vendor immediately.

One of APSYSTEMS, CSISolar, Deye, ENPHASE, FOXESS, FRONIUS, GOODWE, GROWATT, Hoymiles, HUAWEI, INVT, SMA, SOFAR, SOLAREDGE, SOLAX, SOLIS, SOLPLANET, SUNGROW, SUNSYNK, TESLA, TSUN, AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, TADO, MILL, ADAX, ECOBEE, SENSIBO, HONEYWELL, RESIDEO, MITSUBISHI, MICROMATIC, NIBE, PANASONIC, TOSHIBA, DAIKIN, NEST, FUJITSU, BOSCH, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, ENPHASE, ENPHASE, or TESLA

One of

APSYSTEMSCSISolarDeyeENPHASEFOXESSFRONIUSGOODWEGROWATTHoymilesHUAWEIINVTSMASOFARSOLAREDGESOLAXSOLISSOLPLANETSUNGROWSUNSYNKTESLATSUNAUDIBMWHONDAHYUNDAIJAGUARLANDROVERKIAMERCEDESMININISSANPEUGEOTPORSCHERENAULTSEATSKODATESLAVOLKSWAGENVOLVOFORDOPELDSTOYOTALEXUSCITROENCUPRAVAUXHALLFIATRIVIANNIOCHEVROLETGMCCADILLACXPENGTADOMILLADAXECOBEESENSIBOHONEYWELLRESIDEOMITSUBISHIMICROMATICNIBEPANASONICTOSHIBADAIKINNESTFUJITSUBOSCHZAPTECEASEEWALLBOXEOCHARGEAMPSEVBOXGOECHARGEPOINTENELXTESLAENPHASEENPHASETESLA

vendorType string Optional

Sets the type of vendors available for connection in a Link UI session. If absent, this defaults to vehicle.

One of vehicle, charger, hvac, inverter, battery, or meter

extensible enum Optional

One of en, de, nb, sv, ja, es, fr, nl, ro, pt, fi, da, or <string>

scopes array of string Optional

The scope(s) you wish to request access to when linking an asset.

redirectUri string Optional

A URI to redirect the user to after successfully linking an asset. A user may also arrive at the redirect URI if they exited Link UI by clicking the X or denying permissions. In these cases, an error query param will be added to your redirect URI with the values of user closed session or consent request denied, respectively.

userName string Deprecated Optional

Sample

{
  "vendor": "AUDI",
  "vendorType": "vehicle",
  "forceLanguage": "en",
  "scopes": [
    "offline_access",
    "all"
  ],
  "redirectUri": "myapp://integrations/enode"
}

Response

200

Attributes

linkState string

linkUrl string

Sample

{
  "linkState": "ZjE2MzMxMGFiYmU4MzcxOTU1ZmRjMTU5NGU2ZmE4YTU3NjViMzIwY2YzNG",
  "linkUrl": "https://link.production.enode.io?link_state=YzIwZThhYjYtMjMzMi00ZTAyLTg0OTYtYzdjOTlhZTY3Zjc3QDI2YzI1MDExLTdhYTctNGE2NS1iNjBmLTZmMzc5NmRhODUyMDowNDViYjFiYmE0M2Y5NDU5YTc5OTgxZmEyYTg1NmI4YzhkOGU4YjgyNmNmMzQzZmFmMGNhZTlmNDBjMmZmOTgy&requested_scope=vehicle%3Alocation%20vehicle%3Aodometer&redirect_uri=myapp%3A%2F%2Fintegrations%2Fenode"
}

Other responses

Response 403

Connections limit reached for this client

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/forbidden",
  "title": "Connections limit reached.",
  "detail": "Unable to create more connections for ClientID: a7bedf14-c3eb-4c2b-a08f-b34a1f70808d"
}

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.

Request

Path parameters

userId string Required

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.

Response

204

No Content

Deauthorize User

DELETE /users/{userId}/authorization

Deletes the User's stored vendor authorizations and credentials, invalidates any associated sessions, authorization codes, and access/refresh tokens.

All other User data is retained, and if the User is sent through the Link User flow in the future, their account will be just as they left it.

No webhook events will be generated for a deauthorized user.

Request

Path parameters

userId string Required

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.

Response

204

No Content

Vehicles

EVs provide charge, location, and odometer data. Vehicles can be controlled either directly using the Control ChargingAPI endpoint, or through Smart Charging and Schedules.

List Vehicles

GET /vehicles

List all available Vehicles for the User.

If you already know the ID of a vehicle you want to fetch, it is recommended to fetch it using the more performant Get VehicleAPI method.

Request

Query parameters

string or array Deprecated Optional

Functionality moved in version 2023-08-01 to endpoint POST /chargers/{chargerId}/refresh-hint.

If you specify any fields here, we make a request to the Vehicle's OEM APIs and return the updated data.

This will slow down your integration. In cases of vendor downtime requests with fields may take up to a minute to complete, while requests without fields will always be fast. Enode polls all devices connected to our platform, so any cached data returned will not be older than 10 minutes (unless the vendor APIs are unavailable, in which case you can consult the lastSeen & isReachable fields on the vehicle).

Note that the field values capabilities & smartChargingPolicy are deprecated and will always be returned.

If no fields are included, and the latest cached full Vehicle object will be returned.

Response

200

Attributes

List of object array of object

object object

id string

Vehicle ID

userId string

The ID of the user that linked this vehicle.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

lastSeen string<date-time>

The last time Enode received live data or when the vehicle was initially linked.

isReachable boolean or null

Whether live data from the vehicle is currently available from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the vehicle's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the Vehicle.

object

Information about the electric or hybrid battery.

object

Smart Charging configuration properties. Configured via Update Vehicle Smart Charging PolicyAPI.

object

Vehicle's GPS coordinates with timestamp

object

Vehicle's odometer reading in kilometers with timestamp

object

A collection of descriptors that describe the capabilities of this specific vehicle

scopes array of string

Scopes that the user has granted for this vehicle.

chargingLocationId string<uuid> or null

ID of the charging location the vehicle is currently positioned at (if any).

Sample

[
  {
    "id": "05ee9df5-d072-4ee8-b773-399dec8f5693",
    "userId": "bb28471e-cde6-4eff-ace4-9a7f4f50882a",
    "vendor": "TESLA",
    "lastSeen": "2024-01-07T17:04:26.000Z",
    "isReachable": true,
    "information": {
      "vin": "2HGFB2F5XEH542858",
      "brand": "Tesla",
      "model": "Model S P85",
      "year": 2020,
      "id": "string"
    },
    "chargeState": {
      "batteryLevel": 66,
      "range": 228,
      "isPluggedIn": true,
      "isCharging": true,
      "isFullyCharged": false,
      "batteryCapacity": 48.1,
      "chargeLimit": 90,
      "chargeRate": 2,
      "chargeTimeRemaining": 285,
      "lastUpdated": "2020-04-07T17:04:26Z",
      "maxCurrent": 16,
      "powerDeliveryState": "PLUGGED_IN:CHARGING",
      "isChargingReasons": [
        "DEFAULT"
      ]
    },
    "smartChargingPolicy": {
      "isEnabled": false,
      "deadline": "07:00",
      "minimumChargeLimit": 0
    },
    "location": {
      "longitude": 10.7197486,
      "latitude": 59.9173985,
      "lastUpdated": "2024-01-07T17:04:26.000Z"
    },
    "odometer": {
      "distance": 65393,
      "lastUpdated": "2024-01-07T17:04:26.000Z"
    },
    "capabilities": {
      "information": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "chargeState": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "location": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "odometer": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "setMaxCurrent": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "startCharging": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "stopCharging": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      },
      "smartCharging": {
        "isCapable": false,
        "interventionIds": [
          "4eaeb363-296d-4ccc-a973-7805e6f400bd"
        ]
      }
    },
    "scopes": [
      "vehicle:control:charging",
      "vehicle:read:data",
      "vehicle:read:location"
    ],
    "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
  }
]

Other responses

Response 206

Partial Content: The requested vehicle fields could not be fetched, and a cached copy of the data is returned as the response.

Attributes

id string

Vehicle ID

userId string

The ID of the user that linked this vehicle.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

lastSeen string<date-time>

The last time Enode received live data or when the vehicle was initially linked.

isReachable boolean or null

Whether live data from the vehicle is currently available from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the vehicle's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the Vehicle.

object

Information about the electric or hybrid battery.

object

Smart Charging configuration properties. Configured via Update Vehicle Smart Charging PolicyAPI.

object

Vehicle's GPS coordinates with timestamp

object

Vehicle's odometer reading in kilometers with timestamp

object

A collection of descriptors that describe the capabilities of this specific vehicle

scopes array of string

Scopes that the user has granted for this vehicle.

chargingLocationId string<uuid> or null

ID of the charging location the vehicle is currently positioned at (if any).

Sample

{
  "id": "05ee9df5-d072-4ee8-b773-399dec8f5693",
  "userId": "bb28471e-cde6-4eff-ace4-9a7f4f50882a",
  "vendor": "TESLA",
  "lastSeen": "2024-01-07T17:04:26.000Z",
  "isReachable": true,
  "information": {
    "vin": "2HGFB2F5XEH542858",
    "brand": "Tesla",
    "model": "Model S P85",
    "year": 2020,
    "id": "string"
  },
  "chargeState": {
    "batteryLevel": 66,
    "range": 228,
    "isPluggedIn": true,
    "isCharging": true,
    "isFullyCharged": false,
    "batteryCapacity": 48.1,
    "chargeLimit": 90,
    "chargeRate": 2,
    "chargeTimeRemaining": 285,
    "lastUpdated": "2020-04-07T17:04:26Z",
    "maxCurrent": 16,
    "powerDeliveryState": "PLUGGED_IN:CHARGING",
    "isChargingReasons": [
      "DEFAULT"
    ]
  },
  "smartChargingPolicy": {
    "isEnabled": false,
    "deadline": "07:00",
    "minimumChargeLimit": 0
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "odometer": {
    "distance": 65393,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "capabilities": {
    "information": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "chargeState": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "location": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "odometer": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "setMaxCurrent": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "startCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "stopCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "smartCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "scopes": [
    "vehicle:control:charging",
    "vehicle:read:data",
    "vehicle:read:location"
  ],
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Get Vehicle

GET /vehicles/{vehicleId}

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Query parameters

string or array Deprecated Optional

Functionality moved in version 2023-08-01 to endpoint POST /chargers/{chargerId}/refresh-hint.

If you specify any fields here, we make a request to the Vehicle's OEM APIs and return the updated data.

This will slow down your integration. In cases of vendor downtime requests with fields may take up to a minute to complete, while requests without fields will always be fast. Enode polls all devices connected to our platform, so any cached data returned will not be older than 10 minutes (unless the vendor APIs are unavailable, in which case you can consult the lastSeen & isReachable fields on the vehicle).

Note that the field values capabilities & smartChargingPolicy are deprecated and will always be returned.

If no fields are included, and the latest cached full Vehicle object will be returned.

Response

200

Attributes

id string

Vehicle ID

userId string

The ID of the user that linked this vehicle.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

lastSeen string<date-time>

The last time Enode received live data or when the vehicle was initially linked.

isReachable boolean or null

Whether live data from the vehicle is currently available from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the vehicle's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the Vehicle.

object

Information about the electric or hybrid battery.

object

Smart Charging configuration properties. Configured via Update Vehicle Smart Charging PolicyAPI.

object

Vehicle's GPS coordinates with timestamp

object

Vehicle's odometer reading in kilometers with timestamp

object

A collection of descriptors that describe the capabilities of this specific vehicle

scopes array of string

Scopes that the user has granted for this vehicle.

chargingLocationId string<uuid> or null

ID of the charging location the vehicle is currently positioned at (if any).

Sample

{
  "id": "05ee9df5-d072-4ee8-b773-399dec8f5693",
  "userId": "bb28471e-cde6-4eff-ace4-9a7f4f50882a",
  "vendor": "TESLA",
  "lastSeen": "2024-01-07T17:04:26.000Z",
  "isReachable": true,
  "information": {
    "vin": "2HGFB2F5XEH542858",
    "brand": "Tesla",
    "model": "Model S P85",
    "year": 2020,
    "id": "string"
  },
  "chargeState": {
    "batteryLevel": 66,
    "range": 228,
    "isPluggedIn": true,
    "isCharging": true,
    "isFullyCharged": false,
    "batteryCapacity": 48.1,
    "chargeLimit": 90,
    "chargeRate": 2,
    "chargeTimeRemaining": 285,
    "lastUpdated": "2020-04-07T17:04:26Z",
    "maxCurrent": 16,
    "powerDeliveryState": "PLUGGED_IN:CHARGING",
    "isChargingReasons": [
      "DEFAULT"
    ]
  },
  "smartChargingPolicy": {
    "isEnabled": false,
    "deadline": "07:00",
    "minimumChargeLimit": 0
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "odometer": {
    "distance": 65393,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "capabilities": {
    "information": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "chargeState": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "location": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "odometer": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "setMaxCurrent": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "startCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "stopCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "smartCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "scopes": [
    "vehicle:control:charging",
    "vehicle:read:data",
    "vehicle:read:location"
  ],
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Other responses

Response 206

Partial Content: The requested vehicle fields could not be fetched, and a cached copy of the data is returned as the response.

Attributes

id string

Vehicle ID

userId string

The ID of the user that linked this vehicle.

vendor string

Machine-friendly name of the vendor. Use this in API requests.

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

lastSeen string<date-time>

The last time Enode received live data or when the vehicle was initially linked.

isReachable boolean or null

Whether live data from the vehicle is currently available from Enode's perspective. This 'reachability' may refer to reading from a cache operated by the vehicle's cloud service if that service has determined that its cache is valid.

object

Descriptive information about the Vehicle.

object

Information about the electric or hybrid battery.

object

Smart Charging configuration properties. Configured via Update Vehicle Smart Charging PolicyAPI.

object

Vehicle's GPS coordinates with timestamp

object

Vehicle's odometer reading in kilometers with timestamp

object

A collection of descriptors that describe the capabilities of this specific vehicle

scopes array of string

Scopes that the user has granted for this vehicle.

chargingLocationId string<uuid> or null

ID of the charging location the vehicle is currently positioned at (if any).

Sample

{
  "id": "05ee9df5-d072-4ee8-b773-399dec8f5693",
  "userId": "bb28471e-cde6-4eff-ace4-9a7f4f50882a",
  "vendor": "TESLA",
  "lastSeen": "2024-01-07T17:04:26.000Z",
  "isReachable": true,
  "information": {
    "vin": "2HGFB2F5XEH542858",
    "brand": "Tesla",
    "model": "Model S P85",
    "year": 2020,
    "id": "string"
  },
  "chargeState": {
    "batteryLevel": 66,
    "range": 228,
    "isPluggedIn": true,
    "isCharging": true,
    "isFullyCharged": false,
    "batteryCapacity": 48.1,
    "chargeLimit": 90,
    "chargeRate": 2,
    "chargeTimeRemaining": 285,
    "lastUpdated": "2020-04-07T17:04:26Z",
    "maxCurrent": 16,
    "powerDeliveryState": "PLUGGED_IN:CHARGING",
    "isChargingReasons": [
      "DEFAULT"
    ]
  },
  "smartChargingPolicy": {
    "isEnabled": false,
    "deadline": "07:00",
    "minimumChargeLimit": 0
  },
  "location": {
    "longitude": 10.7197486,
    "latitude": 59.9173985,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "odometer": {
    "distance": 65393,
    "lastUpdated": "2024-01-07T17:04:26.000Z"
  },
  "capabilities": {
    "information": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "chargeState": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "location": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "odometer": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "setMaxCurrent": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "startCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "stopCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    },
    "smartCharging": {
      "isCapable": false,
      "interventionIds": [
        "4eaeb363-296d-4ccc-a973-7805e6f400bd"
      ]
    }
  },
  "scopes": [
    "vehicle:control:charging",
    "vehicle:read:data",
    "vehicle:read:location"
  ],
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Control Charging

POST /vehicles/{vehicleId}/charging

Request for a vehicle to start or stop charging. This request creates an Action that will retry until the vehicle's powerDeliveryState matches the expected value. The Action must complete before any further commands are sent to the vehicle. If a PENDING action for the same target and type already exists, it will be reused and a new action will not be created. If the new Action has a different target or type, the existing Action will be automatically transitioned to the CANCELLED state and a new Action will be created. Transitions can be tracked via the user:vendor-action:updated webhook event or Get Vehicle ActionAPI.

This endpoint returns an error with status code 422 if the vehicle is controlled by a schedule or has an active smart charging plan. To restore user control, either disable the schedule, disable smart charging, or use Create Smart OverrideAPI to temporarily enable charging.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Attributes

action string Required

Charging action to perform

One of START or STOP

Sample

{
  "action": "START"
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

Other responses

Response 400

A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the vehicle cannot perform the action, is fully charged, or is already in the desired state.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Response 422

Vehicle controlled by a Schedule or has active Smart Charging Plan

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Set Max Current

Beta

POST /vehicles/{vehicleId}/max-current

Experimental: 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 vehicles'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.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Attributes

maxCurrent number Required

Desired max current in ampere

Sample

{
  "maxCurrent": 10
}

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the entity which this action is controlling.

targetType string

One of vehicle or charger

object

Target maximum current for entity

object or null

Information about why was this action not executed successfully.

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "string",
  "targetType": "vehicle",
  "targetState": {
    "maxCurrent": 10
  },
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  }
}

Other responses

Response 400

A precondition check failed that is unlikely to change within the action's timeout window. This occurs if the vehicle cannot perform the action.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Vehicle Action

GET /vehicles/actions/{actionId}

Returns the current state of the requested Action.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

targetType string

One of vehicle

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string",
  "targetType": "vehicle"
}

Other responses

Response 404

Action not found.

Cancel Vehicle Action

POST /vehicles/actions/{actionId}/cancel

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.

Request

Path parameters

actionId string Required

ID of the Action.

Response

200

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

Other responses

Response 404

Action not found.

Response 409

Action already in a resolved state.

Attributes

id string<uuid>

The ID of the action.

userId string

The ID of the user that owns the target of this action.

createdAt string<date-time>

Time when this action was created

updatedAt string<date-time>

Time when this action was last updated

completedAt string<date-time>

Time when the action transitioned to a non-pending state.

state string

The real-time status of an action executed on a target.

PENDING: The initial state. Enode is actively sending commands and monitoring the target for changes.
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.

One of PENDING, CONFIRMED, FAILED, or CANCELLED

targetId string

ID of the target which this action is controlling.

targetType string

One of vehicle or charger

kind string

The charging action to perform

One of START or STOP

object or null

Information about why was this action not executed successfully.

entityId string Deprecated

Replaced by targetId

entityType string Deprecated

Replaced by targetType

chargeableId string Deprecated

Replaced by targetId

chargeableType string Deprecated

Replaced by targetType

Sample

{
  "id": "4eaeb363-296d-4ccc-a973-7805e6f400bd",
  "userId": "d5bd4771-864e-4ae5-b913-dfb5cdcd5772",
  "createdAt": "2020-04-07T17:04:26Z",
  "updatedAt": "2020-04-07T17:04:26Z",
  "completedAt": "2020-04-07T17:04:26Z",
  "state": "PENDING",
  "targetId": "bfbccded-8a1c-45a8-bbda-dcaeef29977a",
  "targetType": "vehicle",
  "kind": "START",
  "failureReason": {
    "type": "NO_RESPONSE",
    "detail": "The chargeable device remained unreachable."
  },
  "entityId": "string",
  "entityType": "string",
  "chargeableId": "string",
  "chargeableType": "string"
}

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.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

204

Refresh hint registered successfully.

Other responses

Response 404

The specified vehicle was not found.

Create External Start

Deprecated

POST /vehicles/{vehicleId}/external-start

Deprecated. Replaced by Create Smart OverrideAPI. The new name better reflects the functionality this endpoint offers.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetType string

One of vehicle or charger

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetType": "vehicle",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA"
}

End External Start

Deprecated

DELETE /vehicles/{vehicleId}/external-start

Deprecated. Replaced by End Smart OverrideAPI. The new name better reflects the functionality this endpoint offers.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetType string

One of vehicle or charger

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetType": "vehicle",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA"
}

Other responses

Response 404

No External Start Exists

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Smart Charging Plan

GET /vehicles/{vehicleId}/smart-charging-plans/{smartChargingPlanId}

Check status of current or historical Smart Charging Plans for a Vehicle. Returns a Smart Charging Plan for this vehicle.

To fetch the most recently created Plan, call the endpoint with smartChargingPlanId set to latest.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

smartChargingPlanId string Required

ID of the Smart Charging Plan

Response

200

Attributes

id string

ID of the Smart Charging Plan

vehicleId string

ID of the Vehicle to which the Smart Charging Plan belongs

userId string

ID of the User to which the Smart Charging Plan belongs

locationId string<uuid> or null

ID of the charging location at which the Smart Charging Plan is being executed. Null for Smart Charging Plans started before March 2022.

vendor string

Vendor of the Vehicle to which the Smart Charging Plan belongs

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

currency string

Currency in which monetary amounts are denominated (ISO 4217 3-character Alpha code)

nonSmartCost number

Estimated cost of charging, if smart charging were not on for the vehicle

smartCost number

Estimated cost of charging, achieved by this Smart Charging Plan

stopAt string<date-time>

Time at which the current Smart Charging Plan will stop the vehicle's charging. The charging will be resumed when prices are optimal.

startAt string<date-time>

Time at which the current Smart Charging Plan will resume the vehicle's charging, when prices are optimal.

estimatedFinishAt string<date-time>

Time at which charging is estimated to be complete, due to the current Smart Charging Plan

stopConfirmedAt string<date-time>

During a Smart Charging Plan, the first time at which the vehicle's charging was confirmed as stopped. If a vehicle stops charging outside of smart charging's control (e.g., via a 3rd party app), this will be populated with that timestamp.

startConfirmedAt string<date-time>

During a Smart Charging Plan, the first time at which the vehicle's charging was confirmed as started. If a vehicle starts charging outside of smart charging's control (e.g., via a 3rd party app), this will be populated with that timestamp.

endedAt string<date-time>

The time at which the Smart Charging Plan ended

finalState string or null

The final state of the Smart Charging Plan when it ended

One of PLAN:ENDED:FINISHED, PLAN:ENDED:UNPLUGGED, PLAN:ENDED:FAILED, PLAN:ENDED:DISABLED, or PLAN:ENDED:DEADLINE_CHANGED

failureCondition string

If the finalState was PLAN:ENDED:FAILED, failureCondition is populated with the condition in which the Smart Charging Plan failed. If the finalState was PLAN:ENDED:FINISHED, failureCondition is populated with FINISHED_LATE if the plan was more than 15% late.

One of STOP_FAILED, START_FAILED, FINISHED_LATE, UNKNOWN, or CHARGE_INTERRUPTED

object or null Deprecated

Deprecated, replaced by smartOverride from Get Vehicle Smart Charging StatusAPI

chargingLocationId string<uuid> or null Deprecated

Deprecated. Replaced by locationId. ID of the charging location at which the Smart Charging Plan is being executed. Null for Smart Charging Plans started before March 2022.

Sample

{
  "id": "53559d39-019a-443b-a2a7-a2ca29f54d4b",
  "vehicleId": "4b5ada14-ea87-4ca1-aab9-3c979c34cf4a",
  "userId": "3b568b76-e30a-426e-aacd-609db4d7be81",
  "locationId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendor": "string",
  "currency": "USD",
  "nonSmartCost": 17.2,
  "smartCost": 12.8,
  "stopAt": "2020-04-07T17:04:26Z",
  "startAt": "2020-04-07T17:04:26Z",
  "estimatedFinishAt": "2020-04-07T17:04:26Z",
  "stopConfirmedAt": "2020-04-07T17:04:26Z",
  "startConfirmedAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "finalState": "PLAN:ENDED:FINISHED",
  "failureCondition": "CHARGE_INTERRUPTED",
  "externalStart": {
    "createdAt": "2020-04-07T17:04:26Z",
    "endedAt": "2020-04-07T17:04:26Z",
    "targetType": "vehicle",
    "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
    "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f"
  },
  "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
}

Get Vehicle Smart Charging Policy

GET /vehicles/{vehicleId}/smart-charging-policy

Get a vehicle's Smart Charging policy

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

isEnabled boolean

When enabled, this vehicle's charging status may be controlled by Smart Charging

deadline string

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 charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

minimumChargeLimit number

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.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "minimumChargeLimit": 0
}

Update Vehicle Smart Charging Policy

PUT /vehicles/{vehicleId}/smart-charging-policy

Updates the Smart Charging policy for a vehicle

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Attributes

isEnabled boolean Optional

When enabled, this vehicle's charging status may be controlled by Smart Charging

deadline string Optional

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 charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

minimumChargeLimit number Optional

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.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "minimumChargeLimit": 0
}

Response

200

Attributes

isEnabled boolean

When enabled, this vehicle's charging status may be controlled by Smart Charging

deadline string

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 charging location at which the smart charging occurs, the deadline is interpreted in that timezone, otherwise UTC is used.

minimumChargeLimit number

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.

Sample

{
  "isEnabled": false,
  "deadline": "07:00",
  "minimumChargeLimit": 0
}

Create Smart Override

POST /vehicles/{vehicleId}/smart-override

Overrides an active smart feature by forcing the vehicle to start charging. This feature is meant to be used in situations where the user wants to charge immediately without disabling other smart features. The override remains active until the vehicle stops charging, or until End Smart OverrideAPI is called. When the override ends, the overriden smart feature will regain control of the vehicle. This endpoint should not be used for standard charge control, use Control ChargingAPI instead.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetType string

One of vehicle or charger

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetType": "vehicle",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA"
}

End Smart Override

DELETE /vehicles/{vehicleId}/smart-override

Ends any active Smart Override for the vehicle specified by vehicleId. If previously configured, Schedules or Smart Charging will resume control over the target vehicle. Note that this does not mean the vehicle will stop charging, only that it will return to the state expected by the active Schedule or Smart Charging Plan.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

createdAt string<date-time>

Time at which the smart override was created.

endedAt string<date-time>

Time at which the smart override was ended. If null, the smart override is still active.

targetType string

One of vehicle or charger

targetId string

ID of the target which this smart override is affecting.

vendorActionId string<uuid> or null

The ID of the Action responsible for starting charging on the target. Use the Get Vehicle ActionAPI or the Get Charger ActionAPI endpoints to monitor action results.

userId string

ID of the User

string

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, XPENG, ZAPTEC, EASEE, WALLBOX, EO, CHARGEAMPS, EVBOX, GOE, CHARGEPOINT, ENELX, TESLA, or ENPHASE

Sample

{
  "createdAt": "2020-04-07T17:04:26Z",
  "endedAt": "2020-04-07T17:04:26Z",
  "targetType": "vehicle",
  "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
  "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f",
  "userId": "0bec82e0-0d54-4f2f-83b1-5b248604de0b",
  "vendor": "TESLA"
}

Other responses

Response 404

No Smart Override Exists

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/im-a-teapot",
  "title": "I'm a teapot",
  "detail": "The requested entity body is short and stout."
}

Get Vehicle Smart Charging Status

GET /vehicles/{vehicleId}/smart-charging-status

Every vehicle in Enode has a Smart Charging Status that describes the vehicle in terms of smart charging.

Request

Path parameters

vehicleId string Required

ID of the Vehicle.

Response

200

Attributes

updatedAt string<date-time>

Time when the Smart Charging Status was recalculated, irrespective of whether or not any values changed

vehicleId string

ID of the vehicle to which this Smart Charging Status represents

userId string

ID of the user that owns this vehicle

vendor string

Vendor of the Vehicle

One of AUDI, BMW, HONDA, HYUNDAI, JAGUAR, LANDROVER, KIA, MERCEDES, MINI, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, TESLA, VOLKSWAGEN, VOLVO, FORD, OPEL, DS, TOYOTA, LEXUS, CITROEN, CUPRA, VAUXHALL, FIAT, RIVIAN, NIO, CHEVROLET, GMC, CADILLAC, or XPENG

state string

An enum value that describes the current SmartCharging state of the vehicle. Every vehicle is in exactly one state, at all times

One of DISABLED, CONSIDERING, UNKNOWN, PLAN:EXECUTING:STOPPING, PLAN:EXECUTING:STOP_FAILED, PLAN:EXECUTING:STOPPED, PLAN:EXECUTING:STOPPED:AWAITING_PRICES, PLAN:EXECUTING:STARTING, PLAN:EXECUTING:START_FAILED, PLAN:EXECUTING:STARTED, PLAN:EXECUTING:CHARGE_INTERRUPTED, PLAN:EXECUTING:OVERRIDDEN, PLAN:ENDED:FINISHED, PLAN:ENDED:UNPLUGGED, PLAN:ENDED:FAILED, PLAN:ENDED:DISABLED, or PLAN:ENDED:DEADLINE_CHANGED

stateChangedAt string<date-time>

Time when the state property transitioned to its current value

object or null

null by default, but during the CONSIDERING state, the value is populated with a list of all the requirements that must be true before a plan will be created

object or null

null by default, but during all of the PLAN:* states, the value is populated with a description of the active plan

object or null

This field populates after using Vehicle Create Smart OverrideAPI or Charger Create Smart OverrideAPI. Once populated, the target enters an overridden state, stopping Enode from sending Smart Charging actions. The Smart Override persists until the target ceases charging for any reason or is manually ended via Vehicle End Smart OverrideAPI or Charger End Smart OverrideAPI.

Sample

{
  "updatedAt": "2020-04-07T17:04:26Z",
  "vehicleId": "4b5ada14-ea87-4ca1-aab9-3c979c34cf4a",
  "userId": "3b568b76-e30a-426e-aacd-609db4d7be81",
  "vendor": "string",
  "state": "DISABLED",
  "stateChangedAt": "2020-04-07T17:04:26Z",
  "consideration": {
    "isSmartChargeCapable": true,
    "isPluggedIn": true,
    "isCharging": true,
    "recentlyAtChargingLocation": true,
    "hasTimeEstimate": true,
    "singleUser": true,
    "needsSignificantCharge": true,
    "hasChargeAboveThreshold": true,
    "wontStopExistingChargingSession": true,
    "likelyToGenerateSavings": true
  },
  "plan": {
    "id": "53559d39-019a-443b-a2a7-a2ca29f54d4b",
    "vehicleId": "4b5ada14-ea87-4ca1-aab9-3c979c34cf4a",
    "userId": "3b568b76-e30a-426e-aacd-609db4d7be81",
    "locationId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
    "vendor": "string",
    "currency": "USD",
    "nonSmartCost": 17.2,
    "smartCost": 12.8,
    "stopAt": "2020-04-07T17:04:26Z",
    "startAt": "2020-04-07T17:04:26Z",
    "estimatedFinishAt": "2020-04-07T17:04:26Z",
    "stopConfirmedAt": "2020-04-07T17:04:26Z",
    "startConfirmedAt": "2020-04-07T17:04:26Z",
    "endedAt": "2020-04-07T17:04:26Z",
    "finalState": "PLAN:ENDED:FINISHED",
    "failureCondition": "CHARGE_INTERRUPTED",
    "externalStart": {
      "createdAt": "2020-04-07T17:04:26Z",
      "endedAt": "2020-04-07T17:04:26Z",
      "targetType": "vehicle",
      "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
      "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f"
    },
    "chargingLocationId": "4eaeb363-296d-4ccc-a973-7805e6f400bd"
  },
  "smartOverride": {
    "createdAt": "2020-04-07T17:04:26Z",
    "endedAt": "2020-04-07T17:04:26Z",
    "targetType": "vehicle",
    "targetId": "07f8368d-be7e-4dbd-8cf0-94d00dd67ad3",
    "vendorActionId": "213ae0a8-fb65-40be-981a-6a86df3e1c7f"
  }
}

Webhooks

Webhooks are a mechanism that allows your server to receive notifications of events from the Enode system.

See the related guide for more information about timeouts, failures, and retry logic: Using Webhooks

Update Firehose Webhook

Deprecated

PUT /webhooks/firehose

Request

Attributes

secret string Required

A cryptographically secure secret, generated and provided by your client. Refer to Generating a secret for details on how to do this.

url string Required

The HTTPS URL where webhook payloads should be sent to.

Sample

{
  "secret": "0Kvs1tAUQ69FOMBiWlt5XJSrruXMhWDiVbyrWaNm",
  "url": "https://example.com/enode-webhooks/firehose"
}

Response

204

No Content

Delete Firehose Webhook

Deprecated

DELETE /webhooks/firehose

Request

Attributes

url string Required

The HTTPS url of the webhook to be deleted

Sample

{
  "url": "https://example.com/enode-webhooks/firehose"
}

Response

204

No Content

Other responses

Response 404

Webhook not found

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/not-found",
  "title": "Webhook not found",
  "detail": "Could not find webhook 0ec3d927-0100-44ff-bb53-edfe3ce64a57"
}

Test Firehose Webhook

Deprecated

POST /webhooks/firehose/test

Trigger a enode:firehose:test payload to be sent to your configured Webhook URL. This will reset your webhook to a healthy state on success.

Response

200

Attributes

status string

Indicates if the test webhook event was delivered successfully to your configured webhook endpoint.

One of SUCCESS or FAILURE

description string

Human readable description of the test outcome.

object or null

Null if status is FAILED.

Sample

{
  "status": "SUCCESS",
  "description": "string",
  "response": {
    "code": 200,
    "body": "{}",
    "headers": [
      "content-type: application/json; } charset=utf-8"
    ]
  }
}

Create Webhook

POST /webhooks

Create a webhook.

Request

Attributes

url string Required

The HTTPS URL that webhook payloads should be sent to.

secret string Required

A cryptographically secure secret, generated and provided by your client. Refer to Generating a secret for details on how to do this.

apiVersion string Optional

If provided, webhook payloads will be generated for this version. If not provided, the default API version of the client will be used when generating webhook payloads.

One of 2023-01-01, 2030-01-01, 2023-02-01, 2023-03-01, 2023-04-01, 2023-04-15, 2023-05-01, 2023-08-01, or 2024-01-01

events array of string Optional

The events which will trigger the webhook. Available events: *, user:vehicle:discovered, user:vehicle:updated, user:vehicle:deleted, user:vehicle:smart-charging-status-updated, user:charge-action:updated, user:vendor-action:updated, user:schedule:execution-updated, user:charger:discovered, user:charger:updated, user:charger:deleted, user:hvac:discovered, user:hvac:updated, user:hvac:deleted, user:inverter:discovered, user:inverter:updated, user:inverter:deleted, user:credentials:invalidated, user:battery:discovered, user:battery:updated, user:battery:deleted, enode:webhook:test, user:meter:discovered, user:meter:updated, user:meter:deleted

object Optional

If provided, the authentication header will be sent with each webhook request.

Sample

{
  "url": "https://example.com/enode-webhooks/firehose",
  "secret": "0Kvs1tAUQ69FOMBiWlt5XJSrruXMhWDiVbyrWaNm",
  "apiVersion": "2023-08-01",
  "events": [
    "user:vehicle:discovered",
    "user:vehicle:updated",
    "user:vehicle:deleted"
  ],
  "authentication": {
    "headerName": "x-api-key",
    "headerValue": "AOIxcVLKxR2VpzlN5HIk14oPu80"
  }
}

Response

200

Attributes

id string

Unique identifier for the webhook.

url string

The HTTPS URL that webhook payloads should be sent to.

events array of string

The events which will trigger the webhook.

lastSuccess string

Time when a delivery to this webhook was last successful.

isActive boolean

Indicates whether the webhook is active or not.

createdAt string

Time when the webhook was created.

apiVersion string or null

API version of the payload. If null, the default API version of the client will be used when generating webhook payloads.

object or null

Sample

{
  "id": "1de1as-dsa12wed-15sa",
  "url": "https://example.com/enode-webhooks/firehose",
  "events": [
    "user:vehicle:discovered",
    "user:vehicle:updated",
    "user:vehicle:deleted"
  ],
  "lastSuccess": "14-08-2023T13:01:00.000Z",
  "isActive": true,
  "createdAt": "14-08-2023T13:01:00.000Z",
  "apiVersion": "2023-08-01",
  "authentication": {
    "headerName": "string"
  }
}

Other responses

Response 400

Webhook already exists.

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/bad-request",
  "title": "Webhook already exists.",
  "detail": "A webhook with the specified URL and API version already exists."
}

List Webhooks

GET /webhooks

Returns a paginated list of webhooks.

Response

200

Attributes

array of Object

Paginated list of webhooks.

object

Cursors to the pages before and after current page. See the PaginationAPI section for reference.

Sample

{
  "data": [
    {
      "id": "1de1as-dsa12wed-15sa",
      "url": "https://example.com/enode-webhooks/firehose",
      "events": [
        "user:vehicle:discovered",
        "user:vehicle:updated",
        "user:vehicle:deleted"
      ],
      "lastSuccess": "14-08-2023T13:01:00.000Z",
      "isActive": true,
      "createdAt": "14-08-2023T13:01:00.000Z",
      "apiVersion": "2023-08-01",
      "authentication": {
        "headerName": "string"
      }
    }
  ],
  "pagination": {
    "after": "MjAyMy0wNy0xOFQxMDowODowMi4zNzNa",
    "before": "MjAyMy0wNi0xNlQwOTowMzowMS4yNjJa"
  }
}

Update Webhook

PATCH /webhooks/{webhookId}

Update a webhook.

Request

Path parameters

webhookId string Required

ID of the Webhook.

Attributes

url string Optional

The HTTPS URL that webhook payloads should be sent to.

secret string Optional

A cryptographically secure secret, generated and provided by your client. Refer to Generating a secret for details on how to do this.

events array of string Optional

The events which will trigger the webhook. Available events: *, user:vehicle:discovered, user:vehicle:updated, user:vehicle:deleted, user:vehicle:smart-charging-status-updated, user:charge-action:updated, user:vendor-action:updated, user:schedule:execution-updated, user:charger:discovered, user:charger:updated, user:charger:deleted, user:hvac:discovered, user:hvac:updated, user:hvac:deleted, user:inverter:discovered, user:inverter:updated, user:inverter:deleted, user:credentials:invalidated, user:battery:discovered, user:battery:updated, user:battery:deleted, enode:webhook:test, user:meter:discovered, user:meter:updated, user:meter:deleted

apiVersion string or null Optional

If provided, webhook payloads will be generated for this version. If null, the default API version of the client will be used when generating webhook payloads.

One of 2023-01-01, 2030-01-01, 2023-02-01, 2023-03-01, 2023-04-01, 2023-04-15, 2023-05-01, 2023-08-01, or 2024-01-01

object or null Optional

If provided, the authentication header will be sent with each webhook request.

Sample

{
  "url": "https://example.com/enode-webhooks/firehose",
  "secret": "0Kvs1tAUQ69FOMBiWlt5XJSrruXMhWDiVbyrWaNm",
  "events": [
    "user:vehicle:discovered",
    "user:vehicle:updated",
    "user:vehicle:deleted"
  ],
  "apiVersion": "2023-08-01",
  "authentication": {
    "headerName": "x-api-key",
    "headerValue": "AOIxcVLKxR2VpzlN5HIk14oPu80"
  }
}

Response

200

Attributes

id string

Unique identifier for the webhook.

url string

The HTTPS URL that webhook payloads should be sent to.

events array of string

The events which will trigger the webhook.

lastSuccess string

Time when a delivery to this webhook was last successful.

isActive boolean

Indicates whether the webhook is active or not.

createdAt string

Time when the webhook was created.

apiVersion string or null

API version of the payload. If null, the default API version of the client will be used when generating webhook payloads.

object or null

Sample

{
  "id": "1de1as-dsa12wed-15sa",
  "url": "https://example.com/enode-webhooks/firehose",
  "events": [
    "user:vehicle:discovered",
    "user:vehicle:updated",
    "user:vehicle:deleted"
  ],
  "lastSuccess": "14-08-2023T13:01:00.000Z",
  "isActive": true,
  "createdAt": "14-08-2023T13:01:00.000Z",
  "apiVersion": "2023-08-01",
  "authentication": {
    "headerName": "string"
  }
}

Other responses

Response 404

Webhook not found or already deleted

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/not-found",
  "title": "Webhook not found",
  "detail": "Could not find webhook 0ec3d927-0100-44ff-bb53-edfe3ce64a57"
}

Get Webhook

GET /webhooks/{webhookId}

Returns webhook with the given ID, if it exists.

Request

Path parameters

webhookId string Required

ID of the Webhook.

Response

200

Attributes

id string

Unique identifier for the webhook.

url string

The HTTPS URL that webhook payloads should be sent to.

events array of string

The events which will trigger the webhook.

lastSuccess string

Time when a delivery to this webhook was last successful.

isActive boolean

Indicates whether the webhook is active or not.

createdAt string

Time when the webhook was created.

apiVersion string or null

API version of the payload. If null, the default API version of the client will be used when generating webhook payloads.

object or null

Sample

{
  "id": "1de1as-dsa12wed-15sa",
  "url": "https://example.com/enode-webhooks/firehose",
  "events": [
    "user:vehicle:discovered",
    "user:vehicle:updated",
    "user:vehicle:deleted"
  ],
  "lastSuccess": "14-08-2023T13:01:00.000Z",
  "isActive": true,
  "createdAt": "14-08-2023T13:01:00.000Z",
  "apiVersion": "2023-08-01",
  "authentication": {
    "headerName": "string"
  }
}

Other responses

Response 404

Webhook not found or already deleted

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/not-found",
  "title": "Webhook not found",
  "detail": "Could not find webhook 0ec3d927-0100-44ff-bb53-edfe3ce64a57"
}

Delete Webhook

DELETE /webhooks/{webhookId}

Deletes webhook with the given ID, if it exists.

Request

Path parameters

webhookId string Required

ID of the Webhook.

Response

204

Successfully deleted

Other responses

Response 404

Webhook not found or already deleted

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/not-found",
  "title": "Webhook not found",
  "detail": "Could not find webhook 0ec3d927-0100-44ff-bb53-edfe3ce64a57"
}

Test Webhook

POST /webhooks/{webhookId}/test

Send a enode:webhook:test payload to the webhook. If the webhook is inactive, it'll be reactivated on success.

Request

Path parameters

webhookId string Required

ID of the Webhook.

Response

200

Attributes

status string

Indicates if the test webhook event was delivered successfully to your configured webhook endpoint.

One of SUCCESS or FAILURE

description string

Human readable description of the test outcome.

object or null

Null if status is FAILED.

Sample

{
  "status": "SUCCESS",
  "description": "string",
  "response": {
    "code": 200,
    "body": "{}",
    "headers": [
      "content-type: application/json; } charset=utf-8"
    ]
  }
}

Other responses

Response 404

Webhook not found or already deleted

Attributes

type string

A URI reference that identifies the problem type.

title string

A short, human-readable summary of the problem type.

detail string

A human-readable explanation specific to this occurrence of the problem.

Sample

{
  "type": "https://docs.enode.io/problems/not-found",
  "title": "Webhook not found",
  "detail": "Could not find webhook 0ec3d927-0100-44ff-bb53-edfe3ce64a57"
}