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

{
	"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

{
  "detail": "Not possible to estimate house hold value: Surface area exceeds 300m²"
}

{
  "detail": "Not possible to estimate house hold value: Income exceeds 4850 euros"
}

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

{
	"message": "Internal server error"
}	

403: Forbidden

{
	"message": "Missing Authentication Token"
}

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": "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"
}