Skip to content

Address Database

Paid feature

To access and utilize this API, there are associated costs involved. For more information regarding pricing and to enable access to the API, please contact our team at it@wegroup.be.

Introduction

WeGroup holds an up-to-date address database covering Belgium and the Netherlands, this database can be used to check, list, retrieve and verify residences.

A full example response can be found here: moutstraat68.json.

Use cases

TODO

API Documentation

Environment Documentation Link
STAGING https://api.staging.wegroup.be/redoc#tag/address
PRODUCTION https://api.wegroup.be/redoc#tag/address

How to

  1. Search for an existing address

Request:

curl -X GET \
    "https://api.wegroup.be/v1/api/address/search?q='Moutstraat 68 Gent'" \
    -H "Authorization: apikey $API_TOKEN"

curl -X GET \
    "https://api.wegroup.be/v1/api/address/search?q='Moutstraat 68 Gent'" \
    -H "Authorization: Bearer $ACCESS_TOKEN"

Response:

{
    "items": [
        {
            "address": {
                "street": "Moutstraat",
                "country_code": "BE",
                "zipcode": "9000",
                "housenr": "68",
                "boxnr": null,
                "city": "Ghent",
                "lat": 51.02989,
                "lng": 3.73747,
                "region": "Oost-Vlaanderen"
            },
            "self": "https://rest.wegroup.io/v1/api/address/info/premium?street=Moutstraat&country_code=BE&zipcode=9000&housenr=68&boxnr=None&city=Ghent&lat=51.02989&lng=3.73747&region=Oost-Vlaanderen"
        }
    ]
}
  1. Get the information

Request:

curl -X GET \
    "https://rest.wegroup.io/v1/api/address/info/premium?street=Moutstraat&country_code=BE&zipcode=9000&housenr=68&boxnr=None&city=Ghent&lat=51.02989&lng=3.73747&region=Oost-Vlaanderen" \
    -H "Authorization: apikey $API_TOKEN"

curl -X GET \
    "https://rest.wegroup.io/v1/api/address/info/premium?street=Moutstraat&country_code=BE&zipcode=9000&housenr=68&boxnr=None&city=Ghent&lat=51.02989&lng=3.73747&region=Oost-Vlaanderen" \
    -H "Authorization: Bearer $ACCESS_TOKEN"

Response:

{
    "data": {
        "address": {
            "street": "Moutstraat",
            "country_code": "BE",
            "zipcode": "9000",
            "housenr": "68",
            "boxnr": null,
            "city": "Gent",
            "lat": 51.0298788576438,
            "lng": 3.73746651625874,
            "region": "Oost-Vlaanderen"
        },
        "parcel": {
            "surface": 20188.94,
            "outline": 802.24,
            "external_reference": "5014835",
            "flood_zone_hazard": "no_hazard",
            "neighborhood_density": 1,
  ...
}