Authenticatie, invoer en resultaat

Plaats objectgegevens om een nauwkeurige geautomatiseerde modelwaardering te ontvangen.

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

Met dit eindpunt kunt u antwoord ontvangen van het Altum AI AVM-model.

Headers

Name	Type	Description
Content-Type*	string	application/json
x-api-key*	string	Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
postcode*	string	Postcode van het object
image	boolean	Afbeelding van object ophalen, 0 of 1
buildyear	integer	Jaar van constructie
innersurfacearea	integer	Vierkante meter (m2) binnenoppervlakte
outersurfacecarea	integer	Vierkante meter (m2) buitenoppervlakte
energylabel	string	Energielabel A t/m G
housetype	string	Woningtype van het object
valuationdate	string	Waarderingsdatum (standaard is datum van boeking)
houseaddition	string	Huisbrieven en/of toevoegingen
housenumber*	number	Huisnummer

200: OK Succesvolle reactie

{
    "Output": {
        "BagID": "0637010021364937",
        "PostCode": "1234AB",
        "HouseNumber": "1",
        "HouseAddition": null,
        "City": "Woonplaats",
        "Street": "Straatnaam",
        "HouseType": "Tussenwoning",
        "BuildYear": "2001",
        "InnerSurfaceArea": "121",
        "OuterSurfaceArea": "136",
        "Volume": "429",
        "EnergyLabel": null,
        "Longitude": "4.524624609",
        "Latitude": "52.070925901563704",
        "Rooms": null,
        "Image": null,
        "ValuationDate": "20200326",
        "PriceEstimation": "355012",
        "Confidence": "90% Confidence Interval is 327363-429880."
    }
}

400: Bad Request Mislukte reactie

{
  "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': 'The given house type is unsupported or unknown.'
}

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

401: Unauthorized Geen toegang

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

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

422: Unprocessable Entity Verkeerd invoerformaat

{
  "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}$"
      }
    }
  ]
}

429: Too Many Requests API-sleutellimiet overschreden

Request body

Voorbeeld verzoek

{
   "postcode" : "1234AB",
   "housenumber" : "5",
   "houseaddition" : "",
   "valuationdate" : "20200326",
   "image": 1,
   "buildyear": 2000,
   "innersurfacearea": 150,
   "outersurfacearea": 100,
   "energylabel": "B",
   "housetype": "Vrijstaande woning"
}

Up next:

Parameters