Authenticatie, invoer en resultaat

Ontvang suggesties voor adressen van onroerend goedobjecten van Altum AI.

GET https://api.altum.ai/autosuggest?search={string}&fuzzy=true of 1 of yes

Met dit eindpunt kunt u vijf (5) suggesties krijgen op basis van uw queryparameters. Het heeft minimaal één (1) teken nodig en reageert met de beste suggesties.

Query Parameters

Name	Type	Description
fuzzy	boolean	Of je nu vage resultaten nodig hebt of niet. Dit kan True, 1 of yes.
search*	string	Postcode, Huisnummer, Huisnummertoevoegingen en Straatnamen kunnen via de zoekparameter als zoekopdracht worden doorgegeven.

Headers

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

200: OK Succesvolle reactie

{
    "Output": {
        "1": {
            "vbo_id": "0715010000037469",
            "houseaddress": "4554LB-119-b",
            "huisnummer": "119",
            "postcode": "4554LB",
            "huisletter": "b",
            "openbareRuimteNaam": "Graafjansdijk B",
            "woonplaatsNaam": "Westdorpe"
        },
        "2": {
            "vbo_id": "0352010000007420",
            "houseaddress": "3947BA-1-b",
            "huisnummer": "1",
            "postcode": "3947BA",
            "huisletter": "b",
            "openbareRuimteNaam": "Langbroekerdijk B",
            "woonplaatsNaam": "Langbroek"
        },
        "3": {
            "vbo_id": "0352010000011963",
            "houseaddress": "3947BA-13-b",
            "huisnummer": "13",
            "postcode": "3947BA",
            "huisletter": "b",
            "openbareRuimteNaam": "Langbroekerdijk B",
            "woonplaatsNaam": "Langbroek"
        },
        "4": {
            "vbo_id": "0014010040018130",
            "houseaddress": "9792PK-2-b",
            "huisnummer": "2",
            "postcode": "9792PK",
            "huisletter": "b",
            "openbareRuimteNaam": "B. Kuiperweg",
            "woonplaatsNaam": "Ten Post"
        },
        "5": {
            "vbo_id": "0693010000002358",
            "houseaddress": "2975BK-65-",
            "huisnummer": "65",
            "postcode": "2975BK",
            "huisletter": null,
            "openbareRuimteNaam": "B",
            "woonplaatsNaam": "Ottoland"
        }
    }
}

400: Bad Request Mislukte reactie

{
    "Output": "Could not find any object with your search query"
}

422: Unprocessable Entity Verkeerd invoerformaat

{
    "errors": {
        "postcode": "Unsupported postcode length, it should be six."
    },
    "message": "Input payload validation failed"
}

OR

{
    "errors": {
        "postcode": "Unsupported postcode format, it should consist of four numbers following by two letters."
    },
    "message": "Input payload validation failed"
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

401: Unauthorized Geen toegang

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

429: Too Many Requests API-sleutellimiet overschreden

Schakel fuzzy in om query's met meerdere tekenreeksen te ondersteunen. Lees hier meer over ondersteuning voor fuzzy zoeken.

Request query

Voorbeeld verzoek

https://api.altum.ai/autosuggest?search=1181TV
https://api.altum.ai/autosuggest?search=3947BA-1-b
https://api.altum.ai/autosuggest?search=bellefleurho5&fuzzy=1
https://api.altum.ai/autosuggest?search=bellefleurho%205&fuzzy=yes
https://api.altum.ai/autosuggest?search=bellefleurho%205&fuzzy=true

Spaties moeten worden ingestuurd als %20