AUautarc
PV plannings

Get a PV planning

One PV planning with the products it plans: the scene hardware grouped by object type and catalog item (drawn modules or by-numbers module arrays, inverters, batteries, DC optimizers, and mounting kits) and the bill-of-materials lines the planner stores (quantity overrides and manual lines). The complete bill of materials is derived in Autarc Pro and is not part of this export.

Read-only. The 3D scene geometry, renderer output and shading overlays are not part of this export.

get/solar-plannings/{solarPlanningId}

Request

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

Path parameters

solarPlanningIdstring uuid required

PV planning identifier

Response

One PV planning with its planned hardware and stored bill-of-materials adjustments.

idstring uuid required
projectIdstring uuid required
namestring required
statusstring required

Installation status of the planning (notStarted, inProgress, completed).

backgroundSourcestring required

Where the planner's site background came from: user, google, ortho, droneScan, photogrammetry, googleOrthomap, mapboxSatellite, appleMaps, perspectivePhoto, the country orthophotos (frenchOrtho, luxembourgOrtho, switzerlandOrtho, polandOrtho, austriaOrtho), the Bluesky UK aerial imagery (bluesky5cm, bluesky12_5cm), or byNumbers for a planning configured by numbers (declared module arrays, no drawn scene). New sources may be added; treat an unknown value as an unrecognised imagery source.

siteAssessmentstring required

How the site was evaluated (remote or on_site).

mcsCompliantboolean required

Whether the planning is maintained under the UK MCS ruleset.

kwpnumber

Installed DC power in kWp — the sum of the drawn modules' nominal power (STC) plus the declared power of the by-numbers module arrays. Modules that cannot be built (off their roof, on an obstruction or under another module) are not counted. Omitted when no planned module carries a power figure.

panelCountinteger required

Number of planned modules — drawn modules plus the module counts declared on by-numbers arrays. Modules that cannot be built (off their roof, on an obstruction or under another module) are not counted.

roofCountinteger required
inverterCountinteger required
batteryCountinteger required
stringCountinteger required
annualYieldKwhnumber

Yearly yield in kWh from the planner's stored yield snapshot (PVGIS or the static tables). Omitted when the planner has not calculated a yield for this planning yet — it is never reported as 0.

monthlyYieldKwhnumber[]

Monthly yield in kWh from the same stored snapshot, January first.

yieldSourcestring

Which model produced the stored yield (pvgis or static).

yieldCapturedAtstring date-time

When the stored yield was calculated.

yearlyEnergyCostIncreasenumber

Assumed yearly electricity price escalation in percent (e.g. 3 for 3 %), one of the savings inputs.

createdAtstring date-time required
updatedAtstring date-time required

Changes

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