Authentication, input and response

Assess the full potential of the Solar Panel API by understanding the key parameters and response.

Post :XXXXXXX-XXXXXX-XXXXX

The endpoint allows you to interact with the Solar Panel API by sending specific queries, such as postal codes, to retrieve detailed real estate data. You can find the full endpoint above.

Query Parameters

Parameter	Type	Description
bagid	string	The unique BAG identification number for the building.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	Unique API key from Altum. Obtain one via Mopsus (https://mopsus.altum.ai)

Response

Upon a successful POST request, the API returns a 200 OK status with a JSON object containing the results.

Example Complete Output

Field	Type	Description
bagid	string	The BAG ID of the requested property.
num_panels_detected	integer	The total number of solar panels (or other detected objects) found.
detections	array	An array of JSON objects, with each object describing a detected solar panel, including its label, confidence score, and bounding box coordinates.
annotated_image_url	string	A public URL to the image with detected solar panels drawn on it.

Request body

A valid POST request body would look like this:

{"bagid": "0363010000688380"}

Output

Upon a successful POST request, the API returns a 200 OK status with a JSON object containing the results.

Example Complete Output

{
  "bagid": "0363010000688380",
  "num_panels_detected": 15,
  "detections": [
    {
      "label": "solar-panel",
      "confidence": 0.91,
      "bbox": {
        "x1": 0,
        "y1": 1054,
        "x2": 406,
        "y2": 1293,
        "width": 406,
        "height": 239
      }
    },
    ... (more detections)
  ],
  "annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/0363010000688380_79dc9a90.png"
}

200: OK Standard response

{
  "bagid": "0363010000688380",
  "num_panels_detected": 15,
  "detections": [
    {
      "label": "solar-panel",
      "confidence": 0.91,
      "bbox": {
        "x1": 0,
        "y1": 1054,
        "x2": 406,
        "y2": 1293,
        "width": 406,
        "height": 239
      }
    },
    ... (more detections)
  ],
  "annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/0363010000688380_79dc9a90.png"
}

400: Bad Request Unsuccessful response

{
	The request was invalid.
}

404 Not Found

Failed to scrape image for BAG ID: {bagid}. 
This might mean the BAG ID was not found in the database or there was an issue with PDOK API.

500: Internal Server Error Service is not available and/or down

{
	"message": "An unexpected server error occurred."
}