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/listingprice

This endpoint allows you to receive response from the Altum AI Listing Price 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
innersurfacearea	number	Square meter (m2) inner surface area
outersurfacearea	number	Square meter (m2) outer surface area

401: Unauthorized No access

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

403: Forbidden Forbidden

429: Too Many Requests API key limit exceeded

500: Internal Server Error Service is not available and/or down

422: Unprocessable Entity Wrong input format

200: OK Successful response

400: Bad Request Unsuccessful response

Request body

Example request

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