This is the Authorization key. You have to add it as a GET parameter.
Your auth key can be found on the [CMS](https://www.pro6pp.nl/cms).


authKey

API Support

# Introduction
This API is documented in **OpenAPI format**.
In addition to standard OpenAPI syntax we use a few
[vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
This API replaces our [v1 legacy API](https://pro6pp.nl/docs/v1) over time. See the [API deprecation](https://www.pro6pp.nl/en/developer/deprecation) about support durations.
NOTE: All calls currently work with and without a trailing /. It is recommended to use no trailing backslash, trailing backslashes might be deprecated in the future.
# Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
And that allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
# Authentication
Pro6PP's security is based on an authorization key.
You have to supply the query parameter 'authKey' to request data from the API.
<SecurityDefinitions />


Pro6PP v2 API

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-AT) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which consists of four digits


postalCode

Austrian postalCode

The address's settlement (city, town, village, or hamlet)


settlement

street

streetNumber

The address's streetnumber and premise (extension/addition)


streetNumberAndPremise

premise

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-BE) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned. The default street, settlement,
province will be in the language spoken for that region. E.g: For
settlement, province and region in Flanders the default is Dutch.
In Wallonia the default language spoken is French, except for German
speaking parts where the default is German.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which can be up to four digits long


Belgium postalCode

The box identifier, excluding any prefixes such as "box", "bus", "bte", or "boîte". If provided, these prefixes will be automatically removed.


In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-CH) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


Swiss postalCode

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-DE) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which can be up to five digits long


German postalCode

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-DK) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


Danish postalCode

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-FR) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


The address's postal code which consists of five digits


French postalCode

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-LU) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.


Luxembourg postalCode

In case you don't know all of the required parameters, you can use the [suggest](#tag/Suggest-NL) call to gather them first.

If the input identifies a unique address, all available information
about said address is returned.

* To validate if an address has either a streetNumber or a Premise, query through the `streetNumberAndPremise` field.
* To validate if an address exists with a certain streetnumber, use the `streetNumber` field.
* To validate if an address exists with a certain premise, use both the `streetNumber` and `premise` fields.
* Either `streetNumberAndPremise` or `streetNumber` is required. If both are given, only `streetNumber` is used.

The specials subscription offers extra return fields these are:

* BAG_NUM_ID
* BAG_OPR_ID
* BAG_PND_ID
* BAG_VBO_ID
* BAG_TYPE
* neighbourhood
* district
* plotSize


The address's postal code in sixpp format (1000AA)


Dutch postalCode

Given a start and destination postcode, return the distance between them. If the road algorithm is selected this distance will be over the road (meters) and includes car drive time (minutes).

The given postcodes should be 4 digits long.


toPostalCode

A sixpp or a fourpp to start calculating from.


fromPostalCode

algorithm: Choose an algorithm. road to calculate the actual traveling distance and time over actual roads, or straight to obtain the distance in a straight line.
Any subscription allows access to the straight line distance, however the road algorithm uses the drive time matrix (shortest route) that requires a ’development agency’ or higher subscription level when used through the API.
For trial purposes, a range of postcodes is allowed with any subscription level: 4146 (Hochwald), 4147 (Aesch), 4148 (Pfeffingen).


algorithm

Given a start and destination postcode, return the distance between them. If the road algorithm is selected this distance will be over the road (meters) and includes car drive time (minutes).

The given postcodes should either be both fourpps or sixpps.

You can use the more precise sixpp postcode format only for postcodes within a 5000 meter distance. If we'd keep a bigger lookup table, the storage requirements would be too high. Revert to a fourpp postcode format for the bigger distances. That shouldn't be a problem as precision should matter less when postcodes are apart much further.


algorithm: Choose an algorithm. road to calculate the actual traveling distance and time over actual roads, or straight to obtain the distance in a straight line.
Any subscription allows access to the straight line distance, however the road algorithm uses the drive time matrix (shortest route) that requires a ’development agency’ or higher subscription level when used through the API.
For trial purposes, a range of postcodes is allowed with any subscription level: 1000..1098, 1100..1108 (Amsterdam), 3000..3089 (Rotterdam), 5600..5658 (Eindhoven).


This will remove a feedback item for the user calling


The partial postalCode contains at least 1 digit.


Partial postalCode

This will list all BE feedback items for the user calling


This will add a streetnumber to the database for later use by the user


latitude

longitude

claim

The address's municipality (only needed when there are multiple settlements by the same name to differentiate)


municipality

The address's province (only needed when there are multiple settlements having the same municipality name, so there's a province needed to differentiate)


province

region

This will list all CH feedback items for the user calling


district

canton

This will list all DE feedback items for the user calling


state

This will list all FR feedback items for the user calling


commune

department

The address's settlement (city, town, village)


This will list all LU feedback items for the user calling


The address's street number. When adding 'Postbus' feedback if the street number is not known, then a street number in the defined range should be added.


This will list all NL feedback items for the user calling


This will add a postbus or a street number (with or without addition) to the database for later use by the user.
If the street name is "Postbus" then it is known that the feedback call is used for adding a Postbus entry.
Otherwise, it is assumed that a street number (with or without addition) is going to be added.


This will remove a feedback item for the user calling.


This will list all NL postal code feedback items for the user calling


This will add a postal code to the database for later use by the user.


Given a postcode or lat/lng combination and your own list of postcodes returns the postcodes ordered from near to far.


An array of postcodes (e.g: [01906, 01909, 01917])


targetPostalCodes

The Postcode(e.g: 01906), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.


The order in which to return the results:
  distance (default)
  **input (keeps the input ordering)
  **postalcode (order by the postalcode)

  ** not yet supported


orderBy

The amount of results returned, a number between 0 and 999.


maxResults

algorithm: Choose an algorithm. road to calculate the actual traveling distance and time over actual roads, or straight to obtain the distance in a straight line.
Any subscription allows access to the straight line distance, however the road algorithm uses the drive time matrix (shortest route) that requires a ’development agency’ or higher subscription level when used through the API.


Given a postcode or lat/lng combination and your own list of postcodes returns the postcodes ordered from near to far.sss


An array of postcodes (e.g: [4340, 4350, 4390])


The Postcode(e.g: 4340), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.


An array of postcodes (e.g: [01090, 01000, 01100])


The Postcode(e.g: 01090), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.


An array of 4PPs(e.g: [1111, 1112, 1113])


The Postcode(e.g: 1110), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.


An array of 4PPs(e.g: [1000, 1011, 1012])


The 4PP(e.g: 1000), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.


Dutch fourppOrSixpp

This will return all postal codes within a range of a given postal code or city.

* Either the `postalCode` or `settlement` is required


The range to search, in meters. Maximum 100000.


searchRange

Option whether to include the initial postal code in /v2/range calls. If the value is True, then the initial postal code is included in the search.


includeInitialPostalCode

Either the fourpp (e.g: 1000) or the sixpp (e.g: 1000AA) notation.


The precision for the returned results. Either sixpp or fourpp


precision

This will give an address based on the latitude and longitude


The precision to search either street or streetnumber


This will give autocomplete suggestions for Austria postal codes.


The page to return, the variables for the next/previous pages can be found in the results Link header.


cursor

This will give autocomplete suggestions for Austria settlements.


This will give autocomplete suggestions for Austrian streets.


This will give autocomplete suggestions for Austrian street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Belgian post boxes.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Belgian postal codes.


This will give autocomplete suggestions for Belgian premises.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Belgian settlements.
Settlements will be returned based on postnames, postnames are (unofficial) cities within a settlement, e.g: Laken is a postname in Brussel.


When specified, this ISO 639-1 language code determines in which language the accompanied input filters will be applied. It does not affect the output languages. When unspecified, input filters are applied to all languages.


languageCode

This will give autocomplete suggestions for Belgian streets.


This will give autocomplete suggestions for Belgian streetnumbers.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Belgian
streetnumber and premise (extension/addition).

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Swedish postal codes.


This will give autocomplete suggestions for Swedish settlements.


This will give autocomplete suggestions for Swiss streets.


This will give autocomplete suggestions for Swiss street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for postal codes.


This will give autocomplete suggestions for premises.


This will give autocomplete suggestions for settlements.


This will give autocomplete suggestions for streets.


This will give autocomplete suggestions for streetnumbers.


This will give autocomplete suggestions for German
streetnumber and premise (extension/addition).


This will give autocomplete suggestions for Danish postal codes.


This will give autocomplete suggestions for Danish settlements.


This will give autocomplete suggestions for Danish streets.


This will give autocomplete suggestions for Danish street numbers.
Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French postal codes.


This will give autocomplete suggestions for French premises.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French settlements.


This will give autocomplete suggestions for French streets.


This will give autocomplete suggestions for French streetnumbers.

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for French
streetnumber and premise (extension/addition).

Only street is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Luxembourg postal codes.


This will give autocomplete suggestions for Luxembourg premises.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Luxembourg settlements.


This will give autocomplete suggestions for Luxembourg streets.


This will give autocomplete suggestions for Luxembourg streetnumbers.

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`


This will give autocomplete suggestions for Luxembourg
streetnumber and premise (extension/addition).

Only the `street` parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `settlement`

A request cannot be only a streetNumberAndPremise


This will give autocomplete suggestions for premises.

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`


This will give autocomplete suggestions for streetnumbers.

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`


This will give autocomplete suggestions for Dutch
streetnumber and premise (extension/addition).

No specific parameter is required but a call must contain at least one of the following parameters:
* `postalCode`
* `street` and `settlement`
