Authentication, input and response

Post object data to receive an accurate automated model valuation

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

This endpoint allows you to receive response from the Altum AI AVM model.

Headers

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

Request Body

Name	Type	Description
housetype	string	House type of the object
valuationdate	string	Valuation date (default is date of entry)
houseaddition	string	House letters and/or addition
housenumber*	number	House number
postcode*	string	Zipcode of the object
image	boolean	Fetching image of object, 0 or 1
buildyear	integer	Year of construction
innersurfacearea	integer	Square meter (m2) inner surface area
outersurfacecarea	integer	Square meter (m2) outer surface area
energylabel	string	Energy label A till G

401: Unauthorized No access

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

403: Forbidden Forbidden

429: Too Many Requests API key limit exceeded

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

200: OK Successful response

400: Bad Request Unsuccessful response

422: Unprocessable Entity Wrong input format

Key: distributed via e-mail

Request body

Example request

{
   "postcode" : "1234AB",
   "housenumber" : "5",
   "houseaddition" : "",
   "valuationdate" : "20200326",
   "image": 1,
   "buildyear": 2000,
   "innersurfacearea": 150,
   "outersurfacearea": 100,
   "energylabel": "B",
   "housetype": "Vrijstaande woning"
}

Up next:

Variables