Energy Forecast

The forecast endpoint returns predicted energy values generated by MOOST's Machine Learning models. These forecasts enable forward-looking features in your Households Dashboard, such as "Low solar generation expected tomorrow" or consumption planning widgets.

A building’s energy forecast data

get

Get energy forecast data of a building.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerBuildingIdstringRequiredPattern: ^[a-zA-Z0-9:._-]{1,100}$

Query parameters

eventTypestring · enumRequired

Target energy forecast event type, which defines what data to select.

Example: ENERGY_CONSUMPTION_FORECAST_24HPossible values:

frominteger · int64Required

The starting time (inclusive) in epoch seconds of the forecast time window.
Remark: The time window between from and to must not exceed one month.

Example: 1739408400

tointeger · int64Required

The final time (exclusive) in epoch seconds of the forecast time window.

Example: 1739494800

Responses

200

OK

application/json

timestampinteger · int64Optional

forecastTimestampinteger · int64Optional

valuenumber · floatOptional

get

/buildings/{customerBuildingId}/energy-forecast/v1

HTTPcURLJavaScriptPython

GET /buildings/{customerBuildingId}/energy-forecast/v1?eventType=ENERGY_CONSUMPTION_FORECAST_1H&from=1&to=1 HTTP/1.1
Host: api.moost.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "timestamp": 1,
    "forecastTimestamp": 1,
    "value": 1
  }
]

Relationship to Context Services

The energy forecasts exposed by this API are generated by MOOST's Context Services — specifically the Power Consumption Forecast and the Solar Production Forecast (also known as Power Generation Forecast). These services apply machine learning algorithms to historical data to produce their predictions.

The Context Services also generate power-level forecast events (e.g. POWER_GENERATION_FORECAST_1H, POWER_CONSUMPTION_FORECAST_24H) that are used internally by the rule engine for the Engagement Service. The energy-forecast API provides the energy-level equivalents in a format optimised for dashboard rendering.

The Power Consumption Forecast and Power Generation Forecast are available in the Premium subscription. The Solar Production Forecast (weather-based) is available for all customers who provide a ZIP code and geolocation for their buildings.

Dashboard Usage

Forecasts are typically rendered in the Households Dashboard as:

• Generation forecast chart — showing expected solar production for the next 1–2 days, helping users plan energy-intensive activities.

• Consumption forecast chart — showing expected household consumption, useful for alerting users to unusually high predicted consumption.

• Combined outlook — overlaying generation and consumption forecasts to visualise upcoming self-sufficiency or grid dependency periods.