---
title: "List project PV plannings"
method: GET
path: "/projects/{projectId}/solar-plannings"
tags: ["PV plannings"]
---

# List project PV plannings

`GET /projects/{projectId}/solar-plannings`

## Request

- Base URL: `https://api3.autarc.energy/v1`
- URL: `https://api3.autarc.energy/v1/projects/{projectId}/solar-plannings`
- Auth: API key in header `X-Api-Key`

The project's PV plannings, most recently updated first, with the headline
figures the planner stored: installed kWp, the scene counts, and the yearly
and monthly yield from the planner's stored yield snapshot.

Read-only. Yield is never recalculated for this request — a planning whose
yield has not been calculated yet simply omits the yield fields rather than
reporting zero.

## Path parameters

- `projectId` string, required

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

Paginated list of the project's PV plannings.

- object
  - `items` SolarPlanning[], required
    - `id` string, uuid, required
    - `projectId` string, uuid, required
    - `name` string, required
    - `status` string, required: Installation status of the planning (notStarted, inProgress, completed).
    - `backgroundSource` string, 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.
    - `siteAssessment` string, required: How the site was evaluated (remote or on_site).
    - `mcsCompliant` boolean, required: Whether the planning is maintained under the UK MCS ruleset.
    - `kwp` number: 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.
    - `panelCount` integer, 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.
    - `roofCount` integer, required
    - `inverterCount` integer, required
    - `batteryCount` integer, required
    - `stringCount` integer, required
    - `annualYieldKwh` number: 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.
    - `monthlyYieldKwh` number[]: Monthly yield in kWh from the same stored snapshot, January first.
    - `yieldSource` string: Which model produced the stored yield (pvgis or static).
    - `yieldCapturedAt` string, date-time: When the stored yield was calculated.
    - `yearlyEnergyCostIncrease` number: Assumed yearly electricity price escalation in percent (e.g. 3 for 3 %), one of the savings inputs.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `metadata` object, required
    - `page` integer, required: Current page number
    - `limit` integer, required: Number of items per page
    - `total` integer, required: Total number of items

## Other responses

- `400`: Invalid request — a malformed id, filter, pagination parameter or body. The body is a plain-text message naming the problem.
- `404`: The specified resource was not found

---

[API](https://skmtc.dev/autarc/apis/autarc-2-0-api.md) - [All operations](https://skmtc.dev/autarc/apis/autarc-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autarc/apis/autarc-2-0-api/revisions/adfb20a40efc?raw)