🇬🇧
Altum AI
StartPlatformMonitorAltum AIContact
English
English
  • Altum AI API documentation
  • Platform
    • Monthly subscriptions
    • Yearly subscriptions
    • Unlimited usage subscriptions
    • Kadaster Transaction API subscription
    • Changelog
  • Updates
  • Developers
    • Perform your first API call
    • Credit API
    • Sandbox
    • OpenAPI specifications
    • GET API status
  • Altum AI website
  • Pricing
  • Property AI
    • Authentication, Input, and Response
    • Output Interpretation
    • FAQs
  • API's
    • AVM API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Accuracy Indicator
      • House numbers & additions
      • House types
      • Variables
      • Output interpretation
      • Frequently Asked Questions (FAQ)
    • AVM+ API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Energylabel and Inner and Outer Surface Area
      • Output interpretation
    • Listing Price API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Inner and Outer Surface Area
      • Output interpretation
    • Sustainability API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Energylabel
      • Improving the advice
      • Example API calls
      • Output interpretation
      • Increasing energy costs
      • Exclude measures
      • Search criteria
      • Measures
      • Insulation values
      • Comfort score
      • CO2
      • Coverage
      • Cost table input
      • Frequently Asked Questions (FAQ)
    • NTA 8800 Energylabel API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • EPC API
      • Changelog
      • API Key Information
      • Authentication, input and response
      • Output Interpretation
    • Energylabel insights API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WOZ API
      • Changelog
      • Frequently Asked Questions (FAQ)
      • Authentication, input and response
      • API Key Information
      • Output interpretation
      • PC6 average WOZ value
    • Interactive Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Visual similarity search
      • House types
      • Comparable functions
      • Output interpretation
    • Kadaster Transaction API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Housing features API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Contents Value API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Building geometry API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Energy & climate API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Condition score API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Photo Labelling API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Autosearch API
      • Authentication, input and response
      • API Key Information
    • Autosuggest API
      • Authentication, input and response
      • API Key Information
      • Fuzzy Search Support
      • Output interpretation
    • Move data API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Location Data API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House types
      • Output interpretation
    • Rental Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Rebuild Value API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Solar panel roof scan API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WWS Points API
      • Authentication, input and response
      • API Key Information
      • Specifications for independent home version 01-01-2024
      • Specifications for non-independent home version 01-01-2024
      • Specifications for independent home version 01-07-2024
      • Specifications for non-independent home version 01-07-2024
      • Input explanation for version 01-07-2024
      • Output interpretation
  • API error codes
    • 429
    • 422
    • 403
Powered by GitBook
On this page
  1. API's
  2. Solar panel roof scan API

Output interpretation

An explanation and interpretation of every feature outputted in the API response.

Solar API Output

Feature
Example
Explanation

postcode

2771DS

Zipcode

housenumber

87

House number

houseaddition

A3

Addition to house number

total_panel_capacity

4

The total number of solar panels that the simulation determined could fit on the specified rooftop.

output.index

1

Unique identifier for each simulation result within the output array

output.orientation

NW

The orientation of the solar panels in this simulation result

output.area

69.4

The total area covered by solar panels in square meters for this simulation result.

output.image_url

https://altum-ai.s3.amazonaws.com/panel_20240312-185650-9db5b409-1ad5-43ae-a5bc-86d17075da80.png?AWSAccessKeyId=AKIAY5UV7ISWPAGUXLWJ&Signature=mlY6yxMddBbqXQbG4%2B9Z2smqJKk%3D&Expires=1710269870

URL to an image that visually represents the solar panel layout for this simulation outcome

output.geo_data.type

Feature Collection

Indicating this object contains multiple geographical features.

output.geo_data.features.id

1

Unique identifier

output.geo_data.features.type

Feature

Type of Feature

output.geo_data.features.properties.id

3

Unique Identifier

output.geo_data.features.properties.roof_geom

"01060000A040710000010000000103000080010000000F0000004A0C022B91A2F940E17A142E61AF1B41BC7493180456FC3FD7A3703DA4A2F9406891ED7C60AF1B410456...

Representation of the rooftop geometry in WKT (Well-Known Text).

output.geo_data.features.properties.azimuth

276.8903

The compass direction that the solar panels face, measured in degrees from true north.

output.geo_data.features.properties.pitch

24.806

The angle of inclination of the solar panels or the roof surface from the horizontal.

output.geo_data.features.properties.panel_count

3

The number of solar panels suggested for this part of the roof, based on the simulation.

output.geo_data.features.properties.panel_grid

01060000A0407100000400000001030000800100000005000000C0580AE3A8A2F940C91FCCED6BAF1B4112ED37888E6D0240E8....

Representation of how solar panels could be arranged on the rooftop.

output.geo_data.features.geometry.type

MultiPolygon

Reflecting the geographical shape this feature represents. This could be "Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", or "MultiPolygon"

output.geo_data.features.geometry.coordinates

[ 105002.55542978924, 453594.9822239844, 2.303494514662483 ]

Coordinates specifying the geographical shape and location of the feature

output.geo_data.features.geometry.crs

urn:ogc:def:crs:EPSG::28992

Specifies the coordinate system and projection information used for the geographical data.

PreviousAPI Key InformationNextWWS Points API

Last updated 1 year ago