Authentication, input and response

Transaction API

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

This endpoint allows you to retrieve Kadaster transaction data for an object.

Headers

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

Request Body

Name	Type	Description
postcode*	string	Zipcode of the object
valuationdate	number	Enter as YYYYMMDD, gives newest transaction till that date. Default is TODAY
houseaddition	string	House letter and addition of the object
housenumber*	number	House number of the object

400: Bad Request Unsuccessful response

{
  "Output": "The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist."
}

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				43
			],
			"msg": "Expecting value: line 3 column 18 (char 43)",
			"type": "value_error.jsondecode",
			"ctx": {
				"msg": "Expecting value",
				"doc": "{\n  \"postcode\": \"2201PZ\",\n  \"housenumber\": a,\n  \"valuationdate\": \"20121001\"\n}",
				"pos": 43,
				"lineno": 3,
				"colno": 18
			}
		}
	]
}

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": [
    {
      "Transaction": "Transaction-20100315",
      "BagID": null,
      "PostCode": "2771HM",
      "HouseNumber": 173,
      "HouseAddition": null,
      "City": "BOSKOOP",
      "Street": "PARKLAAN",
      "HouseType": "T",
      "BuildingCode": 11,
      "OuterSurfaceArea": 315,
      "MoreRealEstate": "J",
      "RentedOut": "J",
      "BusinessRight": "VE",
      "MutationVariety": 606,
      "FamilyTransaction": "N",
      "TransactionDate": 20191001,
      "TransactionPrice": 500000,
      "TransactionPriceIndexed": 600000
    }
  ]
}

FREE Ping for availability

Post object data to receive availability of transaction data

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

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

Headers

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

Request Body

Name	Type	Description
postcode*	string	Zipcode of the object
valuationdate	number	Enter as YYYYMMDD, gives newest transaction till that date. Default is TODAY
houseaddition	string	House letter and addition of the object
housenumber*	number	House number of the object

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				43
			],
			"msg": "Expecting value: line 3 column 18 (char 43)",
			"type": "value_error.jsondecode",
			"ctx": {
				"msg": "Expecting value",
				"doc": "{\n  \"postcode\": \"2201PZ\",\n  \"housenumber\": a,\n  \"valuationdate\": \"20121001\"\n}",
				"pos": 43,
				"lineno": 3,
				"colno": 18
			}
		}
	]
}

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": "Transaction Data for 2728KH-8- is available.",
	"Date": "20210602"
}

Request body

Example request

{
	"postcode": "2728KH",
	"housenumber": 5
}