> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/english/sustainability/solar-panel-roof-scan-api.md).

# Solar panel roof scan API

Calculates the optimal layout of solar panels in terms of count, position etc. considering the rooftop's orientation and geometry. Additionally, it creates temporary image URLs of these simulations

The API is designed to assist in the planning and optimization of solar panel installations on rooftops. It facilitates the simulation of fitting solar panels on building rooftops by leveraging 3D geometrical data and advanced calculation algorithms to optimize solar panel placement. The API also generates temporary URLs for images that visually represent these simulations, providing a comprehensive view of potential installations.

<figure><img src="https://1172273446-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lw4gk5ARKsgVHFCdPZw%2Fuploads%2FWTVQh8um4zAigHFdRGT1%2Fzonnepaneel.png?alt=media&amp;token=feb5772c-594b-4c46-8eff-9e1c851b61ce" alt=""><figcaption></figcaption></figure>

### Two functions of the solar panel roof scan

1. Calculates maximum capacity for solar panels and its returns for every roof surface
2. Given an n input of solar panels, calculates optimal placement and returns


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.altum.ai/english/sustainability/solar-panel-roof-scan-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.