Authentication, input and response

Fetch rebuild data on an object

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

Headers

Name	Type	Description
x-api-key*	string	Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)
Content-Type*	string	application/json

Request Body

Name	Type	Description
postcode*	string	Zipcode of the object
valuationdate	string	Valuation date (default is date of entry)
houseaddition	string	House letter and addition of the object
housenumber*	number	House number of the object
new_amenity	integer	1 = include correction for new amenities insurance (bathroom, kitchen and/or living room)

200: OK Standard response

{
	"Output": {
		"num_id": "0499200002030602",
		"bag_id": "0499010002023718",
		"pand_id": "0499100002015826",
		"postcode": "2771DS",
		"housenumber": "87",
		"houseaddition": "",
		"region": "Oost-Zuid-Holland",
		"city": "Boskoop",
		"street": "Zuidkade",
		"build_year": "1961",
		"inner_surface_area": "131",
		"outer_surface_area": "1605",
		"volume": "547",
		"house_type_generic": "Vrijstaande woning",
		"house_type": "Vrijstaand",
		"energy_label": "C",
		"energy_calculation_method": "RDEL_2014_1",
		"energy_calculation_code": "NEN7120",
		"monument_status": "Geen monument / Onbekend",
		"usage_indication": "Er is een gebruiker die tevens (mede)eigenaar is.",
		"building_status": "Pand in gebruik",
		"building_function": "woonfunctie",
		"rebuild_value": "558412",
		"corrections": null,
		"total_correction": null,
		"woz_value": "633822",
		"parcel_value": "62595",
		"building_value": "571227",
		"number_of_rooms": null,
		"number_of_building_layers": "2",
		"number_of_extrabuildings": null,
		"main_building_surface_area": null,
		"extrabuildings_surface_area": null,
		"listing_status": null,
		"asking_price": null,
		"asking_price_date": null,
		"last_sold_date": null,
		"roof_type": "slanted",
		"roof_construction": null,
		"roof_surfaces": [
			{
				"orientation": "WN",
				"area": "19.832505836178303",
				"perimeter": "20.4330747637086",
				"angle": "24.8"
			},
			{
				"orientation": "WN",
				"area": "12.652916942719283",
				"perimeter": "25.810687359706225",
				"angle": "23.7"
			},
			{
				"orientation": "SW",
				"area": "5.255787722065841",
				"perimeter": "13.98183934283994",
				"angle": "39.1"
			},
			{
				"orientation": "ES",
				"area": "71.68768159329929",
				"perimeter": "40.00529312464371",
				"angle": "22.9"
			}
		]
	}
}

400: Bad Request Unsuccessful response

{
	"Output": "The given house address was not found in database."
}

422: Unprocessable Entity Wrong input format

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

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

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Forbidden"
}

401: Unauthorized No access

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

Request body

Example request

{
   "postcode" : "2771DS",
   "housenumber" : "87",
   "houseaddition":""
}