> 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-appartementen/authenticatie-invoer-en-resultaat.md).

# 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/apartments`

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 bijv. 1</td><td></td></tr><tr><td>houseaddition</td><td>string</td><td>Huisnummertoevoeging bijv. A</td><td></td></tr><tr><td>position</td><td>integer</td><td><code>1</code>  = Hoekappartement begane grond<br><code>2</code> = Tussenappartement begane grond<br><code>3</code> = Hoekappartement middenverdieping<br><code>4</code> = Tussenappartement middenverdieping<br><code>5</code> = Hoekappartement bovenste verdieping<br><code>6</code> = Tussenappartement bovenste verdieping<br><code>7</code> = Volledige bovenste verdieping</td><td>1</td></tr><tr><td>floors</td><td>integer</td><td><p>Heeft de woning één of meerdere verdiepingen?</p><p>1 = Enkel<br>2 = Meerdere</p></td><td>1</td></tr><tr><td>back_facade</td><td>boolean</td><td><p>Heeft de woning een achtergevel?</p><p>false = nee<br>true = ja</p></td><td>false</td></tr><tr><td>build_year</td><td>integer</td><td>Bouwjaar van het object</td><td></td></tr><tr><td>inner_surface_area</td><td>float</td><td>Oppervlakte (m²)</td><td></td></tr><tr><td>apartment_type</td><td>integer</td><td><code>1</code> = 'Galerijflat'<br><code>2</code> = 'Portiekflat'<br><code>3</code> = 'Maisonnette'<br><code>4</code> = 'Benedenwoning'<br><code>5</code> = 'Bovenwoning'<br><code>6</code> = 'Portiekwoning</td><td>2</td></tr><tr><td>wall_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>2</td></tr><tr><td>floor_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>2</td></tr><tr><td>roof_insulation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>2</td></tr><tr><td>living_room_windows</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>2</td></tr><tr><td>installation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>4</td></tr><tr><td>shower</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>1</td></tr><tr><td>ventilation</td><td>integer</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td>1</td></tr><tr><td>solar_panels</td><td>list</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen">Maatregelen</a></td><td><br></td></tr><tr><td>number_of_solar_panels</td><td>integer </td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/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<br>2 = Airconditioning (directe luchtkoeling)<br>Standaardwaarde</p></td><td>1</td></tr><tr><td>electric_cooking</td><td>integer</td><td><p>Wat wordt gebruikt om te koken?</p><p>1 = Gaskookplaat<br>2 = Elektrische kookplaat</p></td><td><p>2 als <code>installation</code> in [6,7] staat, anders 1</p><p><br></p></td></tr><tr><td>inhabitants</td><td>integer</td><td>Aantal bewoners</td><td>3</td></tr><tr><td>gas_usage</td><td>float</td><td>Overschrijft geschat jaarlijks gasverbruik in m³</td><td></td></tr><tr><td>heat_usage</td><td>float</td><td>Overschrijft opgegeven jaarlijks warmteverbruik in GJ</td><td></td></tr><tr><td>electricity_usage</td><td>float</td><td>Overschrijft opgegeven jaarlijks elektriciteitsverbruik in kWh</td><td></td></tr><tr><td>electricity_generation</td><td>float</td><td><p>Totale jaarlijkse elektriciteitsopwekking van zonnepanelen in kWh</p><p>Nettoverbruik = verbruik − opwekking</p></td><td></td></tr><tr><td>minimum_solar_panels</td><td>integer</td><td>Minimum aantal nieuw te plaatsen zonnepanelen</td><td>4</td></tr><tr><td>search_criteria</td><td>integer</td><td><p>1 = laagste investeringskosten<br>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-energielabel (standaard is energielabel A of D)</td><td>A+</td></tr><tr><td>max_investment</td><td>integer</td><td>Maximale investering, gebruik 0 voor onbeperkt</td><td></td></tr><tr><td>energylabel_strict</td><td>integer</td><td>Strikte zoekmodus binnen target_label activeren met 1</td><td>0</td></tr><tr><td>natural_gas</td><td>integer</td><td><p>1 = geen filter</p><p>2 = aardgas verplicht<br>3 = aardgasvrij</p></td><td>1</td></tr><tr><td>heat_pump_allowed</td><td>boolean</td><td><p>false = niet toegestaan</p><p>true = toegestaan</p></td><td>false</td></tr><tr><td>district_heating_allowed</td><td>boolean</td><td><p>false = niet toegestaan</p><p>true = toegestaan</p></td><td>false</td></tr><tr><td>heatpump_insulation_req</td><td>integer</td><td><p>Minimale isolatie-eis voordat een warmtepomp is toegestaan.<br>1 = geen minimale eis</p><p>2 = schil, inclusief glas minimaal 2</p><p>3 = woning voldoet aan “standaard”</p></td><td>1</td></tr><tr><td>exclude_vat</td><td>boolean</td><td><p>Prijzen inclusief of exclusief btw</p><p>false = btw inbegrepen</p><p>true = btw exclusief</p></td><td>false</td></tr><tr><td>cost_indicators</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/kostenindicatoren">Kostenindicatoren</a></td><td></td></tr><tr><td>wall_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/maatregelen-filters">Maatregelen filters</a></td><td></td></tr><tr><td>roof_filters</td><td>dict</td><td>Bekijk <a href="https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-appartementen/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-appartementen/maatregelen-filters">Maatregelen filters</a></td><td></td></tr><tr><td>eco_delta</td><td>boolean</td><td><p>Ecowaarde-berekening </p><p><code>0</code> = uitschakelen</p><p><code>1</code> = inschakelen</p></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-appartementen/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-appartementen/maatregelen-uitsluiten">Maatregelen uitsluiten</a></td><td></td></tr></tbody></table>

{% hint style="info" %}
\*<mark style="color:red;">\*\*Het is aan te raden zowel de positie als het aantal verdiepingen van het appartement op te geven voor optimale resultaten.\*\*</mark>\*
{% endhint %}

{% tabs %}
{% tab title="200: OK Successful response" %}

```
{
  "warnings": [],
  "address": {
    "housenumber": 227,
    "postcode": "3024XL",
    "houseaddition": "B",
    "street": "Willem Buytewechstraat",
    "city": "Rotterdam",
    "location": {
      "lat": 51.9076115229,
      "lon": 4.4513985382
    }
  },
  "building": {
    "build_year": 1927,
    "inner_surface": 74,
    "floor_surface": 74,
    "flat_roof_surface": null,
    "pitched_roof_surface": null,
    "wall_surface": 50.2,
    "glass_living_room_surface": 13.4,
    "glass_bedrooms_surface": null,
    "number_of_doors": 5,
    "apartment_type": "Portiekwoning"
  },
  "label": {
    "current": "C",
    "potential": "A+"
  },
  "accuracy_indicator": 3,
  "provided_label": {
    "temporary": "G",
    "definitive": null,
    "definitive_type": null,
    "definitive_validity": null,
    "definitive_beng2": null
  },
  "BENG2": {
    "current": 191,
    "potential": 87
  },
  "meta": null,
  "CO2": {
    "current": 2095,
    "potential": 2022
  },
  "financial": {
    "total_investment": 17400,
    "total_saving": 32,
    "months_to_pay_off": 6516,
    "eco_value": 39246,
    "savings_monthly": 3,
    "energy_cost_monthly": {
      "current": 158,
      "potential": 155
    },
    "energy_cost_yearly": {
      "current": 1896,
      "potential": 1864
    },
    "return_on_investment": "-0.89%",
    "loan": {
      "monthly_payment": 72
    }
  },
  "gas_usage": {
    "current": 741,
    "potential": 321
  },
  "electricity_usage": {
    "current": 2262,
    "potential": 4262
  },
  "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": "Goed",
        "value": 3,
        "points": 5
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 5
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "floor_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 7
      },
      "investment": 2553,
      "savings": 51,
      "co2_reduce": 67,
      "BENG2": "17",
      "gas_savings": 37,
      "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": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "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": "Hybride WP",
        "value": 8,
        "points": 20
      },
      "investment": 6621,
      "savings": -38,
      "co2_reduce": -20,
      "BENG2": "80",
      "gas_savings": 368,
      "electricity_savings": -2000
    },
    "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": "Decentrale balansventilatie",
        "value": 4,
        "points": 5
      },
      "investment": 8226,
      "savings": 116,
      "co2_reduce": 152,
      "BENG2": "34",
      "gas_savings": 85,
      "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 Apartment  error" %}

```
{
    "detail": "Unable to check house."
}
```

{% endtab %}
{% endtabs %}

## Request body

#### Voorbeeld request

```
{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1
}
```


---

# 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 dynamically by asking a question.

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

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.