# Authenticatie, invoer en resultaat

### Vraag een duurzaamheidsadvies op basis van het adres op.

<mark style="color:green;">`POST`</mark> `https://api.altum.ai/v2/sustainability`

Dit endpoint stelt je in staat om een response van de Altum AI Verduurzaming API te ontvangen over verduurzamingsmaatregelen en de Ecowaarde, op basis van postcode, huisnummer en eventuele huisletter/toevoeging.

**Headers**

<table><thead><tr><th width="200">Naam</th><th width="136.9998779296875">Type</th><th>Omschrijving</th></tr></thead><tbody><tr><td>Content-Type</td><td>string</td><td>applicatie/json</td></tr><tr><td>x-api-key<mark style="color:red;">*</mark></td><td>string</td><td>Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)</td></tr></tbody></table>

**Request Body**

<table><thead><tr><th width="216">Naam</th><th width="117.99993896484375">Type</th><th width="282.2220458984375">Omschrijving</th><th>Standaard</th></tr></thead><tbody><tr><td>postcode<mark style="color:red;">*</mark></td><td>string</td><td>Zes-cijferige postcode formaat bijv. 1234AB</td><td></td></tr><tr><td>housenumber<mark style="color:red;">*</mark></td><td>integer</td><td>Huisnummer van het object</td><td></td></tr><tr><td>houseaddition</td><td>string</td><td>Huisnummertoevoeging</td><td></td></tr><tr><td>build_year</td><td>integer</td><td>Bouwjaar</td><td></td></tr><tr><td>roof_type</td><td>integer</td><td><p>1 = (voornamelijk) schuin dak</p><p>2 = (voornamelijk) plat dak</p><p>3 = deels schuin, deels plat dak</p></td><td>Standaard wordt een schuin dak aangenomen als geen daktype is opgegeven of bekend is.</td></tr><tr><td>inner_surface_area</td><td>float</td><td>De totale woonoppervlakte (m²)</td><td></td></tr><tr><td>house_type</td><td>integer</td><td><p>1 = vrijstaande woning</p><p>2 = 2-onder-1-kapwoning</p><p>3 = hoekwoning</p><p>4 = tussenwoning</p></td><td></td></tr><tr><td>wall_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>floor_insulation</td><td>integer</td><td>Bekijk <a href="/pages/KAZHEPwySCCMzgjW64TP">maatregelen</a></td><td></td></tr><tr><td>sloped_roof_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>flat_roof_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>living_room_windows</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>bedroom_windows</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>installation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>shower</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>ventilation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>solar_panels</td><td>list</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen">maatregelen</a></td><td></td></tr><tr><td>cooling</td><td>integer</td><td><p>Is er een koelsysteem aanwezig?</p><p>1 = Geen koeling</p><p>2 = Airconditioning, directe luchtkoeling</p></td><td><p>1</p><p><br></p></td></tr><tr><td>electric_cooking</td><td>integer</td><td><p>Wat wordt gebruikt om te koken?</p><p>1 = Gasfornuis</p><p>2 = Elektrisch fornuis</p></td><td><p>2 <em>Als de installatie in [6,7] zit.</em></p><p>Anders 1<br></p></td></tr><tr><td>inhabitants</td><td>integer</td><td>Aantal bewoners</td><td></td></tr><tr><td>gas_usage</td><td>float</td><td>Overschrijft het geschatte jaarlijkse gasverbruik (m³)</td><td></td></tr><tr><td>heat_usage</td><td>float</td><td>Overschrijft het opgegeven jaarlijkse warmteverbruik (GJ)</td><td></td></tr><tr><td>electricity_usage</td><td>float</td><td>Overschrijft het opgegeven jaarlijkse elektriciteitsverbruik (kWh)</td><td></td></tr><tr><td>electricity_generation</td><td>float</td><td>Totale jaarlijkse elektriciteitsopbrengst van zonnepanelen (kWh)
<br>Netto verbruik = verbruik − opbrengst</td><td></td></tr><tr><td>minimum_solar_panels</td><td>integer</td><td>Het minimale aantal nieuwe zonnepanelen dat geplaatst moet worden</td><td></td></tr><tr><td>search_criteria</td><td>integer</td><td><p>1 = laagste investeringskosten</p><p>2 = laagste energiekosten</p><p>3 = hoogste rendement op investering</p><p>4 = laagste BENG2 (hoogste energielabel)</p></td><td>3</td></tr><tr><td>target_label</td><td>string</td><td>Gewenst doel energy label - standaard is energielabel A of D</td><td></td></tr><tr><td>max_investment</td><td>integer</td><td>maximale investering, gebruik 0 voor onbeperkt</td><td></td></tr><tr><td>natural_gas</td><td>integer</td><td>1 = geen filter<br>2 = aardgas verplicht<br>3 = aardgasvrij</td><td></td></tr><tr><td>district_heating_allowed</td><td>boolean</td><td><p>0 = niet toegestaan</p><p>1 = toegestaan</p></td><td>0</td></tr><tr><td>heatpump_insulation_req</td><td>integer</td><td><p>1 = geen minimum vereist</p><p>2 = schil, inclusief glas minimaal 2</p><p>3 = woning voldoet aan “standaard”</p></td><td>3</td></tr><tr><td>exclude_vat</td><td>boolean</td><td><p>Prijzen zijn inclusief of exclusief btw.</p><p>0 = inclusief btw</p><p>1 = exclusief btw</p></td><td>0</td></tr><tr><td>cost_indicators</td><td>dict</td><td>Bekijk Cost indicators</td><td></td></tr><tr><td>wall_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-filters">maatregelen filters</a></td><td></td></tr><tr><td>sloped_roof_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-filters">maatregelen filters</a></td><td></td></tr><tr><td>flat_roof_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-filters">maatregelen filters</a></td><td></td></tr><tr><td>floor_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-filters">maatregelen filters</a></td><td></td></tr><tr><td>fetch_definitive_label</td><td>integer</td><td>Ophalen van het definitieve energielabel uit EP-online</td><td>0</td></tr><tr><td>energylabel_strict</td><td>integer</td><td>enable strict search of results within target_label with 1</td><td>0</td></tr><tr><td>eco_delta</td><td>boolean</td><td>Ophalen van de Ecowaarde</td><td>1</td></tr><tr><td>lock_measures</td><td>list</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-vergrendelen">maatregelen vergrendelen</a></td><td></td></tr><tr><td>exclude_measures</td><td>list</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/maatregelen-uitsluiten">maatregelen uitsluiten</a></td><td></td></tr></tbody></table>

{% tabs %}
{% tab title="200: OK Succesvol resultaat" %}
\`\`\` { "address": { "postcode": "2771DS", "housenumber": 87, "houseaddition": null, "street": "Zuidkade", "city": "Boskoop", "location": { "lat": 52.06839381665532, "lon": 4.6580852694533394 } }, "building": { "build\_year": 1961, "inner\_surface": 131.0, "floor\_surface": 97.0, "flat\_roof\_surface": 0, "pitched\_roof\_surface": 124.4, "wall\_surface": 150.7, "glass\_living\_room\_surface": 24.9, "glass\_bedrooms\_surface": 6.9, "type": "vrijstaand" }, "label": { "current": "G", "potential": "A++++" }, "provided\_label": { "temporary": "F", "definitive": "C", "definitive\_type": null, "definitive\_validity": null }, "BENG1": { "current": 165, "potential": 139 }, "BENG2": { "current": 422, "potential": -1 }, "meta": null, "energyindex": { "current": null, "potential": null }, "ELG": { "current": null, "potential": null }, "comfortscore": { "current": 1, "potential": 3 }, "CO2": { "current": 10632, "potential": 2564 }, "financial": { "total\_investment": 67638.64, "total\_saving": 8119.28, "months\_to\_pay\_off": 99, "eco\_value": null, "savings\_monthly": 677, "energy\_cost\_monthly": 681, "loan": { "monthly\_payment": 280.0 } }, "usage": { "gas": 6059, "energy": 4077, "city\_heating": 0 }, "usage\_potential": { "gas": 0, "energy": 903, "city\_heating": 0 }, "energy\_prices": { "variable\_gas\_price": 1.144, "variable\_electricity\_price": 0.293, "solarpanel\_watt\_peak\_per\_m2": 212 }, "measures": { "wall\_insulation": { "before": { "desc": "Geen", "value": 0, "points": 2 }, "after": { "desc": "Geen", "value": 0, "points": 2 }, "investment": 0.0, "saving": 0, "co2\_reduce": 0, "BENG2": "0%", "gas\_savings": 0, "electricity\_savings": 0 }, "floor\_insulation": { "before": { "desc": "Geen", "value": 0, "points": 0 }, "after": { "desc": "Goed", "value": 2, "points": 7 }, "investment": 2865.38, "saving": 1426, "co2\_reduce": 2223, "BENG2": "20.8%", "gas\_savings": 1205, "electricity\_savings": 161 }, "roof\_insulation": { "before": { "desc": "Geen", "value": 0, "points": 0 }, "after": { "desc": "Goed", "value": 2, "points": 3 }, "investment": 12441.24, "saving": 1928, "co2\_reduce": 3005, "BENG2": "28.1%", "gas\_savings": 1629, "electricity\_savings": 218 }, "living\_room\_windows": { "before": { "desc": "Dubbel glas", "value": 1, "points": 1 }, "after": { "desc": "Dubbel glas", "value": 1, "points": 1 }, "investment": 0.0, "saving": 0, "co2\_reduce": 0, "BENG2": "0%", "gas\_savings": 0, "electricity\_savings": 0 }, "bedroom\_windows": { "before": { "desc": "Dubbel glas", "value": 1, "points": null }, "after": { "desc": "Dubbel glas", "value": 1, "points": null }, "investment": 0.0, "saving": 0, "co2\_reduce": 0, "BENG2": "0%", "gas\_savings": 0, "electricity\_savings": 0 }, "ventilation": { "before": { "desc": "Natuurlijk", "value": 0, "points": 0 }, "after": { "desc": "Natuurlijk", "value": 0, "points": 0 }, "investment": 0.0, "saving": 0, "co2\_reduce": 0, "BENG2": "0%", "gas\_savings": 0, "electricity\_savings": 0 }, "solar\_panels": { "before": { "desc": "0", "value": 0, "points": null }, "after": { "desc": "59", "value": 59, "points": null }, "investment": 21849.7, "saving": 3279, "co2\_reduce": 3705, "BENG2": "19%", "gas\_savings": 0, "electricity\_savings": 11192 }, "instalation": { "before": { "desc": "HR-combi", "value": 4, "points": 15 }, "after": { "desc": "WP bodem combi", "value": 7, "points": 20 }, "investment": 29686.14, "saving": 2665, "co2\_reduce": 4254, "BENG2": "64.0%", "gas\_savings": 6059, "electricity\_savings": -15438 }, "shower": { "before": { "desc": "Geen Douche WTW", "value": 0, "points": null }, "after": { "desc": "Douche WTW", "value": 1, "points": null }, "investment": 796.18, "saving": 93, "co2\_reduce": 146, "BENG2": "0.4%", "gas\_savings": 82, "electricity\_savings": 0 } }, "response\_meta": null } \`\`\`
{% endtab %}

{% tab title="400: Mislukte reactie" %}
\`\`\` { "detail": "There was an error parsing the body" }

{ "detail": "Address not found in database, combination of zip code and house number" }

{ "detail": "There are no measures to suggest for this combination of input." }

{ "detail": "No housing variant with the selected installation options found with which the goal can be reached within the investment limit. Try again with different inputs and/or different search criteria." } { "detail": "For a given custom cost make sure the parameter 'value' is provided." } { "detail": "For a given improvement cost make sure all four parameters: 'material', 'work', 'saving\_material' and 'saving \_work' are provided." } `</div><div data-gb-custom-block data-tag="tab" data-title='401: Unauthorized No access'>` { 'Output': 'Please use <https://api.altum.ai> or visit <https://mopsus.altum.ai> to make your request.' } `</div><div data-gb-custom-block data-tag="tab" data-title='422: Unprocessable Entity Wrong input format'>` { "detail": \[ { "loc": \[ "string" ], "msg": "string", "type": "string" } ] } `</div><div data-gb-custom-block data-tag="tab" data-title='500: Internal Server Error Service is not available and/or down'>` { "message": "Internal server error" } `</div><div data-gb-custom-block data-tag="tab" data-title='403: Forbidden Forbidden'>` { "message": "Missing Authentication Token" } `</div><div data-gb-custom-block data-tag="tab" data-title='301: Moved Permanently Apartment error'>` { "detail": "Unable to check apartment." } `</div><div data-gb-custom-block data-tag="tab" data-title='303: See Other house type error'>` { "detail": "House type not found in database. Use house\_type parameter instead." } `</div></div><div data-gb-custom-block data-tag="tabs"><div data-gb-custom-block data-tag="tab" data-title='400: Bad Request Unsuccessful response'>` { "detail": "There was an error parsing the body" }

{ "detail": "Address not found in database, combination of zip code and house number" }

{ "detail": "There are no measures to suggest for this combination of input." }

{ "detail": "No housing variant with the selected installation options found with which the goal can be reached within the investment limit. Try again with different inputs and/or different search criteria." } `</div><div data-gb-custom-block data-tag="tab" data-title='401: Unauthorized No access'>` { 'Output': 'Please use <https://api.altum.ai> or visit <https://mopsus.altum.ai> to make your request.' } `</div><div data-gb-custom-block data-tag="tab" data-title='422: Unprocessable Entity Wrong input format'>` { "detail": \[ { "loc": \[ "string" ], "msg": "string", "type": "string" } ] } `</div><div data-gb-custom-block data-tag="tab" data-title='500: Internal Server Error Service is not available and/or down'>` { "message": "Internal server error" } `</div><div data-gb-custom-block data-tag="tab" data-title='403: Forbidden Forbidden'>` { "message": "Missing Authentication Token" } `</div><div data-gb-custom-block data-tag="tab" data-title='301: Moved Permanently Apartment error'>` { "detail": "Unable to check apartment." } `</div><div data-gb-custom-block data-tag="tab" data-title='303: See Other house type error'>` { "detail": "House type not found in database. Use house\_type parameter instead." }

```</div></div>

## Request body

#### Example requests

```

{ "post\_code": "2771DS", "house\_number": "87", "target\_label": "A++++", "eco\_delta": 0 }

```
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.altum.ai/verduurzamen/verduurzaming-api-v2/authenticatie-invoer-en-resultaat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.