Skip to content Skip to sidebar Skip to footer
Inloggen

Normalised Search API

Close

Normalised search API

The Normalised search API is created to search for streets, postal codes, cities, and municipalities. This can be useful when implementing our API in any autocomplete integration or if you need custom searches of address data. The endpoints and data for all supported countries are Normalised. So you can use the same endpoint/type of calls for all countries!

Note; some countries have specific fields or data available. Read the documentation for each country to be aware of any extra (or missing) data.

Pricing

You can use this API with any of our subscription types. Each single API call counts as one request. If you go over your quotum within your subscription package? You will get billed for each request you make unless you disable your API key from the dashboard.

Note; be careful of your implementation to prevent too much API calls.

Global documentation

The search API is normalized across all supported counties. This means that all the response structures are the same across all supported countries. However, some countries have exceptions or limitations. Check the documentation page for each country to check for anomalies.

 

Search all cities

Method: GET

GET https://api.apicheck.nl/search/v1/city/{country_code}?name={name_of_the_city}

URL-Parameters:

  • name (required, string)
  • limit (optional, number (default=25))

Example response
This response is using the country_code “fr” and as name value “Rouen”.

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "Rouen",
                "city_id": 23736,
                "Postalcodes": [
                    {
                        "name": "76000",
                        "postalcode_id": 3958
                    },
                    {
                        "name": "76100",
                        "postalcode_id": 3959
                    },
                    {
                        "name": "76600",
                        "postalcode_id": 3960
                    }
                ]
            }
        ]
    },
    "count": 1
}
Search all streets

Method: GET

GET https://api.apicheck.nl/search/v1/street/{country_code}?name={name_of_the_street}

URL-Parameters:

  • name (required, string)
  • limit (optional, number (default=25))
Example request
GET https://api.apicheck.nl/search/v1/street/fr?name=Rue de&postalcode_id=3958&city_id=23736
 
Note: Some records are removed (normally this request will return 25 records)
{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "Rue Descroizilles Prolongee",
                "street_id": 362725,
                "City": {
                    "name": "Rouen",
                    "city_id": 23736
                }
            },
            {
                "name": "Rue des 3 Suisses",
                "street_id": 6099,
                "City": {
                    "name": "Rouen",
                    "city_id": 23736
                }
            }
        ]
    },
    "count": 25
}
Search all postalcodes

Method: GET

GET https://api.apicheck.nl/search/v1/postalcode/{country_code}?name={name_of_the_postalcode}

URL-Parameters:

  • name (required, string)
  • limit (optional, number (default=25))
Example request

GET https://api.apicheck.nl/search/v1/postalcode/fr?name=1031

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "10310",
                "postalcode_id": 446,
                "City": {
                    "name": "Ville-sous-la-Ferté",
                    "city_id": 3171
                }
            }
        ]
    },
    "count": 1
}
Verify/get the full address

Method: GET

GET https://api.apicheck.nl/search/v1/postalcode/{country_code}?number={number}&numberAddition={numberAddition}&street_id={street_id}&city_id={city_id}&postalcode_id={postalcode_id}

URL-Parameters:

  • limit (optional, number (default=25))
  • number (optional, number)
  • numberAddition (optional, string)
  • street_id (optional, string)
  • city_id (optional, string)
  • postalcode_id (optional, string)

Note: this request can return multiple results. The most likely result is the first. You can refine the results by adding the above paramters.

Example request

GET https://api.apicheck.nl/search/v1/address/fr?number=1&street_id=6099&city_id=23736

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "street": "Rue des 3 Suisses",
                "number": "1",
                "numberAddition": null,
                "postalcode": "76000",
                "city": "Rouen",
                "municipality": "Rouen",
                "region": null,
                "formattedAddress": "1 Rue des 3 Suisses 76000 Rouen, France",
                "Location": {
                    "Coordinates": {
                        "latitude": "49.454006",
                        "longitude": "1.099518"
                    }
                }
            }
        ]
    },
    "count": 1
}

Run and try out in Postman: