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

# Authenticatie, invoer en resultaat

## Vraag een duurzaamheidsadvies aan op basis van adres.

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

Met dit endpoint kun je een reactie ontvangen van de **Altum AI Sustainability Delta API** over de duurzaamheid en de Ecowaarde, op basis van postcode, huisnummer en eventuele toevoeging.

#### Headers

| Naam                                        | Type   | Omschrijving                                                                         |
| ------------------------------------------- | ------ | ------------------------------------------------------------------------------------ |
| Content-Type                                | string | Applicatie/json                                                                      |
| x-api-key<mark style="color:red;">\*</mark> | string | Unieke API sleutel van Altum. Maak er één aan via Mopsus (<https://mopsus.altum.ai>) |

#### Request Body

| Naam                                          | Type    | Omschrijving                                                                                                                                                 | Voorbeeld / Standaard                                                                                                                                             |
| --------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| postcode<mark style="color:red;">\*</mark>    | string  | Zes-cijferige postcode formaat                                                                                                                               | 1234AB                                                                                                                                                            |
| housenumber<mark style="color:red;">\*</mark> | int     | Huisnummer van het object                                                                                                                                    | 5                                                                                                                                                                 |
| houseaddition                                 | string  | Huisnummertoevoeging                                                                                                                                         | C                                                                                                                                                                 |
| build\_year                                   | int     | Bouwjaar                                                                                                                                                     | 1956                                                                                                                                                              |
| roof\_type                                    | int     | <p><code>1</code> = (voornamelijk) schuin dak</p><p><code>2</code> = (voornamelijk) plat dak</p><p><code>3</code> = deels schuin, deels plat dak<br><br></p> | <p>Standaard: 1<br><br><strong>Let op:</strong> Als het platte of schuine deel meer dan 25% van het dakoppervlak beslaat, wordt type <code>3</code> gebruikt.</p> |
| house\_type                                   | int     | <p><code>1</code> = vrijstaande woning</p><p><code>2</code> = 2-onder-1-kapwoning</p><p><code>3</code> = hoekwoning</p><p><code>4</code> = tussenwoning</p>  | 2                                                                                                                                                                 |
| inner\_surface\_area                          | float   | De totale woonoppervlakte (m²)                                                                                                                               | 70                                                                                                                                                                |
| wall\_insulation                              | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 2                                                                                                                                                                 |
| target\_wall\_insulation                      | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 4                                                                                                                                                                 |
| floor\_insulation                             | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 1                                                                                                                                                                 |
| target\_floor\_insulation                     | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 4                                                                                                                                                                 |
| sloped\_roof\_insulation                      | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 2                                                                                                                                                                 |
| target\_sloped\_roof\_insulation              | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 4                                                                                                                                                                 |
| flat\_roof\_insulation                        | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 2                                                                                                                                                                 |
| target\_flat\_roof\_insulation                | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 4                                                                                                                                                                 |
| living\_room\_windows                         | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 1                                                                                                                                                                 |
| target\_living\_room\_windows                 | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 3                                                                                                                                                                 |
| bedroom\_windows                              | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 1                                                                                                                                                                 |
| target\_bedroom\_windows                      | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 4                                                                                                                                                                 |
| installation                                  | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | Standaard: 4                                                                                                                                                      |
| target\_installation                          | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 8                                                                                                                                                                 |
| shower                                        | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | Standaard: 1                                                                                                                                                      |
| target\_shower                                | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 2                                                                                                                                                                 |
| cooling                                       | int     | <p>Is er een koelsysteem aanwezig?<br><code>1</code> = Geen koeling</p><p><code>2</code> = Airconditioning, directe luchtkoeling</p>                         | 1                                                                                                                                                                 |
| target\_cooling                               | int     | <p>Is er een koelsysteem aanwezig?<br><code>1</code> = Geen koeling</p><p><code>2</code> = Airconditioning, directe luchtkoeling</p>                         | 2                                                                                                                                                                 |
| ventilation                                   | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 2                                                                                                                                                                 |
| target\_ventilation                           | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              | 3                                                                                                                                                                 |
| electric\_cooking                             | int     | <p>Wat wordt gebruikt om te koken?<br><code>1</code>= Gasfornuis</p><p><code>2</code> = Elektrisch fornuis</p>                                               | <p><em>Als de installatie in \[6,7] zit -> 2,</em> <br><em>anders standaard 1</em></p>                                                                            |
| target\_electric\_cooking                     | int     | <p>Wat wordt gebruikt om te koken?<br><code>1</code>= Gasfornuis</p><p><code>2</code> = Elektrisch fornuis</p>                                               |                                                                                                                                                                   |
| inhabitants                                   | int     | Aantal bewoners                                                                                                                                              | Standaard: 3                                                                                                                                                      |
| ev\_charger                                   | int     | <p>Heeft het gebouw een laadpaal voor elektrische voertuigen?</p><p><code>0</code> = geen laadpaal<br><code>1</code> = laadpaal aanwezig</p>                 | Standaard: 0                                                                                                                                                      |
| electricity\_connection\_type                 | int     | <p>Het aansluitingstype van het gebouw</p><p><code>1</code> = 1-fase <br><code>2</code> = 3-fase</p>                                                         | Standaard: 1                                                                                                                                                      |
| target\_electricity\_connection\_type         | int     | <p>Het aansluitingstype van het gebouw</p><p><code>1</code> = 1-fase <br><code>2</code> = 3-fase</p>                                                         | 2                                                                                                                                                                 |
| electricity\_contract\_type                   | int     | <p>Type elektriciteitscontract</p><p><code>1</code> = vast contract <br><code>2</code> = dynamisch contract</p>                                              | Standaard: 1                                                                                                                                                      |
| dynamic\_price\_reference\_year               | int     | <p>Het jaar vanaf wanneer dynamische prijzen worden gebruikt:</p><p><code>2023</code>, <code>2024</code>, <code>2025</code></p>                              | Standaard: 2025                                                                                                                                                   |
| netting\_enabled                              | int     | <p>Of de salderingsregeling wordt toegepast.</p><p><code>0</code> = geen saldering<br><code>1</code> = saldering toegepast</p>                               | Standaard: 1                                                                                                                                                      |
| solar\_panels                                 | list    | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| number\_of\_solar\_panels                     | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| battery\_type                                 | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| target\_battery\_type                         | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| battery\_system                               | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| target\_battery\_system                       | int     | Bekijk [Maatregelen](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen)                                                              |                                                                                                                                                                   |
| 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   | <p>Totale jaarlijkse elektriciteitsopbrengst van zonnepanelen (kWh)<br>Netto verbruik = verbruik − opbrengst</p>                                             | 800                                                                                                                                                               |
| exclude\_vat                                  | boolean | <p>Prijzen zijn inclusief of exclusief btw.<br><code>false</code> = Inclusief btw</p><p><code>true</code> = Exclusief btw</p>                                | Standaard: `false`                                                                                                                                                |
| cost\_indicators                              | dict    | Bekijk [Kostenindicatoren](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/kostenindicatoren)                                                  |                                                                                                                                                                   |
| wall\_filters                                 | dict    | Bekijk [Maatregelen filters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen-filters)                                              |                                                                                                                                                                   |
| sloped\_roof\_filters                         | dict    | Bekijk [Maatregelen filters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen-filters)                                              |                                                                                                                                                                   |
| flat\_roof\_filters                           | dict    | Bekijk [Maatregelen filters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen-filters)                                              |                                                                                                                                                                   |
| floor\_filters                                | dict    | Bekijk [Maatregelen filters](https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/maatregelen-filters)                                              |                                                                                                                                                                   |
| eco\_delta                                    | boolean | <p>Ophalen van de Ecowaarde<br>0 = Uitschakelen</p><p>1 = Inschakelen</p>                                                                                    | <p></p><p><em>Standaard: 1</em></p>                                                                                                                               |

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

```
{
  "warnings": [],
  "address": {
    "housenumber": 87,
    "postcode": "2771DS",
    "houseaddition": null,
    "street": "Zuidkade",
    "city": "Boskoop",
    "location": {
      "lat": 52.0683938167,
      "lon": 4.6580852695
    }
  },
  "building": {
    "build_year": 1961,
    "inner_surface": 131,
    "floor_surface": 80.8,
    "flat_roof_surface": 5.2,
    "pitched_roof_surface": 98.9,
    "wall_surface": 126.1,
    "glass_living_room_surface": 11.1,
    "glass_bedrooms_surface": 16.6,
    "number_of_doors": 6,
    "type": "Vrijstaand"
  },
  "label": {
    "current": "E",
    "potential": "D"
  },
  "provided_label": {
    "temporary": "F",
    "definitive": "A+++",
    "definitive_type": "NTA 8800:2024 (basisopname woningbouw)",
    "definitive_validity": "2036-1",
    "definitive_beng2": 49
  },
  "BENG2": {
    "current": 315,
    "potential": 260
  },
  "meta": null,
  "CO2": {
    "current": 4086,
    "potential": 3847
  },
  "grid_import": {
    "current": 3259,
    "potential": 3259
  },
  "grid_feed": {
    "current": 0,
    "potential": 0
  },
  "electricity_need": {
    "current": 3259,
    "potential": 3259
  },
  "financial": {
    "total_investment": 22439,
    "total_saving": 182,
    "months_to_pay_off": 1479,
    "eco_value": 22461,
    "savings_monthly": 15,
    "energy_cost_monthly": {
      "current": 285,
      "potential": 270
    },
    "energy_cost_yearly": {
      "current": 3422,
      "potential": 3240
    },
    "electricity_cost_yearly": {
      "current": 1455,
      "potential": 1455
    },
    "return_on_investment": "-0.83%",
    "loan": {
      "monthly_payment": 93
    }
  },
  "gas_usage": {
    "current": 1666,
    "potential": 1532
  },
  "electricity_usage": {
    "current": 3263,
    "potential": 3263
  },
  "city_heating_usage": {
    "current": 0,
    "potential": 0
  },
  "energy_prices": {
    "variable_gas_price": 1.359,
    "variable_electricity_price": 0.27,
    "solarpanel_watt_peak_per_m2": null
  },
  "solar_panels": {
    "summary": {
      "current": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      },
      "potential": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      }
    },
    "systems": {
      "current": null,
      "potential": null
    }
  },
  "battery": {
    "current": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ],
    "potential": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ]
  },
  "measures": {
    "wall_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "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": "Zeer goed",
        "value": 4,
        "points": 7
      },
      "investment": 3903,
      "savings": 35,
      "co2_reduce": 46,
      "BENG2": "22",
      "gas_savings": 26,
      "electricity_savings": 0
    },
    "sloped_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Zeer goed",
        "value": 4,
        "points": 3
      },
      "investment": 11260,
      "savings": 105,
      "co2_reduce": 138,
      "BENG2": "62",
      "gas_savings": 77,
      "electricity_savings": 0
    },
    "flat_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 3
      },
      "investment": 484,
      "savings": 3,
      "co2_reduce": 4,
      "BENG2": "2",
      "gas_savings": 2,
      "electricity_savings": 0
    },
    "living_room_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Drievoudig glas",
        "value": 4,
        "points": 3
      },
      "investment": 3089,
      "savings": 6,
      "co2_reduce": 8,
      "BENG2": "5",
      "gas_savings": 4,
      "electricity_savings": 0
    },
    "bedroom_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": null
      },
      "after": {
        "desc": "HR++ glas",
        "value": 3,
        "points": null
      },
      "investment": 3703,
      "savings": 10,
      "co2_reduce": 13,
      "BENG2": "7",
      "gas_savings": 7,
      "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 Apartment  error" %}

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

{% endtab %}

{% tab title="303: See Other house type error" %}

```
{ 
  "detail": "House type not found in database. Use house_type parameter instead." 
}
```

{% endtab %}
{% endtabs %}


---

# 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:

```
GET https://docs.altum.ai/verduurzamen/verduurzaming-api-v2-delta/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.
