Belgian address autocomplete API
Send what the user has typed so far and get the matching official addresses back, with both language versions, coordinates and the companies registered there.
EndpointGET https://addrly.be/api/v1/autocomplete
When to use it
- An address field in a checkout, signup or delivery form.
- A search box that accepts a street, a postcode or a municipality.
- A form that must store the address split into street, number, box and postcode.
- Cost
- 1 request per typing session
- Authentication
- X-API-Key header
- Coverage
- Every official address in Belgium
Query parameters
| Parameter | Type | Description |
|---|---|---|
qrequired |
string |
The text typed so far: a street, a number, a postcode or a municipality, in French or Dutch. |
limitoptional |
integer |
How many suggestions to return.
From 1 to 50 Default: 10 |
typeoptional |
address | company |
address returns addresses only, company companies only. Leave it out to get both. |
include_archivedoptional |
boolean |
Also return companies struck off the BCE register. Has no effect on addresses.
Default: false |
curl "https://addrly.be/api/v1/autocomplete?q=rue+de+la+loi+16&type=address&limit=5" \ -H "X-API-Key: YOUR_API_KEY"
{
"results": [
{
"result_type": "address",
"label": "Rue de la Loi 16, 1000 Bruxelles",
"street_fr": "Rue de la Loi",
"street_nl": "Wetstraat",
"house_number": "16",
"box_number": null,
"postcode": "1000",
"municipality_fr": "Bruxelles",
"municipality_nl": "Brussel",
"region": "Bruxelles-Capitale",
"lat": 50.8467,
"lon": 4.3499
}
],
"count": 1
}
The other address endpoints
Normalization
One line of free text in, the official structured address and a similarity score out.
Read the referenceAddress validation
Does this address exist? A yes or no, a confidence score and the official version.
Read the referenceField validation
Field by field: which part of the address is wrong, and its official spelling.
Read the referenceReverse geocoding
GPS coordinates in, the nearest official addresses and their distance out.
Read the reference