Address

This 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.
List all 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.
Deprecated, use addressPerceelFullParameterSearchV2 instead
Deprecated, use addressCitySearchV2 instead
Deprecated, use addressReeksFullParameterSearch instead
Deprecated, use addressPerceelPhraseSearch instead
This method is deprecated, use addressReeksPostcodeSearch instead
Deprecated, use addressCitySearchV2 instead
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 methods

These 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.

addressReeksPostcodeSearch

Determine if a specific address exists using the unique ‘1234AA12’ postcode + house number format.  If returns either the address in PCReeks format, or an error if no matching address exists.  If you want to validate an address not using this unique identifier, use addressReeksAddressSearch or addressReeksFullParameterSearch.

Parameters

addressAddress to validate using the unique ‘1234AA12’ postcode house number format.

Returns

outA PCReeks structure.

See also

addressReeksAddressSearch, addressReeksFullParameterSearch

addressReeksAddressSearch

Search 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.

Parameters

addressStreet, house number and house number addition of the searched address.  Required.
postcodePostcode in 1234AA format.  Optional.
cityPhrase used to select the city of the address, see PCReeks.plaatsnaam.  Optional.
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of RangeAddress entries.

See also

addressReeksPostcodeSearch, addressReeksFullParameterSearch

addressReeksFullParameterSearch

Search for addresses in the PCReeks format, using different search phrases for each address part.

Parameters

provincePhrase to search for in province name, or code of the province.  See PCReeks.provincienaam and PCReeks.provinciecode
districtPhrase used to select the municipality of the address, see PCReeks.gemeentenaam
cityPhrase used to select the city of the address, see PCReeks.plaatsnaam
streetPhrase used to select the street of the address, see PCReeks.straatnaam
houseNoNumber used to select the house number of the address, see PCReeks.huisnr_van
houseNoAdditionPhrase used to select the house number addition of the address
nbcodeNumber used to select the neighborhoodcode of the address, the first four numbers of the postcode.  See PCReeks.wijkcode
lettercombinationPhrase used to select the lettercombination of the address, the last two letters of the postcode.  See PCReeks.lettercombinatie
addresstypePhrase used to select the addresstype of the address, see PCReeks.reeksindicatie
pagePage to retrieve, pages start counting at 1

Returns

outA PCReeksSearchPartsPagedResult.

See also

addressReeksAddressSearch, addressReeksPostcodeSearch

addressReeksParameterSearch

Search for addresses in the PCReeks format, using different search phrases for each address part.

Notice

addressReeksFullParameterSearch allows more parameters to search.

Parameters

provincePhrase to search for in province name, or code of the province.  See PCReeks.provincienaam and PCReeks.provinciecode
districtPhrase used to select the municipality of the address, see PCReeks.gemeentenaam
cityPhrase used to select the city of the address, see PCReeks.plaatsnaam
streetPhrase used to select the street of the address, see PCReeks.straatnaam
houseNoNumber used to select the house number of the address, see PCReeks.huisnr_van
houseNoAdditionPhrase used to select the house number addition of the address
pagePage to retrieve, pages start counting at 1

Returns

outA PCReeksSearchPartsPagedResult.

See also

addressReeksFullParameterSearch, addressReeksPostcodeSearch

addressPerceelPhraseSearch

Search 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 matches

PO 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 phrases

postcode, house number1188 VP, 202bis
postcode1188 VP
neighborhood code1188
city, addressAmstelveen, Amsteldijk Zuid 202bis
address, cityAmsteldijk Zuid 202bis, Amstelveen
city, streetAmstelveen, Amsteldijk Zuid
addressAmsteldijk Zuid 202bis

Parameters

addressAddress phrase to search for in addresses
pagePage to retrieve, pages start counting at 1

Returns

outA PerceelSearchPartsPagedResult.

See also

addressPerceelFullParameterSearchV2

addressPerceelFullParameterSearchV2

Search 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 matches

See Perceel for information on how PO box matches are returned.

Parameters

provincePhrase used to select the province of the address, see Perceel.provincienaam
districtPhrase used to select the municipality of the address, see Perceel.gemeentenaam
cityPhrase used to select the city of the address, see Perceel.plaatsnaam
streetPhrase used to select the street of the address, see Perceel.straatnaam
houseNoNumber used to select the house number of the address, see Perceel.huisnr
houseNoAdditionPhrase used to select the house number addition of the address, see Perceel.huisnr_toevoeging
nbcodeNumber used to select the neighborhoodcode of the address, the first four numbers of the postcode.  See Perceel.wijkcode
lettercombinationPhrase used to select the lettercombination of the address, the last two letters of the postcode.  See Perceel.lettercombinatie
addresstypePhrase used to select the addresstype of the address, see Perceel.reeksindicatie
pagePage to retrieve, pages start counting at 1

Returns

outA PerceelSearchPartsPagedResult.

See also

addressPerceelPhraseSearch

Region search methods

addressProvinceListNeighborhoods

Returns a list of all neighborhood codes in the province

Parameters

nameName or code of the province
postbusBoolean indicating whether Postbus neighborhood codes should be included in the result
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of Neighborhood entries.

addressProvinceListDistricts

List all municipalities in a specific provinces.

Parameters

nameName or code of the province to list the municipalities from
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of District entries.

addressProvinceList

List all provinces.

Parameters

pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of Province entries.

addressProvinceSearch

Search for all provinces that match a phrase.

Parameters

namePhrase to search for in the province names, or the province code.
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of Province entries.

addressDistrictSearch

Search for all municipalities that match a phrase.

Parameters

namePhrase to search municipalities for, or the numeric identifier for the municipality.
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of District entries.

addressDistrictListCities

List all cities in specific municipalities

Parameters

namePhrase to search municipalities for, or the numeric identifier for the municipality.
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of City entries.

addressDistrictListNeighborhoods

Returns a list of all neighborhood codes in the municipality.

Parameters

nameName or identifier of the municipality
postbusBoolean indicating whether Postbus neighborhood codes should be included in the result
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of Neighborhood entries.

addressCitySearchV2

Search 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.

Parameters

namePhrase to search cities for, or the numeric identifier for the city.
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of CityV2 entries.

addressCityListNeighborhoods

Returns a list of all neighborhood codes in the city

Parameters

nameName or identifier of the city
postbusBoolean indicating whether Postbus neighborhood codes should be included in the result
pagePage to retrieve, pages start counting at 1

Returns

outA Patterns::{Type}PagedResult of Neighborhood entries.

Deprecated address search methods

The 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

Deprecated, use addressPerceelFullParameterSearchV2 instead

addressPerceelParameterSearch

addressCitySearch

Deprecated, use addressCitySearchV2 instead

addressPhraseSearch

addressParameterSearch

Deprecated, use addressReeksFullParameterSearch instead

addressReeksPhraseSearch

perceelPhraseSearch

Deprecated, use addressPerceelPhraseSearch instead

addressPostcodeSearch

Notice

This method is deprecated, use addressReeksPostcodeSearch instead

Determine if a specific address exists using the unique ‘1234AB12’ postcode house number format.  If returns either the address in PCReeks format, or an error if no matching address exists.  If you want to validate an address not using this unique identifier, use addressReeksAddressSearch or addressReeksFullParameterSearch.

Parameters

addressAddress to validate using the unique ‘1234AB12’ postcode house number format.

Returns

outA PCReeks structure.

See also

addressReeksPostcodeSearch

citySearch

Deprecated, use addressCitySearchV2 instead

Type definitions

NOTICE: 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!

PCReeks

A 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.

reeksidWebservices.nl identifier for this house number range.
huisnr_vanLowest house number of a postcode range.  Range: 0-99999
huisnr_tmHighest house number of a postcode range.  Range: 0-99999
wijkcodeFour number neighborhoodcode (first part of a postcode).  Range: ‘1000’-’9999’
lettercombinatieTwo character lettercombination (second part of a postcode).  Range: ‘AA’-’ZZ’
reeksindicatiePostcode range type.  Range: {‘0’,’1’,’ ‘};
’0’range of odd house numbers,
’1’range of even house numbers,
’ ‘vacant
straatidWebservices.nl identifier for the street.
straatnaamStreet 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_nenStreet 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_pttStreet 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_extract5 letter abbreviation of the street name as used by TPG Post.  In capitals without punctuation marks.
plaatsidWebservices.nl identifier for the city.
plaatsnaamOfficial 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_pttCity name in accordance with the PTT standard.  In capitals.  Maximum length of 18 characters.
plaatsnaam_extractFour letter abbreviation of the city name as used by TPG Post.  In capitals without punctuation marks.
gemeenteidWebservices.nl identifier for the municipality.
gemeentenaamMunicipality name in capital letters.  The municipality name does not contain apostrophes, but may contain dashes.  Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”.
gemeentecodeCode given by the CBS (Centraal Bureau Statistiek).  Range: ‘0’-’9999’
cebucocodeCode given by CeBuCo (Centraal Bureau voor Courantenpubliciteit).  Range: ‘0’-’999’
provinciecodeCode of the province, a single letter.
provincienaamOfficial name of the province, correctly cased and with dashes where applicable.

PCReeksSearchPartsPagedResult

A structure with at most one page of PCReeks entries.

extraA SearchParts structure with the address information which was used for the search.
pagingA Patterns::ResultInfo structure with information about the number of results.
resultsA Patterns::{Type}Array of type PCReeks, with the address information resulting from this search.

PerceelSearchPartsPagedResult

A structure with at most one page of Perceel entries.

extraA SearchParts structure with the address information which was used for the search.
pagingA Patterns::ResultInfo structure with information about the number of results.
resultsA Patterns::{Type}Array of type Perceel, with the address information resulting from this search.

SearchParts

The 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.

huisnrHouse number.
toevoegingAddition of the house number to uniquely define a location.
wijkcodeFour number neighborhoodcode (first part of a postcode).  Range: ‘1000’-’9999’
lettercombinatieTwo character lettercombination (second part of a postcode).  Range: ‘AA’-’ZZ’
straatStreet name.
plaatsCity name.
gemeenteMunicipality
provincieProvince.
reeksindicatiePostcode range type.  Range: {‘0’,’1’,’ ‘};
’0’range of odd house numbers,
’1’range of even house numbers,
’ ‘vacant

Perceel

A single address parcel (‘perceel’) entry.  Unlike PCReeks, a parcel specifies an existing address with house number and possible house number addition.

PO box matches

Of 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.

perceelidWebservices.nl identifier for this parcel.
huisnrHouse number of a perceel.  In case of a Postbus match the house number will always be 0.  Range: 0-99999
huisnr_toevoegingAddition of the house number to uniquely define a location.  These additions are officially recognized by the municipality.
perceelnummerUnique number for a perceel / delivery point, assigned by TPG.  In case of a Postbus address match perceelnummer will always be 0.
reeksidWebservices.nl identifier for this house number range.
huisnr_vanLowest house number of a postcode range.  Range: 0-99999
huisnr_tmHighest house number of a postcode range.  Range: 0-99999
wijkcodeFour number neighborhoodcode (first part of a postcode).  Range: ‘1000’-’9999’
lettercombinatieTwo character lettercombination (second part of a postcode).  Range: ‘AA’-’ZZ’
reeksindicatiePostcode range type.  Range: {‘0’,’1’,’ ‘};
’0’range of odd house numbers,
’1’range of even house numbers,
’ ‘vacant
straatidWebservices.nl identifier for the street.
straatnaamStreet 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_nenStreet 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_pttStreet 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_extract5 letter abbreviation of the street name as used by TPG Post; In capitals without punctuation marks.
plaatsidWebservices.nl identifier for the city.
plaatsnaamOfficial 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_pttCity name in accordance with the PTT standard; In capitals.  Maximum length of 18 characters.
plaatsnaam_extractFour letter abbreviation of the city name as used by TPG Post; In capitals without punctuation marks.
gemeenteidWebservices.nl identifier for the municipality.
gemeentenaamMunicipality name in capital letters.  The municipality name does not contain apostrophes, but may contain dashes.  Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”.
gemeentecodeCode given by the CBS (Centraal Bureau Statistiek).  Range: ‘0’-’9999’
cebucocodeCode given by CeBuCo (Centraal Bureau voor Courantenpubliciteit).  Range: ‘0’-’999’
provinciecodeCode of the province, a single letter
provincienaamOfficial name of the province, correctly cased and with dashes where applicable.

RangeAddress

Contains an address, indicated by the house number and the house number addition within a postcode range.

reeksA PCReeks for this result.
huisnrThe house number within the postcode range.  Optional.
huisnr_toevoegingThe house number addition.  Optional.

District

Information on a municipality (‘gemeente’).

gemeenteidWebservices.nl identifier for the municipality.
gemeentenaamMunicipality name in capital letters.  The municipality name does not contain apostrophes, but may contain dashes.  Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”.
gemeentecodeCode given by the CBS (Centraal Bureau Statistiek).  Range: ‘0’-’9999’
provinciecodeCode of the province, a single letter

City

A single address city entry.

Deprecated in favor of CityV2.

plaatsidWebservices.nl identifier for the city.
plaatsnaamOfficial 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_pttCity name in accordance with the PTT standard; In capitals.  Maximum length of 18 characters.
plaatsnaam_extractFour letter abbreviation of the city name as used by TPG Post; In capitals without punctuation marks.
gemeenteidWebservices.nl identifier for the municipality.

CityV2

Information on a city, its municipality and its province.

plaatsidWebservices.nl identifier for the city.
plaatsnaamOfficial 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_pttCity name in accordance with the PTT standard; In capitals.  Maximum length of 18 characters.
plaatsnaam_extractFour letter abbreviation of the city name as used by TPG Post.  In capitals without punctuation marks.
gemeenteidWebservices.nl identifier for the municipality.
gemeentenaamMunicipality name in capital letters.  The municipality name does not contain apostrophes, but may contain dashes.  Examples: “BAARLE-NASSAU”, “S GRAVENHAGE”.
gemeentecodeCode given by the CBS (Centraal Bureau Statistiek).  Range: ‘0’-’9999’
cebucocodeCode given by CeBuCo (Centraal Bureau voor Courantenpubliciteit).  Range: ‘0’-’999’
provinciecodeCode of the province, a single letter
provincienaamOfficial name of the province, correctly cased and with dashes where applicable.

Province

Code and name for a province (‘provincie’).

provinciecodeCode of the province, a single letter
provincienaamOfficial name of the province, correctly cased and with dashes where applicable.

Neighborhood

A single postal neighborhoodcode entry.

nbcodepostal neighborhoodcode, the first four numbers of the postcode.

NeighborhoodName

A single postal neighborhoodcode and neighborhood name entry.

nbcodepostal neighborhoodcode, the first four numbers of the postcode.
nbnamename of the neighborhood
A single address range (‘reeks’) entry.
A single address parcel (‘perceel’) entry.
Search for addresses in the Perceel format, using different search phrases for each address part.
Search for addresses in the Perceel format, using a single search phrase.
Search for all cities that match a phrase.
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.
Determine if a specific address exists using the unique ‘1234AA12’ postcode + house number format.
Contains an address, indicated by the house number and the house number addition within a postcode range.
A structure that shows a page of a specific result type {Type}.
A structure with at most one page of PCReeks entries.
A structure with at most one page of Perceel entries.
A single postal neighborhoodcode entry.
Information on a municipality (‘gemeente’).
Code and name for a province (‘provincie’).
A single address city entry.
Information on a city, its municipality and its province.
The query which was searched for, split into separate parts.
Information about a specific page result.
An array of type {Type} entries.