Infer Belgique

Alpha

Suggérer des adresses belges possibles à partir d'une chaîne de caractères.

Référence OpenAPITélécharger la base de données
GEThttps://api.pro6pp.nl/v2/infer/be

Vue d'ensemble

Resolves a single query string into complete or probable addresses and returns a list of ranked suggestions. Each suggestion includes a stage indicating the current resolution step or completion status.

Belgium has three official languages (Dutch, French, German). The API automatically returns suggestions in the appropriate language based on the region, or you can specify a preferred language using the language parameter.

Stage meanings:

  • empty: returned on an empty query.
  • mixed: settlement and street suggestions.
  • postcode: postal code suggestions.
  • street_number: street number suggestions.
  • addition: street number addition suggestions.
  • direct: full address suggestions, with or without an addition.
  • final: a fully validated and structured address.

Street and settlement name matching:

  • One or two characters match names from the start (prefix).
  • Three or more characters match anywhere in the name: gebouw also finds Klokgebouw.
  • Matches are ranked by quality: the exact name first, then names the query starts, then matches beginning at a word boundary, then mid-word matches. Ties within a rank go to the name covering the most addresses.
  • When the names containing the query leave suggestion slots free, close matches fill them below the exact matches, absorbing typos.

ParamètresChaîne de requête

authKeystringObligatoire

Every request needs an API key, which you can get in the portal.

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the portal, or send the requests through your own server so the key stays hidden.

querystringObligatoire

String to generate suggestions from.

Exemple
Brussel, Wetstraat
limitinteger

Maximum number of suggestions to return. Must be between 1 and 1000 when provided; omitting the parameter uses the default page size.

Min.
1
Max.
1000
sortstring

Sort mixed city and street suggestions by relevance (default) or distance. Distance sorting requires the Infer Extended (infer::location) capability. Distance sorting uses lat and lng when provided. Otherwise, it uses the approximate location derived from the request IP. If that location is unavailable, suggestions are sorted by relevance.

Par défaut
"relevance"
L'une des valeurs
relevancedistance
latnumber

Latitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min.
-90
Max.
90
lngnumber

Longitude of the origin used for distance sorting. When providing coordinates, include both lat and lng.

Min.
-180
Max.
180
languagestring

Preferred language for results (nl=Dutch, fr=French, de=German). If not specified, the language is determined by the region of the address.

L'une des valeurs
nlfrde

Réponses

200Address suggestions for the query
ChampTypeDescription
citiesarray of objectPeut être null

Settlements matching the query, returned only in the mixed stage when any match.

cities[].labelstring

The settlement name.

cities[].valuestring

The canonical selection value, returned when a language is requested.

cities[].exactboolean

False for a fuzzy match; left out for an exact one

cities[].matched_valuestring

The value a fuzzy match found, in lowercase

cities[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

stagestring

The current stage of address inference

streetsarray of objectPeut être null

Streets matching the query, returned only in the mixed stage when any match.

streets[].labelstring

The street name.

streets[].valuestring

The canonical selection value, returned when a language is requested.

streets[].subtitlestring

The settlement the street lies in, with its postal code when it has one

streets[].countstringPeut être null

How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one.

streets[].exactboolean

False for a fuzzy match; left out for an exact one

streets[].matched_valuestring

The value a fuzzy match found, in lowercase

streets[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

suggestionsarray of object

Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order.

suggestions[].labelstring

Human-readable label for the suggestion

suggestions[].subtitlestringPeut être null

Additional context information (e.g., postal code)

suggestions[].countstringPeut être null

Number of results for this suggestion (e.g., "2 postcodes")

suggestions[].valuestring | object

Canonical selection string or structured address data for address-detail suggestions.

suggestions[].exactboolean

False for a fuzzy match; left out for an exact one

suggestions[].matched_valuestring

The value a fuzzy match found, in lowercase

suggestions[].diff_positionsarray of integer

The 0-based positions in the query that differ from the fuzzy match

suggestions[].street_translationsarray of object

Every name the dataset has for the street of a complete address

suggestions[].street_translations[].langstring

The language code of the name, such as "nl", "fr" or "de".

suggestions[].street_translations[].namestring

The street name in that language.

suggestions[].settlement_translationsarray of object

Every name the dataset has for the settlement of a complete address

suggestions[].settlement_translations[].langstring

The language code of the name, such as "nl", "fr" or "de".

suggestions[].settlement_translations[].namestring

The settlement name in that language.

Exemple de réponse
{
  "stage": "street_number",
  "suggestions": [
    {
      "label": "1",
      "subtitle": "Wetstraat"
    },
    {
      "label": "2",
      "subtitle": "Wetstraat"
    },
    {
      "label": "3",
      "subtitle": "Wetstraat"
    },
    {
      "label": "4",
      "subtitle": "Wetstraat"
    },
    {
      "label": "5",
      "subtitle": "Wetstraat"
    },
    {
      "label": "6",
      "subtitle": "Wetstraat"
    },
    {
      "label": "8",
      "subtitle": "Wetstraat"
    },
    {
      "label": "9",
      "subtitle": "Wetstraat"
    }
  ]
}

Erreurs

Champs d'une réponse d'erreur
ChampTypeDescription
error_idstring

The reason the request failed, such as INVALID_VALUE. The response lists the reasons this operation returns.

errorsarray of object

One entry per problem found in the request.

errors[].messagestring

A readable explanation of the problem, in English.

errors[].helpstring

A link to the documentation section that covers the problem.

errors[].parameterany

The parameter the problem is about. Usually its name; a list when several parameters are involved, or a name with the values to choose from when the request must select one.

errors[].valueany

The value the request sent for parameter, when it has one.

400Requête invalide
MISSING_PARAMETER

A parameter that other parameters depend on is missing. errors has one entry per missing parameter.

MISSING_PARAMETER
{
  "error_id": "MISSING_PARAMETER",
  "errors": [
    {
      "message": "Required parameter lat is missing",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "lat"
    }
  ]
}
INVALID_PARAMETER_TYPE

A value has the wrong type, such as text for a number.

INVALID_PARAMETER_TYPE
{
  "error_id": "INVALID_PARAMETER_TYPE",
  "errors": [
    {
      "message": "parameter: lat has invalid 1,0, should be number",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "lat"
    }
  ]
}
INVALID_VALUE

A required parameter is missing, or a value is malformed, out of bounds or cannot be found.

INVALID_VALUE
{
  "error_id": "INVALID_VALUE",
  "errors": [
    {
      "message": "value is invalid",
      "help": "https://pro6pp.nl/docs/v2/redoc",
      "parameter": "postalCode",
      "value": "invalid"
    }
  ]
}
401Non autorisé
UNAUTHORIZED

The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.

UNAUTHORIZED
{
  "error_id": "UNAUTHORIZED",
  "errors": [
    {
      "message": "No authorization token provided",
      "help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
    }
  ]
}

Exemples de code

curl "https://api.pro6pp.nl/v2/infer/be?query=Brussel%2C+Wetstraat&authKey=YOUR_API_KEY"

Nous vous encourageons à demander un exemple de code dans votre langue préférée.