Authentication, input and response

Details on input output and authentication requirements

Post object data to receive an accurate automated model valuation

POST https://api.altum.ai/epc/pdf

Header

Name	Type	Description
Content-Type	string	multipart/form-data
x-api-key*	string	Unique API key from Altum. Create on via Mopsus

Request Body

The EPC API accepts an EPC certificate as input, also referred to as a definitive Energy Label report.

200: OK Successful Response

{
	"Output": {
		"post_code": "7875AC",
		"house_number": "12",
		"house_addition": null,
		"build_year": 1900,
		"inner_surface_area": 175,
		"house_type": "Vrijstaande woning",
		"installation": 4,
		"wall_insulation": 2,
		"roof_insulation": 2,
		"floor_insulation": 1,
		"living_room_windows": 1,
		"bedroom_windows": 1,
		"shower": 0,
		"ventilation": 1,
		"solar_panels": 15.57,
		"solarpanel_watt_peak": 240,
		"CO2": 5740,
		"definitive_energy_label": "B",
		"definitive_energy_label_type": "",
		"definitive_energy_label_validity_date": "",
		"definitive_BENG2_score": "",
		"current_estimated_energy_label": "B",
		"current_estimated_BENG1_score": 113,
		"current_estimated_BENG2_score": 186
	},
	"raw_data": {
		"Adres": "Hoofdstraat 12, 7875AC Exloo",
		"Class": "A",
		"Bouwjaar": "1900",
		"Compactheid": "2.19",
		"Vloeroppervlakte": "175",
		"Woningtype": "Vrijstaande woning",
		"Verwarming": "HR-107 ketel",
		"Warm water": "Combiketel",
		"Zonneboiler": "Geen zonneboiler",
		"Ventilatie": "Natuurlijke ventilatie via ramen en/of roosters",
		"Koeling": "Geen koeling",
		"Zonnepanelen": "3300 Wp",
		"Energy": "140.47",
		"CO2 per m2": "24.81",
		"Warmtebehoefte": "115.63",
		"Isolatie": {
			"Gevels": {
				"Noord": [
					{
						"Opp": "18.4",
						"Rc": "1.69"
					},
					{
						"Opp": "8.4",
						"Rc": "1.69"
					},
					{
						"Opp": "5.0",
						"Rc": "1.92"
					}
				],
				"Oost": [
					{
						"Opp": "17.3",
						"Rc": "2.14"
					},
					{
						"Opp": "7.8",
						"Rc": "1.69"
					},
					{
						"Opp": "2.7",
						"Rc": "2.14"
					}
				],
				"Zuid": [
					{
						"Opp": "12.6",
						"Rc": "2.14"
					},
					{
						"Opp": "9.4",
						"Rc": "2.14"
					}
				],
				"West": [
					{
						"Opp": "16.2",
						"Rc": "2.14"
					},
					{
						"Opp": "8.5",
						"Rc": "1.92"
					},
					{
						"Opp": "6.3",
						"Rc": "1.69"
					},
					{
						"Opp": "2.7",
						"Rc": "2.14"
					}
				]
			},
			"Gevelpanelen": {},
			"Daken": {
				"Noord": [
					{
						"Opp": "44.7",
						"Rc": "2.00"
					}
				],
				"Oost": [
					{
						"Opp": "45.5",
						"Rc": "2.00"
					},
					{
						"Opp": "8.6",
						"Rc": "2.00"
					}
				],
				"Zuid": [
					{
						"Opp": "45.5",
						"Rc": "2.00"
					},
					{
						"Opp": "10.6",
						"Rc": "2.00"
					}
				],
				"West": [
					{
						"Opp": "8.6",
						"Rc": "2.00"
					}
				]
			},
			"Vloeren": {
				"Algemeen": [
					{
						"Opp": "104.2",
						"Rc": "1.30"
					},
					{
						"Opp": "12.5",
						"Rc": "2.82"
					}
				]
			},
			"Ramen": {
				"Noord": [
					{
						"Opp": "1.3",
						"Uw": "2.90"
					},
					{
						"Opp": "1.2",
						"Uw": "2.90"
					},
					{
						"Opp": "1.2",
						"Uw": "2.90"
					},
					{
						"Opp": "0.8",
						"Uw": "1.80"
					},
					{
						"Opp": "0.6",
						"Uw": "1.40"
					}
				],
				"Oost": [
					{
						"Opp": "2.1",
						"Uw": "1.80"
					}
				],
				"Zuid": [
					{
						"Opp": "2.1",
						"Uw": "1.80"
					},
					{
						"Opp": "2.1",
						"Uw": "1.80"
					},
					{
						"Opp": "1.6",
						"Uw": "1.80"
					},
					{
						"Opp": "1.6",
						"Uw": "1.80"
					},
					{
						"Opp": "0.6",
						"Uw": "1.80"
					}
				],
				"West": [
					{
						"Opp": "1.6",
						"Uw": "1.80"
					},
					{
						"Opp": "1.6",
						"Uw": "1.80"
					},
					{
						"Opp": "1.0",
						"Uw": "5.10"
					},
					{
						"Opp": "0.8",
						"Uw": "1.80"
					},
					{
						"Opp": "0.8",
						"Uw": "1.80"
					}
				]
			},
			"Buitendeuren": {
				"Zuid": [
					{
						"Opp": "1.3",
						"Ud": "3.40"
					}
				],
				"West": [
					{
						"Opp": "0.5",
						"Ud": "3.40"
					}
				]
			}
		}
	}
}

422 Unprocessable Entity

{
	"detail": [
		{
			"type": "missing",
			"loc": [
				"body",
				"file"
			],
			"msg": "Field required",
			"input": null
		}
	]
}

403: Forbidden

{
	"message": "Missing Authentication Token"
}