Skip to main content
POST
/
api
/
v2
/
savings-calculator
Savings calculator
curl --request POST \
  --url https://api.partner.cubee.cz/api/v2/savings-calculator \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "periodType": "<string>",
  "yearlyConsumptionKWh": 123,
  "totalKWp": 123,
  "battery": {
    "batterySizeKwh": 123,
    "reservedBatteryCapacityPercentage": 50,
    "maximumBatteryChargingPowerWatt": 123,
    "maximumBatteryDischargingPowerWatt": 123
  },
  "distribution": {
    "distributor": "<string>",
    "distributionRate": "<string>",
    "lowTariffCommand": "<string>",
    "distributorFeeHighPerMWh": 123,
    "distributorFeeLowPerMWh": 123,
    "renewableEnergyFeePerMWh": 123,
    "systemServicesFeePerMWh": 123,
    "circuitBreakerMonthlyFee": 123
  },
  "electricityBuyingSettings": {
    "buyingType": "<string>",
    "monthlyFeeCzk": 123,
    "vat": 123,
    "fixedBuyPriceCzkPerMWh": 123,
    "fixedBuyPriceCzkPerMwhInLowTariff": 123
  },
  "electricitySellingSettings": {
    "sellingType": "<string>",
    "monthlyFeeCzk": 123,
    "fixedSellPriceCzkPerMWh": 123
  }
}'
{
  "withoutPV": {
    "energyProducedKWh": 123,
    "energyConsumedKWh": 123,
    "energyPurchasedKWh": 123,
    "energySoldKWh": 123,
    "costOfPurchasedEnergy": 123,
    "revenueFromSoldEnergy": 123,
    "netEnergyCost": 123,
    "averagePurchasePricePerMWh": 123,
    "averageSellPricePerMWh": 123
  },
  "basicPV": {
    "energyProducedKWh": 123,
    "energyConsumedKWh": 123,
    "energyPurchasedKWh": 123,
    "energySoldKWh": 123,
    "costOfPurchasedEnergy": 123,
    "revenueFromSoldEnergy": 123,
    "netEnergyCost": 123,
    "averagePurchasePricePerMWh": 123,
    "averageSellPricePerMWh": 123
  },
  "smartPV": {
    "energyProducedKWh": 123,
    "energyConsumedKWh": 123,
    "energyPurchasedKWh": 123,
    "energySoldKWh": 123,
    "costOfPurchasedEnergy": 123,
    "revenueFromSoldEnergy": 123,
    "netEnergyCost": 123,
    "averagePurchasePricePerMWh": 123,
    "averageSellPricePerMWh": 123
  },
  "savingsComparedToBasicPV": 123,
  "months": [
    {
      "withoutPV": {
        "energyProducedKWh": 123,
        "energyConsumedKWh": 123,
        "energyPurchasedKWh": 123,
        "energySoldKWh": 123,
        "costOfPurchasedEnergy": 123,
        "revenueFromSoldEnergy": 123,
        "netEnergyCost": 123,
        "averagePurchasePricePerMWh": 123,
        "averageSellPricePerMWh": 123
      },
      "basicPV": {
        "energyProducedKWh": 123,
        "energyConsumedKWh": 123,
        "energyPurchasedKWh": 123,
        "energySoldKWh": 123,
        "costOfPurchasedEnergy": 123,
        "revenueFromSoldEnergy": 123,
        "netEnergyCost": 123,
        "averagePurchasePricePerMWh": 123,
        "averageSellPricePerMWh": 123
      },
      "smartPV": {
        "energyProducedKWh": 123,
        "energyConsumedKWh": 123,
        "energyPurchasedKWh": 123,
        "energySoldKWh": 123,
        "costOfPurchasedEnergy": 123,
        "revenueFromSoldEnergy": 123,
        "netEnergyCost": 123,
        "averagePurchasePricePerMWh": 123,
        "averageSellPricePerMWh": 123
      },
      "savingsComparedToBasicPV": 123,
      "month": "2023-12-25"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

Input model with all available parameters to set.

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

periodType
string | null
required

Type of time period to evaluate (e.g., specific year like "2024", or dynamic range like "12M").

totalKWp
number
required

Total installed PV power - kWp.

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
object
required

Configuration for electricity purchasing strategy (either fixed or spot-based). Buying electricity at a fixed price, with different rates for high and low tariffs.

  • FixBuyingSettings
  • SpotBuyingSettings
yearlyConsumptionKWh
number

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

electricitySellingSettings
object

Configuration for electricity selling strategy (if can't sell, set null). Selling electricity at a fixed price.

  • FixSellingSettings
  • SpotSellingSettings

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. Base class for storing energy and cost results for different PV setups. Used for both overall results and per-period (e.g., monthly) results.

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

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.