Connections

Copy linkDevice categories

We offer connections to devices in four categories—vehicles, chargers, HVACs, and solar inverters—through our API. Find relevant information and documentation for each category below.

Copy linkBrands and models

In our API, a hardware brand (e.g., Tesla) is referred to as a vendor or brand. Brands usually have multiple models (e.g., Model S P85). For a list of supported brands and models, see our connection capabilities overview.

Copy linkConnection capabilities

The connection capabilities overview displays key device information, implementation status, and supported capabilities for each brand and model.

Capabilities represent our API's ability to retrieve information, perform actions, or use Optimize features (e.g., smart charging or scheduling) for a specific model.

Copy linkInterventions

For certain brands and models, some or all capabilities must be unlocked via an intervention performed by the user.

Examples could be signing up for first-party user accounts, signing up for a subscription, changing settings in the first-party app, or changing settings on the device itself.

Copy linkAccessing a connected device's capabilities

A connected device always includes a capabilities object, providing a real-time description of the device's capabilities. Use this information to adapt your user experience, ensuring, for example, that unsupported actions are disabled or unavailable information is hidden.

{
  "id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
  "vendor": "TESLA",
  "capabilities": {
    "chargeState": {
      "isCapable": false,
      "interventionIds": [
        "c8a9fe78-44fd-482a-bebc-ef6047e6c0fe",
      ]
    },
    "information": {
      "isCapable": true,
      "interventionIds": []
    },
    { ... }
  },
  { ... }
}

Copy linkConnection statuses

The connection status for different vendors (brands) is available on our external status page.

Copy linkConnecting to devices

Connect to a user's device by linking a vendor to a userAPI using Link UI, a simple web interface for accessing users' hardware.

A user can link to multiple vendors across various categories. Once your userAPI links to one or more vendors, you can access all devices available through the linked vendor's APIs.

Copy linkInteracting with connected devices

Interact with connected devices via the respective API endpoints, e.g., /vehicles/*. Each device receives a unique id upon linking, which you can use to fetch information or perform actions.

Copy linkResponse times

When interacting with connected devices through our API, various delays and timing characteristics arise. Factors include vendor API response times, model-specific characteristics, and temporary vendor issues.

You don't need to know the specifics of these delays for each brand and model, but you can refer to the Reliability score in our connection capabilities overview. A lower Reliability score typically indicates longer delays.

If you experience unusually long response times with a specific device, brand, or model during development or production, check our status page, review the Reliability score for the specific model in our connection capabilities overview, or contact us for assistance.