Authenticatie, invoer en resultaat

Details over de invoer-, uitvoer- en authenticatievereisten.

Bepaal het geschatte huidige of potentiële NTA 8800 energielabel

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

Headers

Name

Type

Description

x-api-key*

string

Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Content-Type

string

application/json

Request Body

Name

Type

Description

post_code*

String

1234AB

house_number*

Number

house_addition

String

inner_surface_area

Number

100

build_year

Number

2001

house_type

Number

huidige woningtype: '2 onder 1 kap' = 1, 'hoekwoning' = 2, 'tussenwoning' = 3, 'vrijstaand' = 4 of 'appartement' = 5

installation

Number

huidig installatietype - zie maatregelen

wall_insulation

Number

huidige muurisolatie - zie maatregelen

roof_insulation

Number

huidige dakisolatie - zie maatregelen

floor_insulation

Number

huidige vloerisolatie- zie maatregelen

living_room_windows

Number

huidige woonkamerramen - zie maatregelen

bedroom_windows

Number

huidige slaapkamerramen - zie maatregelen

shower

Boolean

huidige douche WTW - zie maatregelen

ventilation

Number

huidige ventilatie - zie maatregelen

solar_panels

Number

huidige zonnepanelen in m2 of totaal watt-piekvermogen in W - zie maatregelen

solarpanel_watt_peak

Number

huidige zonnepanelen watt piekvermogen per m2

watt_panels

Boolean

neem aan dat de invoer van zonnepanelen in W (0) of m2 (1) is. Standaard = 1

inhabitants

Integer

aantal mensen dat in het huis woont

{
	"Output": {
		"post_code": "2771DS",
		"house_number": 87,
		"house_addition": null,
		"build_year": 1961,
		"inner_surface_area": 151,
		"house_type": "vrijstaand",
		"installation": 4,
		"wall_insulation": 2,
		"roof_insulation": 2,
		"floor_insulation": 2,
		"living_room_windows": 2,
		"ventilation": 1,
		"bedroom_windows": 2,
		"shower": 0,
		"solar_panels": 15,
		"solarpanel_watt_peak": 300,
		"CO2": 3084,
		"definitive_energy_label": "C",
		"definitive_energy_label_type": "NEN7120",
		"definitive_energy_label_validity_date": "2030-12",
		"current_estimated_energy_label": "B",
		"current_estimated_BENG2_score" : 146,
		"current_estimated_BENG2_score": 167,
		"estimated_gas_usage": 3108,
		"estimated_energy_usage": 760
	}
}

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}

{ 
    "detail": "Address not found in database, combination of zip code   and house number." 
}

{
     "detail": "No measures suggested for this combination of input."
}

{
     "detail": "Code used in exclude_measure parameter is invalid"
}

{
     "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": "Gevelisolatie code ongeldig"
}

Bepaal het geschatte huidige of potentiële NTA 8800 energielabel

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

Gebruik BAG_id als alternatief voor post_code, house_number en house_addition. Alle andere invoer en uitvoer is gelijk.

Headers

Name

Type

Description

x-api-key*

string

API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Content-Type

string

application/json

Request Body

Name

Type

Description

bag_id*

string

16 cijfers BAG_ID

inner_surface_area

Number

100

build_year

Number

2001

house_type

Number

huidige woningtype: '2 onder 1 kap' = 1, 'hoekwoning' = 2, 'tussenwoning' = 3, 'vrijstaand' = 4 of 'appartement' = 5

installation

Number

huidig installatietype - zie maatregelen

wall_insulation

Number

huidige muurisolatie - zie maatregelen

roof_insulation

Number

huidige dakisolatie - zie maatregelen

floor_insulation

Number

huidige vloerisolatie - zie maatregelen

living_room_windows

Number

huidige woonkamerramen - zie maatregelen

bedroom_windows

Number

huidige slaapkamerramen - zie maatregelen

shower

Boolean

huidige douche WTW - zie maatregelen

ventilation

Number

huidige ventilatie - zie maatregelen

solar_panels

Number

huidige zonnepanelen in m2 of totaal watt-piekvermogen in W - zie maatregelen

solarpanel_watt_peak

Number

huidige zonnepanelen watt piekvermogen per m2

watt_panels

Boolean

neem aan dat de invoer van zonnepanelen in W (0) of m2 (1) is. Standaard = 1

inhabitants

Integer

aantal mensen dat in het huis woont

{
	"Output": {
		"post_code": "2771DS",
		"house_number": 87,
		"house_addition": null,
		"build_year": 1961,
		"inner_surface_area": 151,
		"house_type": "vrijstaand",
		"installation": 4,
		"wall_insulation": 2,
		"roof_insulation": 2,
		"floor_insulation": 2,
		"living_room_windows": 2,
		"ventilation": 1,
		"bedroom_windows": 2,
		"shower": 0,
		"solar_panels": 15,
		"solarpanel_watt_peak": 300,
		"CO2": 3084,
		"definitive_energy_label": "C",
		"definitive_energy_label_type": "NEN7120",
		"definitive_energy_label_validity_date": "2030-12",
		"current_estimated_energy_label": "B",
		"current_estimated_BENG2_score": 167,
		"estimated_gas_usage": 3108,
		"estimated_energy_usage": 760
	}
}

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}

{ 
    "detail": "Address not found in database, combination of zip code   and house number." 
}

{
     "detail": "No measures suggested for this combination of input."
}

{
     "detail": "Code used in exclude_measure parameter is invalid"
}

{
     "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": "Gevelisolatie code ongeldig"
}

Request body

Voorbeeld verzoeken

{
  "post_code": "4709BM",
  "house_number": 1,
  "house_addition": "A",
  "installation": 1,
  "wall_insulation": 3,
  "roof_insulation": 2,
  "floor_insulation": 2,
  "living_room_windows": 3
}

{
  "bag_id": "0637010000264937",
  "installation": 1,
  "wall_insulation": 3,
  "roof_insulation": 2,
  "floor_insulation": 2,
  "living_room_windows": 3
}

PreviousChangelog NextAPI-sleutel Informatie

Last updated 1 year ago