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

# Authenticatie, invoer en resultaat

## Haal energie- en klimaatgegevens op voor een bepaald pand op basis van adres

<mark style="color:green;">`POST`</mark> `https://api.altum.ai/energy-climate`

Voor het opvragen van alle relevante BAG-, energielabel- & klimaatgegevens voor een woning.

#### Headers

| Name                                        | Type   | Description                                                                                                  |
| ------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------ |
| x-api-key<mark style="color:red;">\*</mark> | string | Unieke API-sleutel van Altum. Maak er een aan op [https://platform.altum.ai](https://platform.altum.ai/auth) |
| Content-Type                                | string | application/json                                                                                             |

#### Request Body

| Name                                          | Type   | Description                                                                                |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------ |
| postcode<mark style="color:red;">\*</mark>    | string | Postcode van object. bijv.: 1234BB                                                         |
| houseaddition                                 | string | De huisletter en huisoptelling van het object. bijv.: A1 (accepteert geen speciale tekens) |
| housenumber<mark style="color:red;">\*</mark> | number | Het huisnummer van het object. bijv: 5                                                     |

{% tabs %}
{% tab title="200: OK Succesvolle reactie" %}

```
{
	"Output": {
		"bag_id": "0363010000735772",
		"postcode": "1024CT",
		"housenumber": "25",
		"housenumberaddition": "None",
		"pand_id": "0363100012101774",
		"city": "Amsterdam",
		"street": "Markengouw",
		"building_status": "Pand in gebruik",
		"object_function": "woonfunctie",
		"object_status": "Verblijfsobject in gebruik",
		"inner_surface_area": "76",
		"build_year": "1967",
		"monument": "None",
		"monument_description": "Geen monument / Onbekend",
		"epc_label": "D",
		"calculation_method": "NTA 8800:2022 (basisopname woningbouw)",
		"registration_date": "20221107",
		"validity": "20321010",
		"primary_energy_demand": "255.78",
		"primary_energy_demand_emg": "255.78",
		"demand_primary_fossil_energy": "None",
		"percentage_renewable": "None",
		"demandpercentagerenewable": "None",
		"percentagerenewablelumpsum": "None",
		"heat_demand": "181.99",
		"energy_demand": "182.6",
		"energy_index": "None",
		"energy_index_fixed_emg_lumpsum": "None",
		"demand_energy_need": "None",
		"temperature_exceedance": "1.77",
		"demand_temperature_exceedance": "None",
		"subsidence_2020_2050_high": "0.0283684033612987",
		"subsidence_2020_2050_low": "0.0266615749903464",
		"subsidence_2020_2100_high": "0.0559195945068944",
		"subsidence_2020_2100_low": "0.0508072813573541",
		"soil_subsidence_due_elevation_2020_2050": "0.2649501278801023",
		"average_highest_groundwater_level_2050_high": "0.0662050768733024",
		"average_highest_groundwater_level_current": "0.7322854995727539",
		"average_lowest_groundwater_level_2050_high": "-0.0944000035524368",
		"average_lowest_groundwater_level_2050_low": "-0.0400299988687038",
		"average_lowest_groundwater_level_current": "1.374940037727356",
		"sensitivity_to_water_erosion": "99999.0",
		"heat_map_perceived_temperature_2050_high": "None",
		"heat_map_perceived_temperature_current": "None",
		"heat_stress_due_to_warm_nights_2050_high": "0.7507284879684448",
		"heat_stress_due_to_warm_nights_current": "0.7507284879684448",
		"seepage_and_infiltration_2050_high": "0.102735698223114",
		"seepage_and_infiltration_current": "0.1016992032527923",
		"lowest_groundwater_level_extremely_dry_summer_2050_high": "-0.046509999781847",
		"lowest_groundwater_level_extremely_dry_summer_2050_low": "-0.0190699994564056",
		"lowest_groundwater_level_extremely_dry_summer_current": "1.496945023536682",
		"wild_fire_sensitivity_2050_high": "None",
		"wild_fire_sensitivity_current": "None",
		"flood_depth_extreme_probability": "0.3700000047683716",
		"flood_depth_big_probability": "None",
		"flood_depth_small_probability": "0.0718051269650459",
		"flood_depth_medium_probability": "None",
		"location_based_flood_probability_2050_0cm": "1.0",
		"location_based_flood_probability_2050_200cm": "None",
		"location_based_flood_probability_2050_20cm": "1.0",
		"location_based_flood_probability_2050_50cm": "None",
		"risk_of_drought_stress_2050_high": "None",
		"risk_of_drought_stress_current": "None",
		"risk_of_subsoil_compaction_2050_high": "901.0",
		"risk_of_oxygen_otress_2050_high": "None",
		"risk_of_oxygen_otress_current": "None",
		"subsidence_okt16_okt18": "1.0",
		"urban_heat_island_effect": "0.6880000233650208",
		"urban_infiltration_probabilities": "18.0",
		"water_depth_intense_precipitation_1_per_1000_years": "None",
		"water_depth_intense_precipitation_1_per_100_years": "None",
		"number_of_ice_days_2050_high": "0-2",
		"number_of_ice_days_2050_low": "2-4",
		"number_of_ice_days_current": "8-10",
		"number_of_tropical_days_2050_low": "3-6",
		"number_of_tropical_days_current": "0-3",
		"number_of_frost_days_2050_high": "10-20",
		"number_of_frost_days_2050_low": "30-40",
		"number_of_frost_days_current": "50-60",
		"number_of_warm_days_2050_high": "105-120",
		"number_of_warm_days_2050_low": "75-90",
		"number_of_warm_days_current": "60-75",
		"number_of_summer_days_2050_high": "30 - 40",
		"number_of_summer_days_2050_low": "20 - 30",
		"number_of_summer_days_current": "10 - 20",
		"distance_to_coolness": "0 - 200 meter",
		"natural_system_main_class": "3 Laagveen",
		"natural_system_sub_classa": "Lv1 Laagveenvlakte",
		"days_with_gte_15mm_2050_high": "15-17",
		"days_with_gte_15mm_2050_low": "15-17",
		"days_with_gte_15mm_current": "13-15",
		"days_with_gte_25mm_2050_high": "4-5",
		"days_with_gte_215mm_2050_low": "3-4",
		"days_with_gte_25mm_current": "2-3",
		"drought_sensitivity_groundwater_dependent_nature": "None",
		"annual_precipitation_2050_high": "950-1000",
		"annual_precipitation_current": "900-950",
		"annual_reference_evaporation_2050_high": "610 - 630",
		"annual_reference_evaporation_current": "570 - 590",
		"probability_map_consequence_limitation": "beperken schade bij ondiepe overstroming (20-50cm)",
		"agricultural_area": "None",
		"longest_series_of_consecutive_summer_days_gte_25_days_2050_high": "9-11",
		"longest_series_of_consecutive_summer_days_gte_25_days_current": "5-7",
		"precipitation_winter_quarter_2050_high": "250-275",
		"precipitation_winter_quarter_current": "225-250 mm",
		"precipitation_summer_quarter_2050_high": "200 - 225",
		"precipitation_summer_quarter_current": "225 - 250 mm",
		"development_probbility_groundwater_nuisance_2050_high": "Aanmerkelijke toename kans",
		"potential_maximum_precipitation_deficit_once_per_10_years_2050_high": "270 - 300",
		"potential_maximum_precipitation_deficit_once_per_10_years_current": "210 - 240",
		"potential_maximum_precipitation_deficit_average_2050_high": "210 - 240",
		"potential_maximum_precipitation_deficit_average_current": "150 - 180",
		"risk_of_surface_water_warming_2050_high": "None",
		"risk_of_surface_water_warming_current": "None",
		"surface_water_shortage_extremely_dry_year_2050_high": "te weinig",
		"surface_water_shortage_extremely_dry_year_current": "geen problemen",
		"surface_water_shortage_average_year_2050_high": "geen problemen",
		"surface_water_shortage_average_year_current": "geen problemen",
		"complete_map_of_climate_buffers": "None",
		"neighborhood_typology": "Tuinstad hoogbouw"
	}
}
```

{% endtab %}

{% tab title="400: Bad Request Mislukte reactie" %}

```
{
  "Output": "The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist."
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Verkeerd invoerformaat" %}

```
{
	"detail": [
		{
			"loc": [
				"body",
				"housenumber"
			],
			"msg": "value is not a valid integer",
			"type": "type_error.integer"
		}
	]
}
```

{% endtab %}

{% tab title="500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar" %}

```
{
	"message": "Internal server error"
}
```

{% endtab %}

{% tab title="401: Unauthorized Geen toegang" %}

```
{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}
```

{% endtab %}

{% tab title="403: Forbidden Verboden" %}

```
{
	"message": "Missing Authentication Token"
}
```

{% endtab %}
{% endtabs %}

## Haal energie- en klimaatgegevens op voor een bepaald pand op basis van BAG-ID

<mark style="color:blue;">`GET`</mark> `https://api.altum.ai/energy-climate?bag_id=`

#### Query Parameters

| Name                                      | Type   | Description           |
| ----------------------------------------- | ------ | --------------------- |
| bag\_id<mark style="color:red;">\*</mark> | string | BAG-ID van 16 cijfers |

#### Headers

| Name                                        | Type   | Description                                                                 |
| ------------------------------------------- | ------ | --------------------------------------------------------------------------- |
| x-api-key<mark style="color:red;">\*</mark> | string | API-sleutel van Altum. Maak er een aan via Mopsus(<https://mopsus.altum.ai> |
| Content-Type                                | string | application/json                                                            |

{% tabs %}
{% tab title="200: OK Succesvolle reactie" %}

```
{
	"Output": {
		"bagid": "0575010000034068",
		"postcode": "2201PZ",
		"housenumber": 11,
		"housenumberaddition": null,
		"pandid": "0575100000034238",
		"city": "Noordwijk",
		"street": "Hofvennepark",
		"buildingstatus": "Pand in gebruik",
		"objectfunction": "woonfunctie",
		"objectstatus": "Verblijfsobject in gebruik",
		"innersurfacearea": 425,
		"buildyear": 2002,
		"monument": "no",
		"monumentdescription": "Geen monument / Onbekend",
		"epclabel": "B",
		"calculationmethod": "Rekenmethodiek Definitief Energielabel, versie 1.2, 16 september 2014",
		"registrationdate": 20170814,
		"validity": 20270814,
		"primaryenergydemand": null,
		"primaryenergydemand-emg": null,
		"demandprimaryfossilenergy": null,
		"percentagerenewable": null,
		"demandpercentagerenewable": null,
		"percentagerenewablelumpsum": null,
		"heatdemand": null,
		"energydemand": null,
		"energyindex": null,
		"energyindexfixedemglumpsum": null,
		"demandenergyneed": null,
		"temperatureexceedance": null,
		"demandtemperatureexceedance": null
	}
}
```

{% endtab %}

{% tab title="400: Bad Request Mislukte reactie" %}

```
{
   "Output": "Could not find any object with your BAG ID"
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Verkeerd invoerformaat" %}

```
{
	"detail": [
		{
			"loc": [
				"query",
				"bag_id"
			],
			"msg": "ensure this value has at most 16 characters",
			"type": "value_error.any_str.max_length",
			"ctx": {
				"limit_value": 16
			}
		}
	]
}
```

{% endtab %}

{% tab title="500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar" %}

```
{
	"message": "Internal server error"
}
```

{% endtab %}

{% tab title="401: Unauthorized Geen toegang" %}

```
{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}
```

{% endtab %}

{% tab title="403: Forbidden Verboden" %}

```
{
	"message": "Missing Authentication Token"
}
```

{% endtab %}
{% endtabs %}

## Request body

#### Voorbeeld verzoek

```
{
  "postcode": "2201PZ",
  "housenumber": 11,
  "valuationdate": "20221001"
}
```


---

# 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/verzekeren/energie-en-klimaat-api/authenticatie-invoer-en-resultaat.md?ask=<question>&goal=<user_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.