Interactive Reference API
The interactive reference API gives the appraiser full flexibility on finding the right reference objects based on multiple variables, comparables and strict functions.
Interactieve woning referentie API voor het opvragen van 30 relevante transacties t.o.v. het doelobject
post
https://api.altum.ai
/interactive-reference
Interactive Reference API
This API replaced the former Reference API per the 1st of September 2022
Possible inputs for both the feature housetype for the target object as well as housetype_to_search for the housetypes to be included in the search:
'Vrijstaande woning', 'Vrijstaande doelgroepwoning', 'Vrijstaande recreatiewoning', '2 onder 1 kap woning', 'Geschakelde 2 onder 1 kapwoning', 'Geschakelde woning', 'Tussen/rijwoning', 'Tussen/rij doelgroepwoning', 'Hoekwoning', 'Eindwoning', 'Galerijflat', 'Portiekflat', 'Corridorflat', 'Maisonnette', 'Benedenwoning', 'Bovenwoning', 'Portiekwoning'
['Tussen/rijwoning', 'Meergezinswoning', '2 onder 1 kap woning', 'Vrijstaande woning', 'Hoekwoning', 'Bovenwoning', 'Portiekwoning', 'Geschakelde woning', 'Benedenwoning', 'Bedrijf', 'Eengezinswoning', 'Garage(box)', 'Meergezins doelgroepwoning', 'Eindwoning', 'Detail/groothandel', 'Maisonnette', 'Galerijflat', 'Object in aanbouw', 'Kantoor', 'Vrijstaande recreatiewoning', 'Agrarisch met woongedeelte', 'Corridorflat', 'Tussen/rij doelgroepwoning', 'Horeca', 'Sport en recreatie', 'Bijzondere woonfunctie', 'Hoek doelgroepwoning', 'Energie en water', 'Bijzondere woonfunctie met woongedeelte', 'Agrarisch', 'Onderwijs', 'Detail/groothandel met woongedeelte', 'Transport', 'Bedrijf met woongedeelte', 'Laboratoria en praktijk', 'Bovenwoning doelgroep', 'Geschakelde 2 onder 1 kapwoning', 'Doelgroepwoning', 'Horeca met woongedeelte', 'Gemeenschapsgebouw overig', 'Woning', 'Medisch met woongedeelte', 'Niet-woning', '2 onder 1 kap doelgroepwoning', 'Medisch', 'Sport en recreatie met woongedeelte', 'Religie', 'Portiekflat', 'Recreatiewoningen', 'Benedenwoning doelgroep', '2 onder 1 kap recreatiewoning', 'Tussen/rij recreatiewoning', 'Cultuur', 'Specifiek woonobject', 'Nog te bepalen', 'Kantoor met woongedeelte', 'Geschakelde recreatiewoning', 'Vrijstaande doelgroepwoning', 'Communicatie', 'Portiekwoning doelgroep', 'Eind doelgroepwoning', 'Woonwagen/-boot recreatief', 'Woonwagen/-boot', 'Hoek recreatiewoning', 'Nutsvoorziening', 'Laboratoria en praktijk met woongedeelte', 'Geschakelde doelgroepwoning', 'Galerijflat doelgroep', 'Gemeenschappelijke voorziening', 'Woonwagen/stacaravan', 'Overig woonobject', 'Maisonnette doelgroep', 'Detailhandel/Horeca/Kantoor', 'Eind recreatiewoning', '3310', 'Defensie', 'Energie en water met woongedeelte', 'Onderwijs met woongedeelte', 'Cultuur met woongedeelte', 'Niet-woning met woongedeelte', 'Portiekflat doelgroep', 'Woonwagen/stacaravan recreatief', 'Woonboot', 'Transport met woongedeelte', 'Geschakelde 2 onder 1 kap doelgroepwoning', 'Detailhandel/Horeca/Kantoren met woongedeelte', 'Gemeenschapsgebouw overig met woongedeelte', 'Religie met woongedeelte', 'Standplaats', '1000', 'Cultuur en religie', 'Corridorflat doelgroep', 'Ligplaats', 'Communicatie met woongedeelte', 'Defensie met woongedeelte']
When the function housetype_to_search is provided, then in the ComparableHouseType output will display the given inputs by the user (as a list) and not 0, 1 or 2. If the algorithm is not able to find at least three reference objects, then this input is ignored and the "comparable_housetype" goes to 0 in the search.
- 0 = all possible matches
- 1 = comparable
- 2 = comparable + better and lesser
- 3 = maximum filter
Matrix house-type single-family home | Vrijstaande woning | Vrijstaande doelgroepwoning | 2-onder-1-kapwoning | Geschakelde 2-onder-1-kapwoning | Geschakelde woning | Tussenwoning | Hoekwoning | Eindwoning | Eengezinswoning |
|---|---|---|---|---|---|---|---|---|---|
Vrijstaande woning | Comparable | Comparable | Better | Better | Much better | Much better | Much | Much better | Much better |
2-onder-1-kapwoning | Lesser | Lesser | Comparable | Comparable | Better | Better | Better | Better | Much better |
Geschakelde 2-onder-1-kapwoning | Lesser | Lesser | Comparable | Comparable | Better | Better | Better | Better | Better |
Geschakelde woning | Much less | Much less | Lesser | Lesser | Comparable | Comparable | Comparable | Comparable | Better |
Halfvrijstaande woning | Lesser | Lesser | Comparable | Comparable | Comparable | Better | Better | Better | Better |
Tussenwoning | Much less | Much less | Much less | Lesser | Lesser | Comparable | Lesser | Comparable | Comparable |
Hoekwoning | Much less | Much less | Lesser | Lesser | Lesser | Better | Comparable | Comparable | Better |
Eindwoning | Much less | Much less | Lesser | Lesser | Lesser | Comparable | Comparable | Comparable | Comparable |
Matrix house-type apartments | Galerijflat | Portiekflat | Corridorflat | Maisonnette | Benedenwoning | Bovenwoning | Portiekwoning | Meergezinswoning |
|---|---|---|---|---|---|---|---|---|
Galerijflat | Comparable | Comparable | Comparable | Lesser | Lesser | Comparable | Lesser | Comparable |
Portiekflat | Comparable | Comparable | Comparable | Lesser | Lesser | Comparable | Lesser | Comparable |
Corridorflat | Comparable | Comparable | Comparable | Lesser | Lesser | Comparable | Lesser | Comparable |
Maisonnette | Better | Better | Better | Comparable | Comparable | Lesser | Comparable | Better |
Benedenwoning | Better | Better | Better | Comparable | Comparable | Comparable | Comparable | Comparable |
Bovenwoning | Comparable | Comparable | Comparable | Better | Comparable | Comparable | Comparable | Comparable |
Portiekwoning | Better | Better | Better | Comparable | Comparable | Comparable | Comparable | Comparable |
For inner surface area the comparable function works as follows:
- 0 = all possible matches
- 1 = comparable between <10% and >10% surface area difference
- 2 = comparable between <20% and >20% surface area difference
- 3 = comparable between <30% and >30% surface area difference
For buildyear:
- 0 = all build years
- 1 = comparable between <10 and >10 buildyear difference
- 2 = comparable between <20 and >20 buildyear difference
- 3 = comparable between <30 and >30 buildyear difference
Comparable distance
For distance to target object
- 0: search within the entirety of The Netherlands
- 1: search within a maximum radius of 1 kilometers
- 2: search within a maximum radius of 5 kilometers
In order to give preference to more recent transacted properties it is possible to add the optional input "date_limit" to search from 6 up to 60 months in the database for finding reference objects.
Last modified 5mo ago