🇬🇧
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
  1. API's
  2. Interactive Reference API

Changelog

A description of the changes per deployed version.

1.07 - 30-04-2025

  • Added a new binary input: include_listings.

  • Added Source as an output in the references output to show from which source the reference was retrieved.

1.06 - 23-12-2024

  • Added two new accepted housetypes, Eengezinswoning & Meergezinswoning.

  • The input houseaddition accepts both capital and low letters.

1.05 - 17-10-2024

  • Fixed bug regarding outersurfacearea and volume values being 0, 1 or very high.

1.04 - 26-7-2022

  • Removed the time_for_sale from input and output.

  • When one or more of the strict_street, strict_buurt, strict_wijk, or strict_energylabel inputs are enabled, then we ignore the guarantee of the 3 reference objects, and we return what's found.

1.03 - 6-6-2022

  • When the “strict_street” input is 1, then we search for the same street and the same city.

  • Fixed some Elasticsearch queries.

1.02 - 18-10-2022

  • Add “housetype_to_search” as a list input, which defines for which house types the algorithm will search for ref. objects. The possible inputs are: ['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']. If this input is provided, then in the ComparableHouseType output we 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 3 ref. objects, then this input is ignored and the "comparable_housetype" goes to 0.

  • Added new possible "housetype" inputs. The acceptable inputs are the same as above.

  • Change the default search weights. Inner: 0.2, Buildyear: 0.9, Transactiondate: 0.2, Distance: 0.5.

  • If the user does not give an acceptable "valuationdate" as input, we provide a 422 error instead of 400.

  • If the user does not give an acceptable "housetype_to_search" as input, we provide a 422 error.

  • Enhanced the house-type matching for the comparable searches

  • Add a new possible input (3) to "comparable_innersurfacearea" and to "comparable_buildyear”, where the algorithm searches in 30% deviation and in 30 years window respectively.

1.01 - 2-6-2022

  • Added date_limit as input, which defines how many months back the user is able to search for reference houses (min:6, max:60). Default = 60

  • Guarantee a minimum of three reference objects as output by overriding user's input with defaults based on the following order of priority until a minimum of three reference objects are found:

    • Boolean (strict) inputs

      • energylabel = 0

      • wijk = 0

      • buurt = 0

      • street = 0

    • Restriction of date_limit = 60

    • Comparables inputs

      • Comparable distance = 0

      • Inner surface area = 0

      • Build year = 0

      • House type = 0

  • Added adjusted inputs (9) as output to the API to match the used inputs versus the one provided to see which of these have been used to guarantee the minimum of three reference objects as output

PreviousInteractive Reference APINextAuthentication, input and response

Last updated 1 month ago