Authenticatie, invoer en resultaat

Transaction API

V1

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

Met dit eindpunt kun je Kadaster-transactiegegevens voor een object ophalen.

Headers

Naam	Type	Omschrijving
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

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

400: 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: Verkeerd invoerformaat

401: Geen toegang

403: Verboden

500: Service is niet beschikbaar en/of niet beschikbaar

200: Succesvolle reactie

V2

GRATIS Ping voor beschikbaarheid

Post objectgegevens om de beschikbaarheid van transactiegegevens te ontvangen

V1

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

Met dit eindpunt kun je de beschikbaarheid van de transactiegegevens uit onze database opvragen. Voor een POST-verzoek is een bodyparameter (adres) vereist.

Headers

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

Request Body

Naam	Type	Omschrijving
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	Huis en toevoeging van het object
housenumber*	number	Huisnummer van het object

422: 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: Geen toegang

403: Verboden

500: Service is niet beschikbaar en/of niet beschikbaar

200: Succesvolle reactie

Request body

Voorbeeld verzoek

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

V2