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 | 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 |
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) |
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 |
Request body
Example request
Request query
Example request
Last updated