StartPlatformMonitorAltum AIContact

Authentication, input and response

Interactive Reference API

POST https://api.altum.ai/interactive-reference

Post the address and optional parameters

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

1234AB

housenumber*

Number

1

houseaddition

String

A

valuationdate

String

Enter as YYYYMMDD, default is TODAY. Ex: 20211230

innersurfacearea

Number

160

buildyear

Number

2001

housetype

String

See page

energylabel

String

A

url

String

The facade url image of the target house

reference_number

Number

Minimum 3 till 30

strict_street

Boolean

Strict search on street level

strict_buurt

Boolean

Strict search on buurt level

strict_wijk

Boolean

Strict search on wijk level

strict_energylabel

Boolean

Strict search for similar houses with this energy label

comparable_housetype

Number

0,1,2. Default: 0

comparable_innersurfacearea

Number

0,1,2,3. Default: 0

comparable_buildyear

Number

0,1,2,3. Default: 0

comparable_distance

Number

0,1,2. Default: 0

weight_innersurfacearea

Number

Between 0 and 1. Default: 0.2

weight_buildyear

Number

Between 0 and 1. Default: 0.9

weight_transactiondate

Number

Between 0 and 1. Default: 0.2

weight_distance

Number

Between 0 and 1. Default: 0.5

weight_visualsimilarity

Number

Between 0 and 1. Default: 0.5

visual_similarity

Boolean

0: if interested for visual similarity 1: if not interested for visual similarity

date_limit

Number

Between 6 and 60 in months search history of transactions. Default: 60.

housetype_to_search

List

Function to only search for given house types, see page.

include_listings

Boolean

0: if only Kadaster references preferred 1: if both listing and Kadaster references preferred

Request body

Example request

PreviousChangelogNextAPI Key Information

Last updated