> 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/verduurzamen/verduurzaming-api-v2-delta-appartementen/authenticatie-invoer-en-resultaat.md). # Authenticatie, invoer en resultaat ## Vraag een duurzaamheidsadvies op basis van het adres. `POST` `https://api.altum.ai/v2/sustainability/apartments/delta` Met deze endpoint ontvang je een antwoord van de **Altum AI Verduurzaming API Delta,** speciaal voor appartementen, over duurzaamheid en de **Ecovalue**, door postcode, huisnummer en huisletter/toevoeging mee te geven. #### Headers | Naam | Type | Omschrijving | | ------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------ | | Content-Type | string | application/json | | x-api-key\* | string | Unieke API sleutel van Altum. Maak er één aan op [https://platform.altum.ai](https://platform.altum.ai/auth) | #### Request Body | Naam | Type | Omschrijving | Voorbeeld | | ---------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | postcode\* | string | Zes-cijferige postcode formaat | 1234AB | | housenumber\* | integer | Huisnummer van het object | 5 | | houseaddition | string | Huisnummertoevoeging | C | | position | integer |

1 = 'Hoek begane grond' | | |
2 = 'Tussenwoning begane grond' | | | | |
3 = 'Hoekwoning middenverdieping' | | | | |
4 = 'Tussenwoning middenverdieping' | | | | |
5 = 'Hoekwoning bovenste verdieping' | | | | |
6 = 'Tussenwoning bovenste verdieping' | | | | |
7 = 'Volledig bovenste verdieping/penthouse'

| 3 | | | | floors | integer |

Heeft de woning één of meerdere verdiepingen?

1 = 'Eén verdieping'

2 = 'Meerdere verdiepingen'

| 1 | | back\_facade | boolean |

Heeft de woning een achtergevel?

| false | | build\_year | integer | Bouwjaar | 1956 | | inner\_surface\_area | float | Totale woonoppervlakte (m²) | 90 | | apartment\_type | integer |

1 = 'Galerijflat'
2 = 'Portiekflat'
3 = 'Corridorflat'
4 = 'Maisonnette'
5 = 'Benedenwoning'
6 = 'Bovenwoning'
7 = 'Portiekwoning

| | | wall\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 2 | | target\_wall\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | floor\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 1 | | target\_floor\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | sloped\_roof\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 2 | | target\_sloped\_roof\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | flat\_roof\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 2 | | target\_flat\_roof\_insulation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | living\_room\_windows | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 1 | | target\_living\_room\_windows | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 3 | | bedroom\_windows | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 1 | | target\_bedroom\_windows | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | installation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | target\_installation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 4 | | shower | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 1 | | target\_shower | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 2 | | ventilation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 2 | | target\_ventilation | integer | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | 3 | | solar\_panels | list | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelen) | | | cooling | integer | Is er een koelsysteem aanwezig? |

1 = Geen koeling

2 = Airconditioning, directe luchtkoeling

| | target\_cooling | integer | Is er een koelsysteem aanwezig? |

1 = Geen koeling

2 = Airconditioning, directe luchtkoeling

| | electric\_cooking | integer | Wat wordt gebruikt om te koken? |

1 = Gasfornuis

2 = Elektrisch fornuis

Als de installatie in \[6,7] zit -> 2 anders 1

| | target\_electric\_cooking | integer | Wat wordt gebruikt om te koken? |

1 = Gasfornuis

2 = Elektrisch fornuis

Als de installatie in \[6,7] zit -> 2 anders 1

| | inhabitants | integer | Aantal bewoners | 4 | | gas\_usage | float | Overschrijft het geschatte jaarlijkse gasverbruik (m³) | 1000 | | heat\_usage | float | Overschrijft het opgegeven jaarlijkse warmteverbruik (GJ) | 45 | | electricity\_usage | float | Overschrijft het opgegeven jaarlijkse elektriciteitsverbruik (kWh) | 2600 | | electricity\_generation | float |

Totale jaarlijkse elektriciteitsopbrengst van zonnepanelen (kWh) | | |
Netto verbruik = verbruik − opbrengst

| 800 | | | | exclude\_vat | boolean | Prijzen zijn inclusief of exclusief btw. |

0 = Inclusief btw

1 = Exclusief btw

Standaard: 0

| | cost\_indicators | dict | Bekijk [Kostenindicatoren](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/kostenindicatoren) | | | wall\_filters | dict | Bekijk [Maatregelfilters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelfilters) | | | roof\_filters | dict | Bekijk [Maatregelfilters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelfilters) | | | floor\_filters | dict | Bekijk [Maatregelfilters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta-appartementen/maatregelfilters) | | | fetch\_definitive\_label | integer | Ophalen van het definitieve energielabel uit EP-online |

0 = Uitschakelen

1 = Inschakelen

Standaard: 0

| | eco\_delta | boolean | Ophalen van de Ecowaarde |

0 = Uitschakelen

1 = Inschakelen

Standaard: 1

| {% hint style="info" %} ***Voor de meest nauwkeurige resultaten is het aan te raden zowel de positie als het aantal verdiepingen van het appartement op te geven.*** {% endhint %} {% tabs %} {% tab title="200: OK Successful response" %} ``` { "tip": null, "warnings": [ { "code": "11", "description": "Current building with energy label C already meets default target_label A." } ], "address": { "housenumber": 227, "postcode": "3024XL", "houseaddition": "B", "street": "Willem Buytewechstraat", "city": "Rotterdam", "location": { "lat": 51.90761152288453, "lon": 4.451398538183942 } }, "building": { "build_year": 1927, "inner_surface": 74, "floor_surface": 0, "roof_surface": 0, "wall_surface": 50.2, "glass_living_room_surface": 13.4, "number_of_doors": 5, "floors": "Single", "main_type": "Appartement", "sub_type": null }, "label": { "current": "C", "potential": "B" }, "provided_label": { "temporary": "G", "definitive": null, "definitive_type": null, "definitive_validity": null }, "BENG2": { "current": 245, "potential": 181 }, "meta": null, "CO2": { "current": 2357, "potential": 2141 }, "financial": { "total_investment": 2309, "total_saving": 164, "months_to_pay_off": 168, "eco_value": 0, "savings_monthly": 14, "energy_cost_monthly": { "current": 175, "potential": 161 }, "energy_cost_yearly": { "current": 2096, "potential": 1932 }, "return_on_investment": "0.52%", "loan": { "monthly_payment": 10 } }, "gas_usage": { "current": 888, "potential": 769 }, "electricity_usage": { "current": 2262, "potential": 2255 }, "city_heating_usage": { "current": 0, "potential": 0 }, "solar_panel_yield": { "current": 0, "potential": 0 }, "energy_prices": { "variable_gas_price": 1.359, "variable_electricity_price": 0.27, "solarpanel_watt_peak_per_m2": 250 }, "solar_panels": { "current": null, "potential": null }, "measures": { "wall_insulation": { "before": { "desc": "Geen", "value": 1, "points": 2 }, "after": { "desc": "Goed", "value": 3, "points": 5 }, "investment": 2309, "savings": 164, "co2_reduce": 215, "BENG2": "100", "gas_savings": 119, "electricity_savings": 7 }, "floor_insulation": { "before": { "desc": "Geen", "value": 1, "points": 0 }, "after": { "desc": "Geen", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "roof_insulation": { "before": { "desc": "Geen", "value": 1, "points": 0 }, "after": { "desc": "Geen", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "living_room_windows": { "before": { "desc": "Enkel glas", "value": 1, "points": 0 }, "after": { "desc": "Enkel glas", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "installation": { "before": { "desc": "HR combi ketel", "value": 4, "points": 15 }, "after": { "desc": "HR combi ketel", "value": 4, "points": 15 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "shower": { "before": { "desc": "Geen Douche WTW", "value": 1, "points": null }, "after": { "desc": "Geen Douche WTW", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "cooling": { "before": { "desc": "No cooling", "value": 1, "points": null }, "after": { "desc": "No cooling", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "ventilation": { "before": { "desc": "Natuurlijke ventilatie", "value": 1, "points": 0 }, "after": { "desc": "Natuurlijke ventilatie", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "solar_panels": { "before": { "desc": "0", "value": 0, "points": null }, "after": { "desc": "0", "value": 0, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "electric_cooking": { "before": { "desc": "Gas stove", "value": 1, "points": null }, "after": { "desc": "Gas stove", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 } }, "response_meta": null } ``` {% endtab %} {% tab 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." } { "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." } ``` {% endtab %} {% tab title="401: Unauthorized No access" %} ``` { 'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.' } ``` {% endtab %} {% tab title="422: Unprocessable Entity Wrong input format" %} ``` { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } ``` {% endtab %} {% tab title="500: Internal Server Error Service is not available and/or down" %} ``` { "message": "Internal server error" } ``` {% endtab %} {% tab title="403: Forbidden Forbidden" %} ``` { "message": "Missing Authentication Token" } ``` {% endtab %} {% tab title="301: Moved Permanently error" %} ``` { "detail": "Unable to check house." } ``` {% endtab %} {% tab title="303: See Other house type error" %} ``` { "detail": "House type not found in database. Use house_type parameter instead." } ``` {% endtab %} {% endtabs %} **Vraag een duurzaamheidsadvies op basis van BagID op.**\ **Nog te bepalen (TBD).** --- # 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/verduurzamen/verduurzaming-api-v2-delta-appartementen/authenticatie-invoer-en-resultaat.md?ask=&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.