Authentication, input and response

Simulate fitting solar panels on building rooftops

POST https://api.altum.ai/solar

Headers

Name
Type
Description

Content-Type

string

application/json

x-api-key*

string

Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)

Request Body

Name
Type
Description

postcode*

string

Zipcode of the object

housenumber*

string

House number of the object

houseaddition

string

House number addition

panel_width*

float

The width of the panel in meters. This specifies the horizontal dimension of the panel.

panel_height*

float

The height of the panel in meters. This specifies the vertical dimension of the panel.

horizontal_spacing*

float

The distance between panels when installed side by side, measured in meters.

vertical_spacing*

float

The distance between panels when stacked vertically, measured in meters.

roof_margin*

float

The margin left between the edge of the roof and the panels, measured in meters.

building_id

string

A unique identifier for a building when conducting simulations that involve multiple structures

n_panels

integer

Represents the number of panels that will be simulated for installation on a specific building

roof_id

string

Serves as a unique identifier for a specific roof on a building.

Request body

Example request

{
  "postcode": "2771DS",
  "housenumber": 89,
  "houseaddition": "",
  "panel_width": 1,
  "panel_height": 1.5,
  "horizontal_spacing": 0.3,
  "vertical_spacing": 0.5,
  "roof_margin": 0.05
}

Last updated