AUautarc
PV plannings

Get a PV planning's savings scenario

The savings scenario stored next to the PV planning — the most recently updated one, or the one named by simulationId.

It returns the scenario's own stored economic inputs (price escalation, feed-in tariff, CER incentive, discount, per-trade pricing), which energy flows it models, its component list, the linked customer proposal, and the planning's stored yield.

The result figures Autarc Pro derives for display — self-consumption, autarky, bill savings and amortization — are recomputed on every view and are not persisted, so they are not part of this response.

This is a partial export of the calculation inputs and does not suffice to reproduce those figures: recurring costs, the simulation resolution, the project's consumption and tariffs, and the components' kind-specific configuration are not included.

get/solar-plannings/{solarPlanningId}/simulation

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Path parameters

solarPlanningIdstring uuid required

PV planning identifier

Query parameters

simulationIdstring uuid

Select one specific scenario of this planning instead of the most recently updated one.

Response

The stored savings scenario of a PV planning.

idstring uuid required
namestring required
projectIdstring uuid required
solarPlanningIdstring uuid required
proposalIdstring uuid

The customer proposal built on this scenario, when one exists.

isBaselineboolean required

Whether this scenario is the project's reference scenario.

annualYieldKwhnumber

The planning's stored yearly yield in kWh. Omitted when no yield has been calculated.

monthlyYieldKwhnumber[]
yieldSourcestring
yieldCapturedAtstring date-time
acConsumptionPerYearKwhnumber

Modelled yearly air-conditioning consumption in kWh.

acFixedPricenumber

Fixed price of the air-conditioning trade.

useSeasonalPerformanceFactorboolean required

Whether the heat pump's consumption is derived from the building's heat load, full-load hours and simulatedSeasonalPerformanceFactor (true) rather than taken from the stated annual heat-pump consumption (false).

simulatedSeasonalPerformanceFactornumber
wallboxUsagePatternstring

Driving pattern used for the wallbox load profile (e.g. workCommuter, weekendDriver).

yearlyEnergyCostIncreasenumber

Assumed yearly electricity price escalation in percent (e.g. 3 for 3 %).

yearlyFossilCostIncreasenumber

Assumed yearly fossil fuel price escalation in percent.

pricePerReimbursedKwhnumber

Feed-in tariff per kWh exported to the grid.

discountRatenumber
discountTypestring

percentage or absolute.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.