REST API (1.0.0)

Download OpenAPI specification:

REST API Specification for Wattos Energy Management System. This API provides endpoints for managing sites, resources, and retrieving data from various energy systems including meters, BESS, and PV systems.

Get a list of sites belonging to the specified Group ID

Authorizations:
BearerAuth
query Parameters
group_id
required
string^[A-Z0-9]{8}$

8-digit alphanumeric group ID to filter sites

Responses

Response samples

Content type
application/json
{
  • "sites": [
    ]
}

Get a list of resources installed at the specified Site ID

Authorizations:
BearerAuth
path Parameters
site_id
required
string^[A-Z0-9]{8}$

8-digit alphanumeric site ID to filter resources

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

Get meter measurement data for the specified resource

Authorizations:
BearerAuth
query Parameters
resource_id
string^[A-Z0-9]{8}$

8-digit alphanumeric resource ID (optional)

start
required
string <date-time>

Data aggregation start time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

end
required
string <date-time>

Data aggregation end time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

agg_interval
required
integer
Enum: 1 5 15 30

Aggregation interval (1: 1 minute, 5: 5 minutes, 15: 15 minutes, 30: 30 minutes)

Responses

Response samples

Content type
application/json
{
  • "datas": [
    ]
}

Get BESS system performance metrics for the specified resource

Authorizations:
BearerAuth
query Parameters
resource_id
string^[A-Z0-9]{8}$

8-digit alphanumeric resource ID (optional)

start
required
string <date-time>

Data aggregation start time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

end
required
string <date-time>

Data aggregation end time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

agg_interval
required
integer
Enum: 1 5 15 30

Aggregation interval (1: 1 minute, 5: 5 minutes, 15: 15 minutes, 30: 30 minutes)

Responses

Response samples

Content type
application/json
{
  • "datas": [
    ]
}

Get PV system operation and performance metrics for the specified resource

Authorizations:
BearerAuth
query Parameters
resource_id
string^[A-Z0-9]{8}$

8-digit alphanumeric resource ID (optional)

start
required
string <date-time>

Data aggregation start time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

end
required
string <date-time>

Data aggregation end time (ISO 8601, UTC, seconds fixed to 00). Must be longer than the interval specified in agg_interval.

agg_interval
required
integer
Enum: 1 5 15 30

Aggregation interval (1: 1 minute, 5: 5 minutes, 15: 15 minutes, 30: 30 minutes)

Responses

Response samples

Content type
application/json
{
  • "datas": [
    ]
}