Authentication, input and response

Request contents valuation for Dutch residential properties

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

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	Postcode of the house
housenumber*	int	House number
houseaddition*	string	House addition
innersurfacearea	int	Inner Surface Area of the property in m².
age_mainbreadwinner	int	Age of the main bread winner of the property.
household_composition	bool	0 for Single; 1 for married or cohabiting
income_mainbreadwinner	int	Net Monthly income of the main breadwinner in euros.
value_audiovisualandPC	int	Value of the audiovisual and computer equipment in euros.
value_jewelery	int	Value of the jewelry in euros.
value_specialpossessions	int	Value of special possessions in euros.
value_tenantinterest	int	Value of tenant interest in euros.

200: OK Successful response

{
	"postcode": "1234AB",
	"housenumber": 1,
	"houseaddition": "A",
	"street": "Street",
	"city": "City",
	"housetype": "Tussenwoning",
	"buildyear": 2009,
	"innersurfacearea": 45.0,
	"monument_status": false,
	"building_function": "woonfunctie",
	"usage_indication": "Er is een gebruiker die geen (mede)eigenaar is.",
	"wall_material": "Steen",
	"wall_material_probability": {
		"Hout": "0.10",
		"Steen": "0.90"
	},
	"floor_material": "Steen/beton",
	"floor_material_probability": {
		"Hout": "0.01",
		"Steen/beton": "0.98",
		"Hout en steen/beton": "0.01",
		"Anders": "0.00"
	},
	"roof_material": "Dakpannen",
	"roof_material_probability": {
		"Dakpannen": "0.70",
		"Bitumen": "0.15",
		"EPDM": "0.12",
		"Kunststof": "0.03"
	},
	"roof_construction_type": "slanted",
	"output_total_household_value": 91834,
	"output_points_total": 73,
	"output_value_of_points": 91834,
	"output_index_value_1258": 1258,
	"output_value_delta": 0
}

400: Bad Request Unsuccessful response

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

403: Forbidden

401: Unauthorized No access

Request body

Example request

{
  "postcode": "1234AB",
  "housenumber": 1,
  "houseaddition": "A",
  "innersurfacearea": "120",
  "age_mainbreadwinner": "40",
  "household_composition": "True",
  "income_mainbreadwinner": "3500",
  "value_audiovisualandPC": "0",
  "value_jewelery": "0",
  "value_specialpossessions": "0",
  "value_tenantinterest": "0"
}