Documentation Using GridPreview
Project inputs
Choose a project and supply useful assumptions without mistaking them for verified facts.
On this page
Location and project type
The postcode and house number identify candidate addresses. confirmedAddressId stores the selected PDOK address identifier. Research rechecks that identifier before using address-linked evidence.
The project type determines which sources and directions matter. Solar projects can collect modeled roof information and a PVGIS estimate. Battery-only research does not collect the historical solar roof model merely to fill the report.
Power, energy and consumption
| Field | Unit | Meaning |
|---|---|---|
| Planned size | kW | Assumed installation peak power, not granted connection capacity |
| Battery storage | kWh | Assumed storage quantity, distinct from charge/discharge power |
| Annual electricity use | MWh in the form | User estimate; converted to kWh in the request contract |
capacityKw | kW | Positive power input used by the API |
storageKwh | kWh | Optional positive storage input |
annualConsumptionKwh | kWh | Optional positive annual consumption input |
Do not interchange kW and kWh. One measures power; the other measures energy. Annual energy is also different from a stored energy quantity.
Connection information
The connection selector accepts small, large or unknown. The optional exact rating uses phases followed by amperes: for example, 1x35, 3x25 or 3x80. Leave it blank when unknown.
{
"connectionSize": "unknown",
"connectionAmperage": "3x25"
}
This is a request-format example, not a verified connection record. Providing a rating does not automatically establish a connection class, permitted export or available capacity. Conflicting or uncertain inputs require clarification, not an invented conclusion.
Connection-class rules and their project relevance must come from retrieved official guidance. Small projects are not universally exempt from congestion or waiting lists. The RVO source explains the conditions for new or heavier small connections; check the fetched text and the report’s citations rather than relying on a remembered rule.
Solar model assumptions
PVGIS needs confirmed coordinates and a planned power value. The API contract also accepts optional tilt, azimuth and lossPct values. Without explicit angles the adapter requests optimal angles; the default modeled system loss is 14%.
These are model assumptions. The calculated annual yield does not verify shading, usable roof area, structural loading, installation design or export permission. A newly requested model result can use historical radiation data.
Validation at the boundary
The shared contract in src/shared/contracts.ts validates incoming values. Power, storage and consumption must be positive when supplied; angle and loss values have explicit bounds. Connection ratings must follow the documented phase/amperage format.
Sending a field that passes schema validation only establishes that its format is acceptable. It does not turn the supplied assumption into external evidence.