API d'autocomplétion d'adresses belges
Envoyez ce que l'utilisateur a tapé jusqu'ici et recevez les adresses officielles correspondantes, dans les deux langues, avec leurs coordonnées et les entreprises qui y sont établies.
EndpointGET https://addrly.be/api/v1/autocomplete
Quand l'utiliser
- Un champ adresse dans un formulaire de commande, d'inscription ou de livraison.
- Une barre de recherche qui accepte une rue, un code postal ou une commune.
- Un formulaire qui doit enregistrer l'adresse découpée en rue, numéro, boîte et code postal.
- Coût
- 1 requête par session de frappe
- Authentification
- En-tête X-API-Key
- Couverture
- Toutes les adresses officielles de Belgique
Paramètres de requête
| Paramètre | Type | Description |
|---|---|---|
qobligatoire |
string |
Le texte tapé jusqu'ici : une rue, un numéro, un code postal ou une commune, en français ou en néerlandais. |
limitfacultatif |
integer |
Le nombre de suggestions à renvoyer.
De 1 à 50 Par défaut : 10 |
typefacultatif |
address | company |
address ne renvoie que des adresses, company que des entreprises. Sans ce paramètre, les deux. |
include_archivedfacultatif |
boolean |
Renvoie aussi les entreprises radiées de la BCE. Sans effet sur les adresses.
Par défaut : 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
}
Les autres endpoints adresse
Normalisation
Une ligne de texte libre en entrée, l'adresse officielle structurée et un score en sortie.
Lire la référenceValidation d'adresse
Cette adresse existe-t-elle ? Oui ou non, un score de confiance et la version officielle.
Lire la référenceValidation par champ
Champ par champ : quelle partie de l'adresse est fausse, et son orthographe officielle.
Lire la référenceGéocodage inverse
Des coordonnées GPS en entrée, les adresses officielles les plus proches et leur distance en sortie.
Lire la référence