API

Belgium - Autocomplete a street within a postal area

Given a postal area code, get a list of streets matching the specified street name. Use the completePostalArea method to get the first two parameters for this method.

The correct way to format an address in Belgium using the output of this method is: 'Recipient name [newline] streetName houseNumber [newline] postcode municipalityName'.

URL template

The REST API requires GET requests. Parameters are added to the REST resource URL, and each parameter must be URL-encoded:

https://api.postcode.eu/be/v1/autocomplete/street/{municipalityNisCode}/{postcode}/{streetName}

Example REST request

Retrieving /be/v1/autocomplete/street/11002//eurapa with the proper authentication would use the following HTTP Request:

GET /be/v1/autocomplete/street/11002//eurapa HTTP/1.1
Host: api.postcode.eu
Authorization: Basic 2eTpkU******…

Example response

The lookup is successful so we receive a 200 OK status in the headers:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

And a JSON response in the body:

[
	{
		"streetId": 824,
		"streetName": "Europalaan",
		"postcode": 2610,
		"municipalityName": "Antwerpen",
		"houseNumberFrom": 1,
		"houseNumberTo": 36,
		"language": "nl"
	},
	{
		"streetId": 825,
		"streetName": "Europasquare",
		"postcode": 2100,
		"municipalityName": "Antwerpen",
		"houseNumberFrom": null,
		"houseNumberTo": null,
		"language": "nl"
	}
]

Parameters

municipalityNisCode: int

Identifier for the municipality in which the street is located.

postcode: int

The postcode, narrows down the location of the street inside the municipality. This parameter is optional and may be left empty, but if the postcode is known you should always specify it.

streetName: string

A street name. The specified name may be partial but more complete street names result in better matches. If there are zero results for a given input, adding more words can still result in matches.

Returns

Array of arrays

An array of matching streets

streetId: int

A unique identifier for the street.

streetName: string

The street name. The maximum length of a street name is 80 characters.

language: string

The language in which the street name is specified. Possible languages: 'nl', 'fr', 'de'.

postcode: int

The postcode for the street.

municipalityName: string

The name of the municipality in which the street is located. The maximum length of a municipality name is 40 characters.

houseNumberFrom: int

The lowest house number for the combination of postcode and street name. May be null, as house number information is not available for all streets.

houseNumberTo: int

The highest house number for the combination of postcode and street name. May be null, as house number information is not available for all streets.