StartPlatformMonitorAltum AIContact

Authentication, input and response

Rental Reference API

POST https://api.altum.ai/rental-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

innersurfacearea

Number

Any number greater than zero

furnished_target

Boolean

1 if the target is furnished

garden_target

Boolean

1 if the target has garden

reference_number

Number

From 10 till 30

date_limit

Number

Between 6 and 60 in months search history of transactions

window_limit

Boolean

1 if you want to get the references only from the target's window

furnished

Boolean

1 if you want the references to have the same furnished with the target (if exists)

garden

Boolean

1 if you want the references to have the same value for garden (has garden or not) with the target (if exists)

weight_innersurfacearea

Float

Takes values between 0 and 1. The weight to the inner surface area for displaying the final references. Default 0.8.

weight_recency

Float

Takes values between 0 and 1. The weight to the recency for displaying the final references. Default 0.5.

weight_distance

Float

Takes values between 0 and 1. The weight to the distance for displaying the final references. Default 0.8.

Request body

Example request

PreviousChangelogNextAPI Key Information

Last updated