🇬🇧
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
  • Post object data to receive an accurate automated model valuation
  • Request body
  1. API's
  2. AVM+ API

Authentication, input and response

Details on input output and authentication requirements

Post object data to receive an accurate automated model valuation

POST https://api.altum.ai/avmplus

This endpoint allows you to receive response from the Altum AI AVM+ model.

Headers

Name
Type
Description

Content-Type

string

application/json

x-api-key*

string

Unique API key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Request Body

Name
Type
Description

postcode*

string

Postcode of the object

valuation_date

string

Valuation date (default is date of entry)

houseaddition

string

House number letters and/or addition

housenumber*

number

House number

energylabel

string

Energy label A++++ till G

innersurfacearea

number

Square meter (m2) inner surface area

outersurfacearea

number

Square meter (m2) outer surface area

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}
{
	"message": "Missing Authentication Token"
}

{
	"message": "Internal server error"
}
{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}
{
	"bagid": "0363010000735772",
	"postcode": "1024CT",
	"housenumber": "25",
	"houseaddition": "",
	"city": "Amsterdam",
	"street": "Markengouw",
	"housetype": "Portiekwoning",
	"buildyear": "1967",
	"innersurfacearea": "76",
	"outersurfacearea": "3299",
	"volume": "2211",
	"energylabel": "D",
	"longitude": "4.96144831561363",
	"latitude": "52.39109040866619",
	"valuationdate": "20231120",
	"priceestimation": "278082",
	"confidence": "90% Confidence Interval is 250273-305890."
}
{
  "Output": "The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist."
}

{
  'Unsupported evaluation date format, it should be YYYYMMDD.'
}

{
  'The evaluation date range should be from {} and until {}.'
}

{
  'Output': 'We are not able to provide prediction at the moment.'
}

{
  'Output': 'The prediction is too low.'
}

Request body

Example request

{
  "postcode": "1024CT",
  "housenumber": 25,
  "houseaddition": "",
  "valuation_date": "20230112"
}
PreviousChangelogNextAPI Key Information

Last updated 5 months ago