Authenticatie, invoer en resultaat

Verstuur objectgegevens om duurzaamheidsmaatregelen per object te ontvangen

POST https://api.altum.ai/sustainability

Vraag een verduurzamingadvies op basis van adres.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
solar_panels_surface	integer	0 = Geen panelen, 1 = Maximaal de helft van de beschikbare ruimte, 2 = Volledig bedekt
natural_gas	number	0 = Aardgas toegestaan, 1 = Aardgas vereist, 2 = Aardgas niet toegestaan
post_code*	string	postcode in zes-tekenformaat, b.v. 1234AB
house_number*	number	huisnummer van het object, b.v. 1
house_addition	string	aanvulling op het huisnummer, b.v. A
target_label	string	gewenst doelenergielabel - standaard is energielabel A
inner_surface_area	integer	vierkante meter oppervlakte
inhabitants	integer	aantal mensen dat in het huis woont
replace_boiler	boolean	wel of niet toegestaan om de ketelinstallatie te vervangen
heat_pump_allowed	boolean	wel of niet mogen adviseren om een warmtepomp te implementeren
search_criteria	integer	0 = Laagste investeringskosten, 1 = Laagste energiekosten, 2 = Hoogste financiële rendement op investering, 3 = Hoogste BARe
gas_usage	integer	indien gebruikt, wordt het geschatte gasverbruik overschreven
max_investment	integer	maximale investering, gebruik 0 voor onbeperkt
watt_panels	integer	neem aan dat de invoer van zonnepanelen in W (0) of m2 (1) is. Standaard = 1
lock_measures	array	Sluismaatregelen uitgesloten van berekening
house_type	integer	Huidig woningtype: 1: halfvrijstaand, 2: hoekwoning, 3: rijtjeshuis, 4: vrijstaand huis en 5: appartement* (*dienst retourneert geen metingen voor een appartement.)
solar_panels	integer	huidige zonnepanelen in m2 (standaard) of totaal watt-piekvermogen in W (zie watt_panels) - zie maatregelen
shower	integer	huidige douche WTW - zie maatregelen
ventilation	integer	huidige ventilatie - zie maatregelen
installation	integer	huidige installatie - zie maatregelen
bedroom_windows	integer	huidige slaapkamerramen - zie maatregelen
living_room_windows	integer	huidige woonkamerramen - zie maatregelen
floor_insulation	integer	huidige vloerisolatie - zie maatregelen
wall_insulation	integer	huidige muurisolatie - zie maatregelen
roof_insulation	integer	huidige dakisolatie - zie maatregelen
eco_delta	boolean	schakel het ophalen van ecowaarde uit met 0, standaard is 1
improvement_costs	array	kosten voor inputverbetering - zie kostentabel
heat_usage	integer	ingangsstroom warmteverbruik
electricity_usage	integer	voer het huidige elektriciteitsverbruik in
build_year	integer	bouwjaar van de woning
energylabel_strict	integer	schakel strikt zoeken naar resultaten binnen target_label in met 1, standaard is 0
fetch_definitive_label	integer	activeer het ophalen van definitief label bij EP-online met 1, standaard is 0
heatpump_insulation_req	integer	0 t/m 3 definieerde de minimale isolatie-eis voor advies van een warmtepomp
exclude_measure	array	specifieke maatregelen uitsluiten - zie maatregelen uitsluiten
minimum_solar_panels	inteer	minimaal aantal zonnepanelen mee te nemen in advies indien geadviseerd
solarpanel_watt_peak	integer	Watt piekvermogen van zonnepanelen per vierkante meter
custom_costs	array	aangepaste kosten invoeren - zie kostentabel
replace_windowframes	integer	activeer extra kosten voor glasgerelateerde codes met 1, zie PDF kostentabel

200: OK Succesvolle reactie

{
	"address": {
		"house_number": 87,
		"post_code": "2771DS",
		"addition": 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
}

400: Bad Request 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."
}

401: Unauthorized Geen toegang

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

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

301: Moved Permanently Appartementfout

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

303: See Other huistypefout

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

422: Unprocessable Entity Verkeerd invoerformaat

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Verstuur objectgegevens om duurzaamheidsmaatregelen per object te ontvangen

POST https://api.altum.ai/sustainability/bag

Vraag een verduurzamingadvies op basis van BagID. Gebruik bag_id als alternatief voor post_code, house_number en house_addition. Alle andere invoer en uitvoer is gelijk.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
bag_id*	string	16 cijfers BAG_ID
inner_surface_area	integer	vierkante meter oppervlakte
build_year	integer	bouwjaar van de woning
target_label	string	gewenst doelenergielabel - standaard is energielabel A
installation	integer	huidige installatie - zie maatregelen
ventilatiom	integer	huidige ventilatie - zie maatregelen
shower	integer	huidige douche WTW - zie maatregelen
solar_panels	integer	huidige zonnepanelen in m2 (standaard) of totaal watt-piekvermogen in W (zie watt_panels) - zie maatregelen
house_type	integer	huidige woningtype: 1: halfvrijstaand, 2: hoekwoning, 3: rijtjeshuis, 4: vrijstaand huis en 5: appartement* (*dienst retourneert geen metingen voor een appartement.)
lock_measures	array	sluismaatregelen uitgesloten van berekening
watt_panels	integer	neem aan dat de invoer van zonnepanelen in W (0) of m2 (1) is. Standaard = 1
max_investment	integer	maximale investering, gebruik 0 voor onbeperkt
electricity_usage	integer	voer het huidige elektriciteitsverbruik in
heat_usage	integer	ingangsstroom warmteverbruik
gas_usage	integer	indien gebruikt, wordt het geschatte gasverbruik overschreven
search_criteria	integer	0 = Laagste investeringskosten, 1 = Laagste energiekosten, 2 = Hoogste financiële rendement op investering, 3 = Hoogste BARe
heat_pump_allowed	boolean	wel of niet mogen adviseren om een warmtepomp te implementeren
replace_boiler	boolean	wel of niet toegestaan om de ketelinstallatie te vervangen
inhabitants	integer	aantal mensen dat in het huis woont
natural_gas	integer	0 = Aardgas toegestaan, 1 = Aardgas vereist, 2 = Aardgas niet toegestaan
solar_panels_surface	integer	0 = Geen panelen, 1 = Maximaal de helft van de beschikbare ruimte, 2 = Volledig bedekt
heatpump_insulation_req	integer	0 t/m 3 definieerde de minimale isolatie-eis voor advies van een warmtepomp
fetch_definitive_label	integer	activeer het ophalen van definitief label bij EP-online met 1, standaard is 0
energylabel_strict	integer	schakel strikt zoeken naar resultaten binnen target_label in met 1, standaard is 0
improvement_costs	array	kosten voor inputverbetering - zie kostentabel
eco_delta	boolean	schakel het ophalen van ecowaarde uit met 0, standaard is 1
roof_insulation	integer	huidige dakisolatie - zie maatregelen
wall_insulation	integer	huidige muurisolatie - zie maatregelen
floor_insulation	integer	huidige vloerisolatie - zie maatregelen
living_room_windows	integer	huidige woonkamerramen - zie maatregelen
bedroom_windows	integer	huidige slaapkamerramens - zie maatregelen
exclude_measure	array	0 t/m 3 definieerde de minimale isolatie-eis voor advies van een warmtepomp - zie maatregelen uitsluiting
minimum_solar_panels	integer	minimaal aantal zonnepanelen mee te nemen in advies indien geadviseerd
solarpanel_watt_peak	integer	Wattpiekvermogen van zonnepanelen per vierkante meter
custom_costs	array	aangepaste kosten invoeren - zie kostentabel
replace_windowframes	integer	activeer extra kosten voor glasgerelateerde codes met 1, zie PDF kostentabel

200: OK Succesvolle reactie

{
	"address": {
		"house_number": 87,
		"post_code": "2771DS",
		"addition": 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
	},
	"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
}

400: Bad Request 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."
}

401: Unauthorized Geen toegang

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

422: Unprocessable Entity Verkeerd invoerformaat

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

301: Moved Permanently Appartementfout

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

303: See Other huistypefout

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

Request body

Voorbeeld verzoeken

{
    "data": {
    "post_code": "2771DS",
    "house_number": "87",
    "target_label": "A++++",
    "eco_delta": 0
	}
}

{
    "data": {
    "bag_id": "0637010000264937",
    "target_label": "A++++",
    "eco_delta": 0
	}
}