Skip to main content
POST

Body

application/json

Input model with all available parameters to set.

Main input model for the savings calculator.
Combines panel, battery, distribution, and electricity pricing configurations.

totalKWp
number<float>
required

Total installed PV power - kWp.

Constraints: The system currently supports only a single PV array, so this represents the total capacity.

If you need to create custom production profiles, use the CustomProductionConsumptionData property instead.

battery
object
required

Configuration of the battery system used in the simulation.

distribution
object
required

Settings related to the electricity distributor and regulated fees.

electricityBuyingSettings
FixBuyingSettings · object
required

Configuration for electricity purchasing strategy (either fixed or spot-based).

periodType
string | null

Type of time period to evaluate — a specific year like "2024", "2025", or the rolling range "12M" (last 12 completed months). Accepted values come from GET /api/v1/reference/periods.

Optional: leave it null and set from + to instead to evaluate an explicit date range. When both from and to are provided this field is ignored. Exactly one of { periodType } or { from + to } must be supplied.

from
string<date> | null

Optional explicit start of the evaluation period (date only, inclusive), e.g. "2025-01-01". Must be set together with to. When both are set, periodType is ignored — this lets you pin the exact window a study was computed over (e.g. a "last 12 months" run) so it can be reproduced later. The range must fall within the available data window (see the 400 response for the allowed bounds).

to
string<date> | null

Optional explicit end of the evaluation period (date only, inclusive), e.g. "2025-12-31". Must be set together with from. The whole day is included. A full calendar year (from = Jan 1, to = Dec 31) yields the same result as the matching periodType year.

yearlyConsumptionKWh
number<float>

Estimated total annual electricity consumption of the household in kilowatt-hours (kWh).

electricitySellingSettings
FixSellingSettings · object

Configuration for electricity selling strategy (if can't sell, set null).

customProductionConsumptionData
object[] | null

Optional custom production and consumption data for more accurate modeling.

This is not required; if not provided, the model will use default estimations based on TotalKWp and YearlyConsumptionKWh.

Model requires 1 hour granularity data for the entire period specified in PeriodType.

Response

OK

Represents the final results of the savings calculation, including aggregated energy usage and cost data for different system configurations, as well as a breakdown by month.

withoutPV
object

Represents aggregated energy and cost data for a specific PV system configuration.

basicPV
object

Represents aggregated energy and cost data for a specific PV system configuration.

smartPV
object

Represents aggregated energy and cost data for a specific PV system configuration.

savingsComparedToBasicPV
number<double>

The amount of money saved by using the smart PV system with Cubee compared to the basic PV system without optimization.

months
object[] | null

A list of monthly breakdowns showing energy data and savings for each individual month in the evaluation period.