Authentication, input and response

Authentication

post
https://api.altum.ai
/avm
Post object data to receive an accurate automated model valuation
Key: distributed via e-mail Method: POST

Request body

Example request

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

Possible input parameters

input
parameters
postcode
string in format 1234AB, from 1011AA - to 9999ZZ
housenumber
number or string in format 1, greater than 0
houseaddition
character I or 1 as example
valuationdate
YYYYMMDD
image
boolean 0-1
buildyear
integer, >1800 and <= current year
innersurfacearea
integer, >0
outersurfacearea
integer, >0
energylabel
string in format A, B, C, D, E, F or G
housetype
'Vrijstaande woning', '2 onder 1 kap woning', 'Geschakelde 2 onder 1 kapwoning', 'Geschakelde woning', 'Tussen/rijwoning', 'Hoekwoning', 'Eindwoning', 'Eengezinswoning', 'Galerijflat', 'Portiekflat', 'Corridorflat', 'Maisonnette', 'Benedenwoning', 'Bovenwoning', 'Portiekwoning', 'Meergezinswoning'
House-types
Possible house-types output: 'Vrijstaande woning', '2 onder 1 kap woning', 'Geschakelde 2 onder 1 kapwoning', 'Geschakelde woning', 'Tussen/rijwoning', 'Hoekwoning', 'Eindwoning', 'Eengezinswoning', 'Galerijflat', 'Portiekflat', 'Corridorflat', 'Maisonnette', 'Benedenwoning', 'Bovenwoning', 'Portiekwoning', 'Meergezinswoning'

Schema's

input
input requirement
postcode
string maxLength: 6
housenumber
number or string minLength: 1
houseaddition
string minLength: 1
valuationdate
string YYYYMMDD default: date of entry
image
boolean

Response body

Responses

Code 200 Successful Response Code 422 Validation Error

Example output

output
value
BagID
363010012117719
PostCode
1033DC
HouseNumber
179
HouseAddition
2A
BuildYear
2010
Street
Kalverstraat
City
Amsterdam
PriceEstimation
200000
ValuationDate
20200331
Confidence
90% Confidence Interval is 385292-515770.
HouseType
Vrijstaand
InnerSurfaceArea
150
OuterSurfaceArea
300
Volume
450
Latitude
4.89983966925117
Longitude
52.4076251827339
EnergyLabel
A
Rooms
4
AccuracyIndicator
31

Example response

code 200 OK response:
Also see 'Post object data to receive an accurate automated model valuation' at the top of this page for the code of a 'code 200 OK response'.
Output
Description
"BagID": "637010000264937"
identifier from the Kadaster
"PostCode": "2728KH"
zip code of the object
"HouseNumber": "5"
house number of the object
"HouseAddition": ""
house number addition of the object
"Street": "Bellefleurhof"
street name of the object
"City": "Zoetermeer"
street name of the object
"HouseType": "tussenwoning"
house type
"InnerSurfaceArea": "151"
inner surface area in square meters
"OuterSurfaceArea": "136"
outer surface area in square meters
"Volume": "429"
volume of the object in cubic meters
"Latitude": "52.0709259015637"
latitude coordinate
"Longitude": "4.52462460943961"
longitude coordinate
"EnergyLabel": "A"
current energy label
"ValuationDate": "20191215"
valuation date
"PriceEstimation": "348500"
estimate from automated valuation model
"AccuracyIndicator": 1
indicator of the Accuracy of the prediction
"Confidence": "90% Confidence Interval is 385292-515770.""
90% confidence interval in regards to price estimation
"Rooms": "5"
number of rooms of the object
"Image" : "https://avm-api-images...",
image of object
code 422 Validation Error response:
{
"errors": {
"postcode": "PostCode cannot be blank. Missing required parameter in the JSON body"
},
"message": "Input payload validation failed"
}

HTTP responses

Code
Description
Error
200
OK
N/A
400
Bad Request
The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist.
403
Forbidden
Forbidden
422
Validation Error
Unprocessable Entity: one or more of the inputs are not according to the schema
429
Limit exceeded
API key limit exceeded
500
Service Not Available
Service is not available and/or down

Up next: