Authenticatie, invoer en resultaat

Transaction API

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

Met dit eindpunt kunt u Kadaster-transactiegegevens voor een object ophalen.

Headers

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

Request Body

Name	Type	Description
postcode*	string	Postcode van het object
valuationdate	number	Voer in als JJJJMMDD, geeft de nieuwste transactie tot die datum weer. De standaardwaarde is VANDAAG
houseaddition	string	Huisbrief en toevoeging van het object
housenumber*	number	Huisnummer van het object

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."
}

422: Unprocessable Entity Verkeerd invoerformaat

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

200: OK Succesvolle reactie

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

GRATIS Ping voor beschikbaarheid

Post objectgegevens om de beschikbaarheid van transactiegegevens te ontvangen

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

Met dit eindpunt kunt u de beschikbaarheid van de transactiegegevens uit onze database opvragen. Voor een POST-verzoek is een bodyparameter (Adres) vereist.

Headers

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

Request Body

Name	Type	Description
postcode*	string	Postcode van het object
valuationdate	number	Voer in als JJJJMMDD, geeft de nieuwste transactie tot die datum weer. De standaardwaarde is VANDAAG
houseaddition	string	Huisbrief en toevoeging van het object
housenumber*	number	Huisnummer van het object

422: Unprocessable Entity Verkeerd invoerformaat

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

200: OK Succesvolle reactie

{
	"Output": "Transaction Data for 2728KH-8- is available.",
	"Date": "20210602"
}

Request body

Voorbeeld verzoek

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