Quickstart

re.alto Docs

Most of our endpoints require authentication with an access token.

Authenticate

Gather the needed information and consent to connect energy devices through onboarding.

Manual Onboarding

Guided onboarding lets your users set up their device through a web-based UI.

Guided Onboarding

You can use the Readings API to observe the state of an Entity over time.

Readings & Aggregations

Use the Commands API to schedule or directly send instructions to Entities.

Commands

Charge Sessions

Learn about where and how to access our APIs.

Introduction

Returns an access token that should be used to authenticate all requests to the re.alto API.

Retrieve a bearer token

Retrieves a specific Command by its id and returns that Command.

Retrieve a Command

Returns a page with a list of Commands in a given time frame. If no time frame is given, it will return all available Commands.

List all Commands

List all Commands for an Entity

Sends a new Command for immediate execution and returns the new Command.

Trigger a Command

Schedules a list of Commands for execution in the future and returns that list of Commands.

Schedule Commands

Cancels a specific Commmand and returns that Command with the updated status.

Cancel a Command

Returns the list of Charging Records for the Entity for the defined time frame.

List all Charge Sessions

List all Charge Sessions for an Entity

Changelog

Product Updates

Overview

Core Resources

An Entity represents a connected device or vehicle.

The Entity object

Returns Entity data for an Entity with a given id

Retrieve an Entity

Returns a page of Entities of the given type (if provided) and active feature (if provided)

List all Entities

A Collective represents a group of users and clients (members) who collectively can be granted permissions on one or more Entities.

The Collective object

Retrieve a Collective

Returns a list of Collectives accessible to the authenticated user.

List all Collectives

Updates a Collective and returns the updated Collective.

Update a Collective

List all Entities by Collective

Adds an Entity to a Collective and returns that Collective with a list of Entities, including the newly added Entity.

Add an Entity to a Collective

Removes an Entity from a Collective and returns that Collective with a list of Entities associated with it.

Remove an Entity from a Collective

A Tenant represents an organization and groups the users, clients, entities, and collectives that belong to it.

The Tenant object

Retrieve a Tenant

Returns a page with a list of Tenants accessible to the authenticated user.

List all Tenants

Updates a Tenant and returns the updated Tenant.

Update a Tenant

Returns a page with a list of Collectives.

List all Collectives by Tenant

Returns a list with the available Entity types and the possible manufacturers for each type.

List all available Entity brands and types

Returns the Entity Onboarding Request with specified id.

Retrieve an Entity Onboarding Request

Returns a page of Entity Onboarding Requests for a specific manufacturer and type, optionally with additional filters.

List all Entity Onboarding Requests

Creates an Entity Onboarding Request and returns the created Entity Onboarding Request.

Create an Entity Onboarding Request

Cancels the specified Entity Onboarding Request and returns that Entity Onboarding Request with updated status.

Cancel an Entity Onboarding Request

Returns the Collective Onboarding Request with specified id.

Retrieve a Collective Onboarding Request

Creates a Collective Onboarding Request and returns the created Collective Onboarding Request.

Create a Collective Onboarding Request

Cancels the specified Collective Onboarding Request and returns that Collective Onboarding Request with updated status.

Cancel a Collective Onboarding Request

Returns the Guided Onboarding Session with specified id.

Retrieve a Guided Onboarding Session

Returns a page of Guided Onboarding Sessions available to the authenticated user.

List all Guided Onboarding Sessions

Creates a Guided Onboarding Session and returns the url to access it.

Create a Guided Onboarding Session

A Reading represents a single snapshot of the state of an Entity.

The Reading object

Returns a page of normalized Readings for a specific Entity, optionally with additional filters

List all Readings

List all Readings for an Entity

Returns the most recent normalized Reading for an Entity

Retrieve the last Reading

Retrieve the last Reading for an Entity

Returns a page of raw data Aggregations, statistically averaged over a specified resolution and time period, with optional filtering

Generate aggregations

Generate aggregations for an Entity

Returns a single total Aggregation for an Entity between specific dates

Generate a total aggregation

Generate a total aggregation for an Entity

Activates or deactivates a feature for an Entity. The platform offers some capabilities (ex: CDRs) that have to be explicitly enabled on an Entity to become available

Activate or deactivate a feature for an Entity

Returns all the Entity features and their activation status

List all features for an Entity

Retrieve the details of a single Location for a given Entity

Retrieve a Location for an Entity

List all Locations of an Entity

Set up a Location for a given Entity by providing an address or its coordinates

Create a Location for an Entity

Update just the label or all details of a Location for a given Entity

Update a Location for an Entity

Delete a Location for an Entity

Returns the battery capacity of the Entity

Retrieve the battery capacity of an Entity

Set the battery capacity of an Entity and returns the updated battery capacity of that Entity

Update the battery capacity of an Entity

Deletes the battery capacity from the Entity

Delete the battery capacity of an Entity

Retrieve the heated area of an Entity

Set the heated area of an Entity and returns the updated heated area of that Entity

Update the heated area of an Entity

Delete the heated area of an Entity

Returns the set of disaggregators that are set up for the Entity

List all disaggregators for an Entity

Returns the updated list of disaggregators that are set up for the Entity

Add a disaggregator for an Entity

Removes the disaggregator from the collection of disaggregators that are set up for the Entity

Remove a disaggregator for an Entity

Set the custom properties of an Entity and returns the updated custom properties of that Entity

Get Started

Connect to Entities