Infer Belgio

Alpha

Suggest possible Belgian addresses from a string.

Riferimento OpenAPI Scarichi il database

GEThttps://api.pro6pp.nl/v2/infer/be

Panoramica

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.

ParametriQuery string

authKeystringObbligatorio

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.

querystringObbligatorio

String to generate suggestions from.

Esempio: 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.

Predefinito: "relevance"
Uno tra: 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.

Uno tra: nlfrde

Risposte

200Address suggestions for the query

Campo	Tipo	Descrizione
cities	array of objectNullable	Settlements matching the query, returned only in the mixed stage when any match.
cities[].label	string	The settlement name.
cities[].value	string	The canonical selection value, returned when a language is requested.
cities[].exact	boolean	False for a fuzzy match; left out for an exact one
cities[].matched_value	string	The value a fuzzy match found, in lowercase
cities[].diff_positions	array of integer	The 0-based positions in the query that differ from the fuzzy match
stage	string	The current stage of address inference
streets	array of objectNullable	Streets matching the query, returned only in the mixed stage when any match.
streets[].label	string	The street name.
streets[].value	string	The canonical selection value, returned when a language is requested.
streets[].subtitle	string	The settlement the street lies in, with its postal code when it has one
streets[].count	stringNullable	How many settlements ("3 places") or postal codes ("2 postcodes") the street name occurs in, when more than one.
streets[].exact	boolean	False for a fuzzy match; left out for an exact one
streets[].matched_value	string	The value a fuzzy match found, in lowercase
streets[].diff_positions	array of integer	The 0-based positions in the query that differ from the fuzzy match
suggestions	array of object	Suggestions for the next part of the address; in the mixed stage, the matching settlements and streets in ranked order.
suggestions[].label	string	Human-readable label for the suggestion
suggestions[].subtitle	stringNullable	Additional context information (e.g., postal code)
suggestions[].count	stringNullable	Number of results for this suggestion (e.g., "2 postcodes")
suggestions[].value	string \| object	Canonical selection string or structured address data for address-detail suggestions.
suggestions[].exact	boolean	False for a fuzzy match; left out for an exact one
suggestions[].matched_value	string	The value a fuzzy match found, in lowercase
suggestions[].diff_positions	array of integer	The 0-based positions in the query that differ from the fuzzy match
suggestions[].street_translations	array of object	Every name the dataset has for the street of a complete address
suggestions[].street_translations[].lang	string	The language code of the name, such as "nl", "fr" or "de".
suggestions[].street_translations[].name	string	The street name in that language.
suggestions[].settlement_translations	array of object	Every name the dataset has for the settlement of a complete address
suggestions[].settlement_translations[].lang	string	The language code of the name, such as "nl", "fr" or "de".
suggestions[].settlement_translations[].name	string	The settlement name in that language.

Risposta di esempio

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

Errori

Campi di una risposta di errore

Campo	Tipo	Descrizione
error_id	string	The reason the request failed, such as `INVALID_VALUE`. The response lists the reasons this operation returns.
errors	array of object	One entry per problem found in the request.
errors[].message	string	A readable explanation of the problem, in English.
errors[].help	string	A link to the documentation section that covers the problem.
errors[].parameter	any	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[].value	any	The value the request sent for `parameter`, when it has one.

400Richiesta non valida

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 autorizzato

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

Esempi di codice

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

La invitiamo a richiedere codice di esempio nel linguaggio di programmazione che preferisce.