CUcubee
Calculator

Savings calculator

Changed on

Calculates savings for Basic PV, smart PV and No PV installations.

post/api/v2/savings-calculator

Request

  • Base URL
    https://api.partner.cubee.cz
  • URL
    https://api.partner.cubee.cz/api/v2/savings-calculator
  • Auth
    none required

Request body

periodTypestring nullable

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.

fromstring date nullable

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).

tostring date nullable

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.

yearlyConsumptionKWhnumber float

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

totalKWpnumber 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.

Response

OK

savingsComparedToBasicPVnumber double

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

Changes

  • 50555858fb42Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the media type application/*+json from the request body

    • breaking

      removed the media type text/json from the request body

    • breaking

      removed from the request body oneOf list

    • breaking

      the request's body type changed from no type to object

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status