Authenticatie, invoer en resultaat

Authenticatie, invoer en reactie

Beoordeel het volledige potentieel van de Satelliet Dakscan API door de belangrijkste parameters en het antwoord te begrijpen.

POST https://api.altum.ai/satellite-roof-scan

Het endpoint stelt u in staat om te communiceren met de Satelliet Dakscan API door specifieke queries te verzenden, zoals postcodes, om gedetailleerde vastgoedgegevens op te halen. Het volledige endpoint vindt u hierboven.

Queryparameters

Parameter	Type	Beschrijving
postcode	string	postcode in zeskarakterformaat, bijvoorbeeld 1234AB
huisnummer	string	huisnummer van het object, bijvoorbeeld 1
huisletter	string	toevoeging aan het huisnummer, bijvoorbeeld A
roof_geometry	boolean	Toont de polygoonvorm van het geselecteerde dak; indien false wordt de geometrie overgeslagen en wordt alleen beeldgebaseerde detectie uitgevoerd.
image_source	string	Geeft aan waar de beelddata vandaan komt (auto, pdok, esri, google_maps).
show_image	bool	Indien deze optie op false staat, wordt het tekenen van de geannoteerde afbeelding overgeslagen. Gebruik dit om tijd te besparen wanneer alleen het aantal gedetecteerde objecten nodig is.

Opmerking:

• De huisletter is een optioneel veld; je kunt dit leeg laten (""). Anders zijn alle velden verplicht.

• Sommige dakgeometrieën zijn niet altijd beschikbaar.

• Google Maps-services zijn tijdelijk uitgeschakeld.

• Je kunt de afbeeldingsbron wisselen tussen pdok, esri of auto (standaard).

Headers

Header	Type	Beschrijving
Content-Type	string	application/json
x-api-key*	string	Unieke API-sleutel van Altum. Verkrijgbaar op https://platform.altum.ai

Request body

Een geldig POST-verzoek ziet er bijvoorbeeld zo uit:

{
  "postcode": "4624AD",
  "housenumber": "4",
  "huisletter": "",
  "roof_geometry": true,
  "image_source": "auto",
  "show_image": true
}

Response

Bij een succesvolle POST-aanvraag retourneert de API een 200 OK-status met een JSON-object dat de resultaten bevat.

Voorbeeld van volledige output

Veld	Type	Beschrijving
postcode	string	postcode in zeskarakterformaat, bijvoorbeeld 1234AB
huisnummer	string	huisnummer van het object, bijvoorbeeld 1
huisletter	string	toevoeging aan het huisnummer, bijvoorbeeld A
imagery_source	string	Bron van de gebruikte luchtfoto.
annotated_image_url	string	Een openbare URL naar de afbeelding waarop de gedetecteerde zonnepanelen zijn weergegeven.
imagery_date	date	Datum waarop de luchtfoto is gemaakt.
num_panels_detected	integer	Het totale aantal gedetecteerde zonnepanelen (of andere objecten).
estimation_method	string	"detected", "detected_unmasked", or "estimated"
error_margin	int | null	± panels of uncertainty around num_panels_detected
detections	array	Een array van JSON-objecten, waarbij elk object een gedetecteerd zonnepaneel beschrijft, inclusief label, betrouwbaarheids-score en bounding box-coördinaten.

Voorbeeld van volledige output

{
	"postcode": "4624AD",
	"housenumber": "4",
	"huisletter": "",
	"houseaddress": "4624AD-4-",
	"imagery_source": "PDOK Aerial RGB (Open), Current Ortho 25cm RGB",
	"annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/4624AD-4-_beb82c36.png",
	"imagery_date": "2026",
	"num_panels_detected": 11,
	"estimation_method": "estimated",
	"error_margin": 2,
	"detections": [
		{
			"label": "solar_array_region",
			"confidence": 0.84,
			"bbox": {
				"x1": 340,
				"y1": 615,
				"x2": 528,
				"y2": 691,
				"width": 188,
				"height": 76
			}
		}
	]
}

200: OK Standard response

{
	"postcode": "4624AD",
	"housenumber": "4",
	"huisletter": "",
	"houseaddress": "4624AD-4-",
	"imagery_source": "PDOK Aerial RGB (Open), Current Ortho 25cm RGB",
	"annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/4624AD-4-_beb82c36.png",
	"imagery_date": "2026",
	"num_panels_detected": 11,
	"estimation_method": "estimated",
	"error_margin": 2,
	"detections": [
		{
			"label": "solar_array_region",
			"confidence": 0.84,
			"bbox": {
				"x1": 340,
				"y1": 615,
				"x2": 528,
				"y2": 691,
				"width": 188,
				"height": 76
			}
		}
	]
}

400: Bad Request Unsuccessful response

postcode or housenumber missing/empty.

404 Not Found

Er kon geen satellietbeeld worden opgehaald voor het gevonden adres (alle bronnen in de fallback-keten zijn mislukt).

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

Databaseverbinding niet tot stand gebracht, of de geannoteerde afbeelding kon niet naar S3 worden geüpload.