Authentication, input and response

WOZ API methods

• POST to receive WOZ value for a single address

• GET WOZ value for a BAG ID

Post object data to receive WOZ values

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

This endpoint allows you to get the latest WOZ values from our database. A POST request requires a body parameter(Address).

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	Zipcode of the object
housenumber*	string	House number of the object
addition	string	House number addition
index	boolean	Use 1 to add an "IndexedValue" to the latest available WOZ value indexed with the Kadaster index to the current month. Default = 0
cache	boolean	Use 0 to override fetching from cache and perform a live request. Default = 1

401: Unauthorized No access

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

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

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

{
	"message": "Internal server error"
}

200: OK Successful response

{
	"Output": {
		"BagID": "499010002023718",
		"PostCode": "2771DS",
		"HouseNumber": "87",
		"HouseAddition": null,
		"HouseAddress": "2771DS-87-",
		"City": "Boskoop",
		"Street": "Zuidkade",
		"HouseType": "woonfunctie",
		"BuildYear": 1961,
		"OuterSurfaceArea": 1605,
		"Longitude": 4.65808526945334,
		"Latitude": 52.068393816655316,
		"WOZ-source_date": "2023-03-21",
		"wozvalue": [
			{
				"Date": "01-01-2022",
				"Value": "630000",
				"IndexedValue": "644942"
			},
			{
				"Date": "01-01-2021",
				"Value": "551000"
			},
			{
				"Date": "01-01-2020",
				"Value": "518000"
			},
			{
				"Date": "01-01-2019",
				"Value": "498000"
			},
			{
				"Date": "01-01-2018",
				"Value": "490000"
			},
			{
				"Date": "01-01-2017",
				"Value": "469000"
			},
			{
				"Date": "01-01-2016",
				"Value": "430000"
			}
		]
	}
}

400: Bad Request Unsuccessful response

{
  "detail": {
    "Output": "The combination of postcode, house number and house addition  does not exist or have no WOZ."
  }
}

422: Unprocessable Entity Wrong input format

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "Unsupported postcode length, it should be six.",
      "type": "value_error"
    }
  ]
}

429: Too Many Requests Limit exceeded

API key limit exceeded

GET WOZ Values with BAGID request

GET https://api.altum.ai/woz?bag_id={bag_id}

This endpoint responds with the latest WOZ values from our database. The GET Method requires a query parameter(bag_id) with the value being the actual 16-character BAGID.

Query Parameters

Name	Type	Description
bag_id*	string	16 digits BAG ID "0402010001567022"

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

200: OK Successful response

{
  "Output": {
    "BagID": "0622010000065935",
    "PostCode": "3136KZ",
    "HouseNumber": "832",
    "HouseAddition": null,
    "HouseAddress": "3136KZ-832-",
    "City": "Vlaardingen",
    "Street": "Aalscholverlaan",
    "HouseType": "woonfunctie",
    "BuildYear": 1969,
    "OuterSurfaceArea": 1412,
    "Longitude": 4.350730676835097,
    "Latitude": 51.93255387951979,
    "WOZ-source_date": "2020-12-22",
    "wozvalue": [
      {
        "Date": "01-01-2019",
        "Value": 157000
      },
      {
        "Date": "01-01-2018",
        "Value": 133000
      },
      {
        "Date": "01-01-2017",
        "Value": 122000
      },
      {
        "Date": "01-01-2016",
        "Value": 122000
      },
      {
        "Date": "01-01-2015",
        "Value": 122000
      },
      {
        "Date": "01-01-2014",
        "Value": 132000
      }
    ]
  }
}

400: Bad Request Unsuccessful response

{
	"detail": [
		{
			"loc": [
				"query",
				"bag_id"
			],
			"msg": "ensure this value has at least 16 characters",
			"type": "value_error.any_str.min_length",
			"ctx": {
				"limit_value": 16
			}
		}
	]
}

401: Unauthorized No access

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

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

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

{
	"message": "Internal server error"
}

422: Unprocessable Entity Wrong input format

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "Unsupported postcode length, it should be six.",
      "type": "value_error"
    }
  ]
}

429: Too Many Requests Limit exceeded

API key limit exceeded

For POST requests: set cache to 0 to fetch fresh, real-time values instead from cache as source. Note: this might impact load time.

FREE Ping for availability

Post object data to receive availability of WOZ values

POST https://api.altum.ai/woz/ping

This endpoint allows you to get the availability of the latest WOZ values from our database. A POST request requires a body parameter (Address).

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
postcode*	string	Zipcode of the object
housenumber*	string	House number of the object
addition	string	House number addition
index	boolean	Use 1 to add an "IndexedValue" to the latest available WOZ value indexed with the Kadaster index to the current month. Default = 0
cache	boolean	Use 0 to override fetching from cache and perform a live request. Default = 1

401: Unauthorized No access

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

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

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

{
	"message": "Internal server error"
}

200: OK Successful response

{ 
        "Output": "WOZ data for 1616EG-130- is available.", 
        "Latest Date": "01-01-2021" 
} 

422: Unprocessable Entity Wrong input format

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "Unsupported postcode length, it should be six.",
      "type": "value_error"
    }
  ]
}

Request body

Example request

{
  "postcode": "2771DS",
  "housenumber": "87",
  "addition": "",
  "index": 1,
  "cache": 0
}

Request query

Example request

https://api.altum.ai/woz?bag_id=0402010001567022