AddressThis service provides methods that can search or validate addresses in the Netherlands. Summary | This service provides methods that can search or validate addresses in the Netherlands. | | These methods search for an address and return a result on either house number range or parcel level. | | Determine if a specific address exists using the unique ‘1234AA12’ postcode + house number format. | | Search for a specific address, where the address contains the street, house number and house number addition concatenated. | | Search for addresses in the PCReeks format, using different search phrases for each address part. | | Search for addresses in the PCReeks format, using different search phrases for each address part. | | Search for addresses in the Perceel format, using a single search phrase. | | Search for addresses in the Perceel format, using different search phrases for each address part. | | | | Returns a list of all neighborhood codes in the province | | List all municipalities in a specific provinces. | | | | Search for all provinces that match a phrase. | | Search for all municipalities that match a phrase. | | List all cities in specific municipalities | | Returns a list of all neighborhood codes in the municipality. | | Search for all cities that match a phrase. | | Returns a list of all neighborhood codes in the city | | The following methods are deprecated and should not be used anymore. | | | | | | | | | | | | | | | | | | | | | | A single address range (‘reeks’) entry. | | A structure with at most one page of PCReeks entries. | | A structure with at most one page of Perceel entries. | | The query which was searched for, split into separate parts. | | A single address parcel (‘perceel’) entry. | | Contains an address, indicated by the house number and the house number addition within a postcode range. | | Information on a municipality (‘gemeente’). | | A single address city entry. | | Information on a city, its municipality and its province. | | Code and name for a province (‘provincie’). | | A single postal neighborhoodcode entry. | | A single postal neighborhoodcode and neighborhood name entry. |
Address search methodsThese methods search for an address and return a result on either house number range or parcel level. The parcel methods return a Perceel, with information on a specific house number and house number addition. The house number range methods return a PCReeks with information on house number range level. The house number range methods are less precise than the parcel methods, but cheaper. Also note that the parcel methods only support house number additions which are recognized by the municipality. Please note that Perceel level methods handle validation of PO box matches differently, see the documentation of Perceel for more information.
addressReeksAddressSearchSearch for a specific address, where the address contains the street, house number and house number addition concatenated. This is useful if the house number is not stored separate from the street name. A number of RangeAddress entries is returned. The street names in the result may not exactly match the street in the request. To account for different writing styles and spelling errors, streets which match approximately are also returned. E.g. “Calverstraat, Amsterdam” will return an address for the “Kalverstraat”. The results are ordered on how well they match, with the best matches first. If the given house number does not exist in the postcode range, the house number field is left empty. In this case, the RangeAddress contains a PCReeks which matches the street, but it contains no house number or house number addition. For example, searching for “Dam 44, Amsterdam” returns the PCReeks for the Dam, but the result omits the house number since there is no house number 44 on the Dam. Parametersaddress | Street, house number and house number addition of the searched address. Required. | postcode | Postcode in 1234AA format. Optional. | city | Phrase used to select the city of the address, see PCReeks.plaatsnaam. Optional. | page | Page to retrieve, pages start counting at 1 |
ReturnsSee alsoaddressReeksPostcodeSearch, addressReeksFullParameterSearch
addressReeksFullParameterSearchSearch for addresses in the PCReeks format, using different search phrases for each address part. Parametersprovince | Phrase to search for in province name, or code of the province. See PCReeks.provincienaam and PCReeks.provinciecode | district | Phrase used to select the municipality of the address, see PCReeks.gemeentenaam | city | Phrase used to select the city of the address, see PCReeks.plaatsnaam | street | Phrase used to select the street of the address, see PCReeks.straatnaam | houseNo | Number used to select the house number of the address, see PCReeks.huisnr_van | houseNoAddition | Phrase used to select the house number addition of the address | nbcode | Number used to select the neighborhoodcode of the address, the first four numbers of the postcode. See PCReeks.wijkcode | lettercombination | Phrase used to select the lettercombination of the address, the last two letters of the postcode. See PCReeks.lettercombinatie | addresstype | Phrase used to select the addresstype of the address, see PCReeks.reeksindicatie | page | Page to retrieve, pages start counting at 1 |
ReturnsSee alsoaddressReeksAddressSearch, addressReeksPostcodeSearch
addressReeksParameterSearchSearch for addresses in the PCReeks format, using different search phrases for each address part. NoticeaddressReeksFullParameterSearch allows more parameters to search. Parametersprovince | Phrase to search for in province name, or code of the province. See PCReeks.provincienaam and PCReeks.provinciecode | district | Phrase used to select the municipality of the address, see PCReeks.gemeentenaam | city | Phrase used to select the city of the address, see PCReeks.plaatsnaam | street | Phrase used to select the street of the address, see PCReeks.straatnaam | houseNo | Number used to select the house number of the address, see PCReeks.huisnr_van | houseNoAddition | Phrase used to select the house number addition of the address | page | Page to retrieve, pages start counting at 1 |
ReturnsSee alsoaddressReeksFullParameterSearch, addressReeksPostcodeSearch
addressPerceelPhraseSearchSearch for addresses in the Perceel format, using a single search phrase. The phrase can be a partial address. To search using separate fields for each addres part, use addressPerceelFullParameterSearchV2. PO box matchesPO box matches on PO box numbers are not returned by this method. Use addressPerceelFullParameterSearchV2 if you also need to match PO box addresses. See Perceel for more information. Supported phrasespostcode, house number | 1188 VP, 202bis | postcode | 1188 VP | neighborhood code | 1188 | city, address | Amstelveen, Amsteldijk Zuid 202bis | address, city | Amsteldijk Zuid 202bis, Amstelveen | city, street | Amstelveen, Amsteldijk Zuid | address | Amsteldijk Zuid 202bis |
Parametersaddress | Address phrase to search for in addresses | page | Page to retrieve, pages start counting at 1 |
ReturnsSee alsoaddressPerceelFullParameterSearchV2
addressPerceelFullParameterSearchV2Search for addresses in the Perceel format, using different search phrases for each address part. To search using a single combined phrase, use addressPerceelPhraseSearch. PO box matchesSee Perceel for information on how PO box matches are returned. Parametersprovince | Phrase used to select the province of the address, see Perceel.provincienaam | district | Phrase used to select the municipality of the address, see Perceel.gemeentenaam | city | Phrase used to select the city of the address, see Perceel.plaatsnaam | street | Phrase used to select the street of the address, see Perceel.straatnaam | houseNo | Number used to select the house number of the address, see Perceel.huisnr | houseNoAddition | Phrase used to select the house number addition of the address, see Perceel.huisnr_toevoeging | nbcode | Number used to select the neighborhoodcode of the address, the first four numbers of the postcode. See Perceel.wijkcode | lettercombination | Phrase used to select the lettercombination of the address, the last two letters of the postcode. See Perceel.lettercombinatie | addresstype | Phrase used to select the addresstype of the address, see Perceel.reeksindicatie | page | Page to retrieve, pages start counting at 1 |
ReturnsSee alsoaddressPerceelPhraseSearch
addressProvinceListNeighborhoodsReturns a list of all neighborhood codes in the province Parametersname | Name or code of the province | postbus | Boolean indicating whether Postbus neighborhood codes should be included in the result | page | Page to retrieve, pages start counting at 1 |
Returns
addressProvinceListDistrictsList all municipalities in a specific provinces. Parametersname | Name or code of the province to list the municipalities from | page | Page to retrieve, pages start counting at 1 |
Returns
addressProvinceListList all provinces. Parameterspage | Page to retrieve, pages start counting at 1 |
Returns
addressProvinceSearchSearch for all provinces that match a phrase. Parametersname | Phrase to search for in the province names, or the province code. | page | Page to retrieve, pages start counting at 1 |
Returns
addressDistrictSearchSearch for all municipalities that match a phrase. Parametersname | Phrase to search municipalities for, or the numeric identifier for the municipality. | page | Page to retrieve, pages start counting at 1 |
Returns
addressDistrictListCitiesList all cities in specific municipalities Parametersname | Phrase to search municipalities for, or the numeric identifier for the municipality. | page | Page to retrieve, pages start counting at 1 |
Returns
addressDistrictListNeighborhoodsReturns a list of all neighborhood codes in the municipality. Parametersname | Name or identifier of the municipality | postbus | Boolean indicating whether Postbus neighborhood codes should be included in the result | page | Page to retrieve, pages start counting at 1 |
Returns
addressCitySearchV2Search for all cities that match a phrase. Cities are also matched if input matches a commonly used alternative city name. Exact matches on the official name are listed first, the rest of the results are sorted alphabetically. This method differs from addressCitySearch by returning CityV2 entries instead of City entries, thus giving more information about a city. Parametersname | Phrase to search cities for, or the numeric identifier for the city. | page | Page to retrieve, pages start counting at 1 |
Returns
addressCityListNeighborhoodsReturns a list of all neighborhood codes in the city Parametersname | Name or identifier of the city | postbus | Boolean indicating whether Postbus neighborhood codes should be included in the result | page | Page to retrieve, pages start counting at 1 |
Returns
Deprecated address search methodsThe following methods are deprecated and should not be used anymore. For all of these methods an alternative, newer method is available. Even though these method still exists within this service, we can no longer give technical support on them.
addressPerceelFullParameterSearch
addressPerceelParameterSearch
Type definitionsNOTICE: The following concerns the output fields: perceelid, reeksid, straatid, plaatsid and gemeenteid
Within the service response, elements categorized as "Webservices.nl identifier" are defined. These identifiers are used internally to link the different postcode database tables and can change each time we perform an update to the database. Therefore NO software should rely on these ids!
PCReeksA single address range (‘reeks’) entry. A range specifies a set of house numbers using the fields huisnr_van, huisnr_tm and reeksindicatie. A range relates to a single postcode, but a postcode may contain multiple ranges. If a function returns a PCReeks, it means the given address could be in the returned range. However, it does not mean that the house number or house number addition really exist. In some cases, not all house numbers between huisnr_van and huisnr_tm exist. In contrast, functions which return a Perceel check the house number and house number addition. reeksid | Webservices.nl identifier for this house number range. | huisnr_van | Lowest house number of a postcode range. Range: 0-99999 | huisnr_tm | Highest house number of a postcode range. Range: 0-99999 | wijkcode | Four number neighborhoodcode (first part of a postcode). Range: ‘1000’-’9999’ | lettercombinatie | Two character lettercombination (second part of a postcode). Range: ‘AA’-’ZZ’ | reeksindicatie | Postcode range type. Range: {‘0’,’1’,’ ‘};’0’ | range of odd house numbers, | ’1’ | range of even house numbers, | ’ ‘ | vacant |
| straatid | Webservices.nl identifier for the street. | straatnaam | Street name in accordance with “Gemeentelijk Raadsbesluit”. In capital and lowercase letters, including punctuation marks. This field is at most 43 characters in length. Filled with ‘Postbus’ in case it is a range of PO boxes. | straatnaam_nen | Street name in accordance with NEN 5825 conventions. In capital and lowercase letters, including punctuation marks. This field is at most 24 characters in length. Longer street names are shortened using the NEN 5825 rules. Contains ‘Postbus’ in case it is a range of PO boxes. | straatnaam_ptt | Street name in accordance with TPG Post conventions; In capitals without punctuation marks. Filled with ‘POSTBUS’ in case it is a range of PO boxes. Maximum length of 17 characters. | straatnaam_extract | 5 letter abbreviation of the street name as used by TPG Post. In capitals without punctuation marks. | plaatsid | Webservices.nl identifier for the city. | plaatsnaam | Official city name in accordance with the NEN 5825 standard. In capitals including punctuation marks. This field is at most 24 characters in length. Longer city names are shortened in accordance with the NEN 5825 standard. | plaatsnaam_ptt | City name in accordance with the PTT standard. In capitals. Maximum length of 18 characters. | plaatsnaam_extract | Four letter abbreviation of the city name as used by TPG Post. In capitals without punctuation marks. | gemeenteid | Webservices.nl identifier for the municipality. | gemeentenaam | Municipality name in capital letters. The municipality name does not contain apostrophes, but may contain dashes. Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”. | gemeentecode | Code given by the CBS (Centraal Bureau Statistiek). Range: ‘0’-’9999’ | cebucocode | Code given by CeBuCo (Centraal Bureau voor Courantenpubliciteit). Range: ‘0’-’999’ | provinciecode | Code of the province, a single letter. | provincienaam | Official name of the province, correctly cased and with dashes where applicable. |
PCReeksSearchPartsPagedResultA structure with at most one page of PCReeks entries.
PerceelSearchPartsPagedResultA structure with at most one page of Perceel entries.
SearchPartsThe query which was searched for, split into separate parts. This information indicates how the function interpreted the input, which is especially useful for functions which do not have separate input fields. huisnr | House number. | toevoeging | Addition of the house number to uniquely define a location. | wijkcode | Four number neighborhoodcode (first part of a postcode). Range: ‘1000’-’9999’ | lettercombinatie | Two character lettercombination (second part of a postcode). Range: ‘AA’-’ZZ’ | straat | Street name. | plaats | City name. | gemeente | Municipality | provincie | Province. | reeksindicatie | Postcode range type. Range: {‘0’,’1’,’ ‘};’0’ | range of odd house numbers, | ’1’ | range of even house numbers, | ’ ‘ | vacant |
|
PerceelA single address parcel (‘perceel’) entry. Unlike PCReeks, a parcel specifies an existing address with house number and possible house number addition. PO box matchesOf the Perceel level functions, only addressPerceelFullParameterSearchV2 will return a match on a PO box address with a PO box number specified (using the house number parameter). This is because in case of a PO box (‘Postbus’) match, there is in fact no matching physical parcel. For this reason, when a PO box address is matched by addressPerceelFullParameterSearchV2, the PO box number provided in the search parameters is checked, but the ‘huisnr’ and ‘perceelnummer’ fields will be empty (0) in the Perceel match. perceelid | Webservices.nl identifier for this parcel. | huisnr | House number of a perceel. In case of a Postbus match the house number will always be 0. Range: 0-99999 | huisnr_toevoeging | Addition of the house number to uniquely define a location. These additions are officially recognized by the municipality. | perceelnummer | Unique number for a perceel / delivery point, assigned by TPG. In case of a Postbus address match perceelnummer will always be 0. | reeksid | Webservices.nl identifier for this house number range. | huisnr_van | Lowest house number of a postcode range. Range: 0-99999 | huisnr_tm | Highest house number of a postcode range. Range: 0-99999 | wijkcode | Four number neighborhoodcode (first part of a postcode). Range: ‘1000’-’9999’ | lettercombinatie | Two character lettercombination (second part of a postcode). Range: ‘AA’-’ZZ’ | reeksindicatie | Postcode range type. Range: {‘0’,’1’,’ ‘};’0’ | range of odd house numbers, | ’1’ | range of even house numbers, | ’ ‘ | vacant |
| straatid | Webservices.nl identifier for the street. | straatnaam | Street name in accordance with “Gemeentelijk Raadsbesluit”. In capital and lowercase letters, including punctuation marks. This field is at most 43 characters in length. Filled with ‘Postbus’ in case it is a range of PO boxes. | straatnaam_nen | Street name in accordance with NEN 5825 conventions; In capital and lowercase letters, including punctuation marks. This field is at most 24 characters in length. Longer street names are shortened using the NEN 5825 rules. Filled with ‘Postbus’ in case it is a range of PO boxes. | straatnaam_ptt | Street name in accordance with TPG Post conventions; In capitals without punctuation marks. Filled with ‘POSTBUS’ in case it is a range of PO boxes. Maximum length of 17 characters. | straatnaam_extract | 5 letter abbreviation of the street name as used by TPG Post; In capitals without punctuation marks. | plaatsid | Webservices.nl identifier for the city. | plaatsnaam | Official city name in accordance with the NEN 5825 standard. In capitals including punctuation marks. This field is at most 24 characters in length. Longer city names are shortened in accordance with the NEN 5825 standard. | plaatsnaam_ptt | City name in accordance with the PTT standard; In capitals. Maximum length of 18 characters. | plaatsnaam_extract | Four letter abbreviation of the city name as used by TPG Post; In capitals without punctuation marks. | gemeenteid | Webservices.nl identifier for the municipality. | gemeentenaam | Municipality name in capital letters. The municipality name does not contain apostrophes, but may contain dashes. Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”. | gemeentecode | Code given by the CBS (Centraal Bureau Statistiek). Range: ‘0’-’9999’ | cebucocode | Code given by CeBuCo (Centraal Bureau voor Courantenpubliciteit). Range: ‘0’-’999’ | provinciecode | Code of the province, a single letter | provincienaam | Official name of the province, correctly cased and with dashes where applicable. |
RangeAddressContains an address, indicated by the house number and the house number addition within a postcode range. reeks | A PCReeks for this result. | huisnr | The house number within the postcode range. Optional. | huisnr_toevoeging | The house number addition. Optional. |
DistrictInformation on a municipality (‘gemeente’). gemeenteid | Webservices.nl identifier for the municipality. | gemeentenaam | Municipality name in capital letters. The municipality name does not contain apostrophes, but may contain dashes. Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”. | gemeentecode | Code given by the CBS (Centraal Bureau Statistiek). Range: ‘0’-’9999’ | provinciecode | Code of the province, a single letter |
CityA single address city entry. Deprecated in favor of CityV2. plaatsid | Webservices.nl identifier for the city. | plaatsnaam | Official city name in accordance with the NEN 5825 standard. In capitals including punctuation marks. This field is at most 24 characters in length. Longer city names are shortened in accordance with the NEN 5825 standard. | plaatsnaam_ptt | City name in accordance with the PTT standard; In capitals. Maximum length of 18 characters. | plaatsnaam_extract | Four letter abbreviation of the city name as used by TPG Post; In capitals without punctuation marks. | gemeenteid | Webservices.nl identifier for the municipality. |
CityV2Information on a city, its municipality and its province. plaatsid | Webservices.nl identifier for the city. | plaatsnaam | Official city name in accordance with the NEN 5825 standard. In capitals including punctuation marks. This field is at most 24 characters in length. Longer city names are shortened in accordance with the NEN 5825 standard. | plaatsnaam_ptt | City name in accordance with the PTT standard; In capitals. Maximum length of 18 characters. | plaatsnaam_extract | Four letter abbreviation of the city name as used by TPG Post. In capitals without punctuation marks. | gemeenteid | Webservices.nl identifier for the municipality. | gemeentenaam | Municipality name in capital letters. The municipality name does not contain apostrophes, but may contain dashes. Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”. | gemeentecode | Code given by the CBS (Centraal Bureau Statistiek). Range: ‘0’-’9999’ | cebucocode | Code given by CeBuCo (Centraal Bureau voor Courantenpubliciteit). Range: ‘0’-’999’ | provinciecode | Code of the province, a single letter | provincienaam | Official name of the province, correctly cased and with dashes where applicable. |
ProvinceCode and name for a province (‘provincie’). provinciecode | Code of the province, a single letter | provincienaam | Official name of the province, correctly cased and with dashes where applicable. |
NeighborhoodA single postal neighborhoodcode entry. nbcode | postal neighborhoodcode, the first four numbers of the postcode. |
NeighborhoodNameA single postal neighborhoodcode and neighborhood name entry. nbcode | postal neighborhoodcode, the first four numbers of the postcode. | nbname | name of the neighborhood |
|