Autocomplete België^beta

Met deze API call kunnen Belgische adressen worden aangevuld. De documentatie voor Nederlandse adressen is te vinden onder autocomplete Nederland.

Om een Belgisch adres volledig te valideren zijn de volgende gegevens nodig:

• Postnummer (ook te verkrijgen vanuit plaats)
• Straat
• Huisnummer (met eventueel een subadres aanduiding zoals appartement of busnummer)

Er zijn diverse API calls beschikbaar om een gebruikersvriendelijke applicatie te creëren waarbij postnummer, plaats en straat aangevuld kunnen worden door enkel de eerste cijfers/letters op te geven.

Verplichte parameters

Gebruik één van beide verplichte parameters:

• be_fourpp: geef het Belgische postnummer (gedeeltelijk of de volledige 4 cijfers) op, voor provincie, gemeente en woonplaats gegevens.
• be_city: geef een (gedeeltelijke) Belgische plaatsnaam op, voor provincie, gemeente en postnummer gegevens.

Optionele parameters

• street: geef een (gedeeltelijke) straat op om een lijst straten terug te ontvangen die voldoen aan de opgegeven (gedeeltelijk) straatnaam. Om een straat te kunnen valideren is de be_fourpp parameter ook verplicht.
• streetnumber: geef een huisnummer op. Om een huisnummer te kunnen valideren zijn de volledige be_fourpp en street nodig.
• subaddress: geef een sub-adres op (bijvoorbeeld busnummer of appartementnummer). Om een sub-adres te kunnen valideren zijn de volledige be_fourpp, street en streetnumber nodig.
• language: geef de taal op waarin de plaats- en straatgegevens worden doorzocht. Mogelijkheden zijn nl en fr. Standaard wordt in beide talen gezocht.
• per_page: het maximaal aantal resultaten dat wordt geretourneerd. Standaard is dit 10.

Voorbeelden

Postcode aanvraag

undefined/v1/autocomplete?auth_key=YOUR_AUTH_KEY&be_fourpp=1200

Deze aanvraag geeft het volgende resultaat:

{
  "status": "ok",
  "results": [
    {
      "province_nl": "Brussel",
      "province_fr": "Bruxelles",
      "municipality_nl": "Sint-lambrechts-woluwe",
      "municipality_fr": "Woluwe-saint-lambert",
      "city_nl": "Sint-lambrechts-woluwe",
      "city_fr": "Woluwe-saint-lambert",
      "fourpp": 1200,
      "lat": null,
      "lng": null
    }
  ]
}

Straat aanvraag

In dit voorbeeld wordt behalve het opvragen van een partiële straatnaam ook gekozen voor het XML uitvoer formaat.

undefined/v1/autocomplete?auth_key=YOUR_AUTH_KEY&be_fourpp=1200&street=a&format=xml

Deze aanvraag geeft het volgende resultaat:

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <results>
    <result>
      <street_nl>A. Marinusgaarde</street_nl>
    </result>
    <result>
      <street_nl>A.en M.L. Servais-Kinetstraat</street_nl>
    </result>
    <result>
      <street_nl>A.J. Slegersgaarde</street_nl>
    </result>
    <result>
      <street_fr>Avenue Lambeau</street_fr>
    </result>
  </results>
</response>

Foutmeldingen

• ‘Invalid be_fourpp format’
  Het formaat dient te bestaan uit 4 cijfers. Extra spatiëring en gebruik van hoofd- of kleine letters worden automatisch gecorrigeerd.
• ‘Street number not found’
  De ‘street number’ parameter is meegegeven maar het opgegeven huisnummer bestaat niet volgens onze database.