De Interactieve Referentie API maakt gebruik van meerdere functies om tot de meest geschikte referente objecten te komen.

Identificatie woning (*) en gewenste output

Zoek op postcode, huisnummer en toevoeging via postcode, housenumber en houseaddition. 

Gewenste output

Geef het aantal gewenste referente objecten op via de functie reference_number.  De waarderingsdatum met transacties aan die datum gaat via de functie valuationdate. Geef aan tot hoeveel maanden terug gezocht mag worden t.o.v. de waarderingsdatum via date_limit. Het is mogelijk, als beschikbaar, het aantal dagen op te vragen dat de woning te koop heeft gestaan via de functie time_for_sale.

Woningdata

Overschrijf de waardes uit de Altum AI-database met eigen invoer voor oppervlakte, energielabel, bouwjaar en woningtype  via innersurfacearea, energylabel, buildyear en housetype.

Strikte zoekfuncties

Een strikte zoekfunctie sluit transacties uit die niet voldoen aan de criteria. Zoek op transacties uit dezelfde straat, wijk of buurt via strict_street, strict_buurt of strict_wijk. Als het energielabel bekend is of meegegeven als input is het mogelijk om te zoeken naar strikt vergelijkbare woningen met hetzelfde energielabel via de functie strict_energylabel.

Gewicht in relevantie

De resultaten van de API kunnen worden gesorteerd aan de hand van gewichten die worden meegegeven aan de zoekopdracht t.a.v. oppervlakte, bouwjaar, transactiedatum, recentheid weegt dan zwaarder en afstand. Dit kan met de functies weight_innersurfacearea, weight_buildyear, weight_transactiondate en weight_distance.

Vergelijkbaarheid

Met de vergelijkbaarheidsfuncties is het mogelijk de mate van vergelijkbaarheid te definiëren t.a.v. de woning en in hoeverre transacties moeten worden uitgesloten. Vergelijkbaarheid aangeven kan voor woningtype, oppervlakte, bouwjaar en afstand via comparable_housetype, comparable_innersurfacearea, comparable_buildyear en comparable_distance.

* Vereist