Purpose

The NL Locations API allows you to search for Dutch addresses using a wide range of input parameters. The API returns a ranked list of matching addresses, scored by relevance to the search criteria.

Address Search

❗ This endpoint incurs usage-based charges.

To query Dutch addresses, make a GET request to the locations endpoint with one or more search parameters. The API will return the best-matching addresses based on your input.

With this endpoint, you can search for a Dutch address with a set of parameters. This will return a list of addresses and its information about the address.

Request parameters

query - Will use all of the values given and return results based on the best match.
filter - Filter is used for an exact match. So if the given input doesn't 100% match, no results are given.
match - Searches with the given parameters and returns a list based on the highest score. Doesn't have to be an exact match and can contain non complete values.

Example Request

GET /nl/locations?query=someOrganisation&match[city]=amsterdam

Note: For a complete overview of supported search parameters, refer to the API Reference documentation.

Pagination

Responses from this endpoint are paginated — results are returned in batches to optimize performance and response time. By default, each response includes 10 results.

To retrieve additional results:
• Increase the size parameter to return more items per page (maximum: 50).
• Use the page parameter to navigate to the next set of results.

The response metadata includes pagination details such as the total number of results and total number of pages.

Request Parameters

size – Number of results per page.
Default: 10, Maximum: 50
page – Page number to retrieve.
Default: 1

Example request

curl --request GET \
     --url 'https://api.company.info/nl/locations?filter[city]=amsterdam%2012&page[size]=10&page[number]=1' \
     --header 'X-API-KEY: *********************' \
     --header 'accept: application/vnd.api+json'

Example response

{
    "data": [
        {
            "type": "locations",
            "id": "363200013047546",
            "attributes": {
                "buildingID": 363100012077044,
                "buildingStatus": "PAND_IN_GEBRUIK",
                "buildingYear": 1881,
                "city": "Amsterdam",
                "houseLetter": "",
                "houseNumber": 2,
                "houseNumberAddition": "3",
                "lat": 0,
                "lon": 0,
                "municipality": "Amsterdam",
                "numberIndication": 363200013047546,
                "objectID": 363010012587396,
                "postalCode": "1054KP",
                "province": "Noord-Holland",
                "secondaryAddress": false,
                "status": "VERBLIJFSOBJECT_GEVORMD",
                "street": "Saxenburgerstraat",
                "surfaceArea": 98,
                "usagePurpose": "woonfunctie",
                "x": 119131.534,
                "y": 485790.249
            }
        },
        {
            "type": "locations",
            "id": "363200013047545",
            "attributes": {
                "buildingID": 363100012077044,
                "buildingStatus": "PAND_IN_GEBRUIK",
                "buildingYear": 1881,
                "city": "Amsterdam",
                "houseLetter": "",
                "houseNumber": 2,
                "houseNumberAddition": "2",
                "lat": 0,
                "lon": 0,
                "municipality": "Amsterdam",
                "numberIndication": 363200013047545,
                "objectID": 363010012587395,
                "postalCode": "1054KP",
                "province": "Noord-Holland",
                "secondaryAddress": false,
                "status": "VERBLIJFSOBJECT_GEVORMD",
                "street": "Saxenburgerstraat",
                "surfaceArea": 87,
                "usagePurpose": "woonfunctie",
                "x": 119131.861,
                "y": 485790.434
            }
        }
    ],
    "links": {
        "last": "/nl/locations?query=amster&page[size]=10&page[number]=2697",
        "next": "/nl/locations?query=amster&page[size]=10&page[number]=2",
        "self": "/nl/locations?query=amster&page[size]=10&page[number]=1"
    },
    "meta": {
        "totalPages": 2697,
        "totalResults": 26963
    }
}

Error Handling

See General Error Handling

Test the API

Use our API Reference to interact with the endpoint, adjust parameters, and view live responses.