🇬🇧
Altum AI
StartPlatformMonitorAltum AIContact
English
English
  • Altum AI API documentation
  • Platform
    • Monthly subscriptions
    • Yearly subscriptions
    • Unlimited usage subscriptions
    • Kadaster Transaction API subscription
    • Changelog
  • Updates
  • Developers
    • Perform your first API call
    • Credit API
    • Sandbox
    • OpenAPI specifications
    • GET API status
  • Altum AI website
  • Pricing
  • Property AI
    • Authentication, Input, and Response
    • Output Interpretation
    • FAQs
  • API's
    • AVM API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Accuracy Indicator
      • House numbers & additions
      • House types
      • Variables
      • Output interpretation
      • Frequently Asked Questions (FAQ)
    • AVM+ API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Energylabel and Inner and Outer Surface Area
      • Output interpretation
    • Listing Price API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Inner and Outer Surface Area
      • Output interpretation
    • Sustainability API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Energylabel
      • Improving the advice
      • Example API calls
      • Output interpretation
      • Increasing energy costs
      • Exclude measures
      • Search criteria
      • Measures
      • Insulation values
      • Comfort score
      • CO2
      • Coverage
      • Cost table input
      • Frequently Asked Questions (FAQ)
    • NTA 8800 Energylabel API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • EPC API
      • Changelog
      • API Key Information
      • Authentication, input and response
      • Output Interpretation
    • Energylabel insights API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WOZ API
      • Changelog
      • Frequently Asked Questions (FAQ)
      • Authentication, input and response
      • API Key Information
      • Output interpretation
      • PC6 average WOZ value
    • Interactive Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Visual similarity search
      • House types
      • Comparable functions
      • Output interpretation
    • Kadaster Transaction API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Housing features API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Contents Value API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Building geometry API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Energy & climate API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Condition score API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Photo Labelling API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Autosearch API
      • Authentication, input and response
      • API Key Information
    • Autosuggest API
      • Authentication, input and response
      • API Key Information
      • Fuzzy Search Support
      • Output interpretation
    • Move data API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Location Data API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House types
      • Output interpretation
    • Rental Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Rebuild Value API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Solar panel roof scan API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WWS Points API
      • Authentication, input and response
      • API Key Information
      • Specifications for independent home version 01-01-2024
      • Specifications for non-independent home version 01-01-2024
      • Specifications for independent home version 01-07-2024
      • Specifications for non-independent home version 01-07-2024
      • Input explanation for version 01-07-2024
      • Output interpretation
  • API error codes
    • 429
    • 422
    • 403
Powered by GitBook
On this page
  • “Target Object”
  • “Reference Data”
  • “Reference Houses”
  1. API's
  2. Rental Reference API

Output interpretation

An explanation and interpretation of every feature outputted in the API response.

Reference houses of the output, are shown from the most close to the least close.

“Target Object”

The main data of the given house by the user.

Feature
Example
Explanation

postcode

2771DS

Zipcode

housenumber

87

House number

houseaddition

A

Addition to house number including house letter

longitude

4.958819318919722

The longitude of the house

latitude

52.52627249026349

The latitude of the house

street

Tureluurhof

Street name

city

Amsterdam

City name

inner_surface_area

136

The square meters of the house

furnished

1

If the house is furnished or not.

garden

1

If the house has garden or not.

“Reference Data”

The info about the distribution of the found reference data. All the found reference objects are divided into ranges based on their square meters.

Feature
Example
Explanation

market_rent

1609

The final market rent based on our calculations

number_of_references

30

The number of reference objects found

rent_distribution

list of dictionaries

Distributes the found reference houses into inner surface area ranges.

"rent_distribution"

Subfeature
Example
Explanation

min_sqm

35

The minimum range of the square meters for this range. Possible values: [0, 35, 45, 55, 65, 75, 85, 95, 105, 115, 125, 200].

max_sqm

45

The maximum range of the square meters for this range. Possible values: [35, 45, 55, 65, 75, 85, 95, 105, 115, 125, 200, inf].

sample_count

5

How many reference objects found in this range

rent_total

4112

The sum of the indexed rent of the houses on this range

innersurfacearea_total

215

The sum of the square meters of the houses on this range

rent_innersurfacearea

19.1

The division between rent_total and innersurfacearea_total

avg_rent

822

The average rent of the houses at this range

“Reference Houses”

All the data regarding the reference houses they are found.

Feature
Example
Explanation

postcode

2771DS

Zipcode

housenumber

87

House number

houseaddition

A

Addition to house number including house letter

street

Burgemeester D. Kooimanweg

Street name

city

Purmerend

City name

housetype

appartement

House type

buildyear

1975

Construction year

innersurfacearea

136

Inner square meters of object

price_per_sqm2

10.66

rental_price_indexed / innersurfacearea

energylabel

A

Energy label

rental_price

1450

The rental price

rental_price_indexed

1750

The indexed rental price

bedrooms

1

Number of bedrooms

furnishment

0

If it's furnished or not.

garden

1

If it has garden or not.

collection_date

2022-12

the collection date of the reference object

distance

338

The distance in meters of the reference house from the target

weight

1

The weight (how similar the reference house is) of the reference house in comparison to the target

PreviousAPI Key InformationNextRebuild Value API

Last updated 11 months ago