Authenticatie, invoer en resultaat

Verouderd

Deze API is verouderd en wordt niet langer aanbevolen voor nieuwe implementaties. Bestaande integraties blijven mogelijk werken. Neem contact op met Altum AI voor advies over de aanbevolen configuratie.

Plaats objectgegevens om een nauwkeurige geautomatiseerde modelwaardering te ontvangen

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

Met dit eindpunt kunt u antwoord ontvangen van het Altum AI Woningwaarde+ model.

Headers

Name

Type

Description

Content-Type

string

application/json

x-api-key*

string

Unieke API-sleutel van Altum. Maak er een aan via het Mopsus(https://mopsus.altum.ai)

Request Body

Name

Type

Description

postcode*

string

Postcode van het object

valuation_date

string

Waarderingsgegevens voor prijsschatting. Standaard = vandaag

houseaddition

string

Huisnummerletters en/of toevoeging

housenumber*

number

Huisnummer

energylabel

string

Energielabel A++++ t/m G

innersurfacearea

number

Vierkante meter (m2) binnenoppervlakte

outersurfacearea

number

Vierkante meter (m2) buitenoppervlakte

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

{
  "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

Voorbeeld verzoek

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

PreviousChangelog NextAPI-sleutel Informatie

Last updated 4 days ago