Skip to content

Releases: postcodeservice/api-postcodeservice-com-public

6.2.4

13 Mar 10:47
@schldwcht schldwcht
6.2.4
5504de1
Compare
Choose a tag to compare
6.2.4 Latest
Latest

🇳🇱 Netherlands

address-validation V6

  • Improvement: address-validation V6 NL will return all address function metadata when the house
    letter
    validation is on and an empty house letter is supplied. The response will combine all address
    function metadata information of
    the address objects that start with the same house number.

Before the improvement with an empty house letter and house letter validation turned on:

https://api.postcodeservice.com/nl/v6/address-validation?street=Kabelweg&zipcode=1014BA&house_number=21&house_letter=&house_letter_validation=1&city=Amsterdam

{
  "results": [
    {
      "street": "Kabelweg",
      "street_language": "nl",
      "street_id": "st_4876428982452",
      "house_number": 21,
      "house_letter": null,
      "house_letter_validated": true,
      "zipcode": "1014BA",
      "city": "Amsterdam",
      "municipality": "Amsterdam",
      "province": "Noord-Holland",
      "is_po_box": false,
      "is_on_wadden_islands": false,
      "address_function": [
        "unknown"
      ],
      "geo_precision": "rooftop",
      "latitude": 52.390515085771,
      "longitude": 4.8463724025161,
      "postal_address": {
        "line_1": "Kabelweg 21",
        "line_2": "1014BA AMSTERDAM",
        "line_3": "Netherlands"
      }
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "is_last_page": true
  }
}

After this improvement:

{
  "results": [
    {
      "street": "Kabelweg",
      "street_language": "nl",
      "street_id": "st_4876428982452",
      "house_number": 21,
      "house_letter": null,
      "house_letter_validated": true,
      "zipcode": "1014BA",
      "city": "Amsterdam",
      "municipality": "Amsterdam",
      "province": "Noord-Holland",
      "is_po_box": false,
      "is_on_wadden_islands": false,
      "address_function": [
        "accommodation",
        "multipurpose",
        "office",
        "storage"
      ],
      "geo_precision": "rooftop",
      "latitude": 52.390515085771,
      "longitude": 4.8463724025161,
      "postal_address": {
        "line_1": "Kabelweg 21",
        "line_2": "1014BA AMSTERDAM",
        "line_3": "Netherlands"
      }
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "is_last_page": true
  }
}
Assets 2
Loading

6.2.2

07 Mar 10:39
@schldwcht schldwcht
6.2.2
d033065
Compare
Choose a tag to compare
6.2.2

🇳🇱 Netherlands

New zipcode-find endpoint

  • Added new endpoint 'zipcode-find' to the Netherlands V6 API, which returns zipcode and city based
    on part of a zipcode or part of a city name.
  • This endpoint can be used to use address autocompletion in a uniform matter as the function is
    also available for the BE, DE and FR endpoints.

This is what the endpoint returns for a zipcode starting with 1014B..:

{
  "results": [
    {
      "zipcode": "1014BA",
      "city": "Amsterdam",
      "geo_precision": "geometric_center",
      "latitude": 52.395165076005,
      "longitude": 4.8463242519372
    },
    {
      "zipcode": "1014BB",
      "city": "Amsterdam",
      "geo_precision": "geometric_center",
      "latitude": 52.392131796179,
      "longitude": 4.8478134644369
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "results_per_page": 10,
    "is_last_page": false
  }
}

New street-find endpoint

  • Added new endpoint 'street-find' to the Netherlands V6 API, which returns all streets that meet
    the criteria zipcode, city name and part of a street name.
  • This endpoint can be used to use address autocompletion in a uniform matter as the function is
    also available for the BE, DE and FR endpoints.

This is what the endpoint returns when providing '1014BA' as zipcode, 'Amsterdam' as city and a
street starting with 'Kabel':

{
  "results": [
    {
      "street": "Kabelweg",
      "street_language": "nl",
      "street_id": "st_4876428982452"
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "results_per_page": 10,
    "is_last_page": true
  }
}

Developers documentation

  • Simplified Authentication requests documentation part.
  • Added maximum page limit value to the documentation.
  • Removed optional x-Domain header from documentation.

🐠 UX/UC improvements

  • Improved documentation page loading speed by optimizing underlying javascript code.

🐞 Fixed bugs

  • Fixed a bug where NL V6 Postbus data returns a single array instead of a multi array when only one
    item is found.
  • Fixed a bug for zipcode-find where some input characters were not accepted.
Assets 2
Loading

6.2.1

19 Feb 15:52
@schldwcht schldwcht
6.2.1
9e444db
Compare
Choose a tag to compare
6.2.1
  • Small code improvement for Belgium and Germany houseno-match endpoint.
  • Performance improvement for France address-suggestions endpoint.
  • For the Netherlands: Updated the street_id examples with the new street_id number sequence.
  • Added house_number_validation response to the French documentation where applicable.
Assets 2
Loading

6.1.6

07 Feb 16:35
@schldwcht schldwcht
6.1.6
938e53c
Compare
Choose a tag to compare
6.1.6

Developers documentation

  • Added example for multiple results for certain street & city combinations for NL
    address-streetcity.
  • Changed external CDN javascript library to increase initial loading speed.

🐞 Fixed bugs

  • Fixed a bug for the zipcode-find endpoints when entering a zipcode number that is not valid in
    some rare cases a 500 error is returned instead of the 429 error.
  • Fixed DE v2 in certain cases the zipcode returned an integer instead of string.
  • Fixed pagination number update bug for NL address-streetid, address-streetcity and NL
    zipcode-location.
Assets 2
Loading

6.1.3

30 Jan 09:14
@schldwcht schldwcht
6.1.3
8ccf4c6
Compare
Choose a tag to compare
6.1.3

Postcode Service API 6.1.3 Release

🇫🇷 France

New zipcode-find endpoint

  • Added zipcode-find endpoint. This endpoint expects a part of zipcode or city name and will
    return a list of matches.

New street-find endpoint

  • Added street-find endpoint. This endpoint needs a correct zipcode, city name and part of a
    street name. It will return all found matches.

Developers documentation

🐞 Fixed bugs

  • Fixed rare HTTP code 500 server response for users with Dutch legacy /json/ endpoint calls and
    the address is a P.O. box (Postbus).
  • Fixed pagination update bug in NL V6 address-validation endpoint.
Assets 2
Loading

6.1.0

22 Jan 10:11
@schldwcht schldwcht
6.1.0
6f913a8
Compare
Choose a tag to compare
6.1.0

Postcode Service API 6.1.0 Release

This is a major version release of the Postcode Service API containing new endpoints, features and
some UX/UC improvements.

🇳🇱 Netherlands

  • Added support for the latest Netherlands V6 API. This API is faster and more accurate than the
    previous V5 API. The Netherlands V5 API is still supported, but will be deprecated in the future.
  • Added geo precision to the Netherlands V6 API, which returns the geo precision of the address
    result. This can be used to determine the accuracy of the address result. The values can be
    approximate, geometric_center, rooftop, range_interpolated or unknown. See the documentation for
    more information: https://developers.postcodeservice.com/#netherlands-api
"geo_precision": "rooftop",
"latitude": 52.39267104872,
"longitude": 4.8465930696013,
  • Added address function information, which returns the function of the address result. The values
    can be accommodation, detention, education, healthcare, industry, multipurpose, office,
    residential, shop, sports, storage or unknown. See the documentation for more
    information see the response fields results
    array: https://developers.postcodeservice.com/#netherlands-api
"address_function": [
  "office"
],
  • Added postal label information, which returns the official accepted and preferred formatted of the
    postal label of the address result. For example:
"postal_address": {
                "line_1": "Kabelweg 21L",
                "line_2": "1014BA AMSTERDAM",
                "line_3": "Netherlands"
                  }

"is_postbus": false,
  • Added Wadden Eilanden indicator, which returns a boolean value indicating if the address is on
    one of the Wadden Eilanden. See the documentation for more
    information: https://developers.postcodeservice.com/#netherlands-api
  • This can be used to calulate a surplus shipping costs or extra delivery day for example.
"is_on_wadden_islands": false,

"municipality": "Amsterdam",
  • Added house letter validation, set by a boolean value. By default, the address is validated (based
    on the input parameters) except
    for the house letter. When set to true, the house letter will also be
    validated on official Government records. See the documentation for more
    information: https://developers.postcodeservice.com/#netherlands-api.
    Be careful when using this parameter, because it is prone to user error. For example: B and Bis,
    or I and 1 are not considered the same house letter. Also, user unofficial additions like 'hoek'
    or 'achter' will result in an 'address does not exist' response.

Example with house letter validation:

https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_number=21&house_letter=L&house_letter_validation=1&only_status=0&page=1&page_limit=10
  • The response data will contain a house_letter_validation field with a boolean value to make clear
    whether the house letter was validated or not.
"house_letter_validation": true,
  • Added only status parameter (only_status), set by a boolean value. When set to true, the response
    will only be a HTTP status code (204) or (418). Status 204 is returned when the address is found,
    418 when the
    address does not exist. This makes it possible to check if an address exists without having to
    parse the response data.

For example:

https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_number=21&house_letter=L&house_letter_validation=0&only_status=1&page=1&page_limit=10

New address-validation endpoint

  • This endpoint is a combination of the address-suggestions and address-streetid endpoints. It
    returns address details based on a zipcode, house number and house letter. This endpoint is
    faster and more accurate than the previous 'find' endpoint. In addition, the only_status parameter
    is added to this endpoint, which makes it possible to check if an address exists without having to
    parse the response data. Furthermore, the house_letter_validation parameter is added to this
    endpoint. This parameter is set by a boolean value. When set to true, the house letter will be
    validated.
  • The response data will contain the supplied paramaters for easy reference. See the documentation
    response fields for more
    information: https://developers.postcodeservice.com/#netherlands-api-GETnl-v6-address-validation

Older V5 address validation response (deprecated, but still supported):

https://developers.postcodeservice.com/deprecated/#deprecated-netherlands-api-GETnl-v5-find

{
  "street": "Kabelweg",
  "city": "Amsterdam",
  "region": "Noord-Holland",
  "residential": "no",
  "latitude": 52.39267104872,
  "longitude": 4.8465930696013
}

New V6 address validation response:

https://developers.postcodeservice.com/#netherlands-api-GETnl-v6-address-validation

{
  "results": [
    {
      "street": "Kabelweg",
      "street_language": "nl",
      "street_id": "st_81586623457798",
      "house_number": 21,
      "house_letter": "L",
      "house_letter_validated": false,
      "zipcode": "1014BA",
      "city": "Amsterdam",
      "municipality": "Amsterdam",
      "province": "Noord-Holland",
      "is_po_box": false,
      "is_on_wadden_islands": false,
      "address_function": [
        "office"
      ],
      "geo_precision": "rooftop",
      "latitude": 52.39267104872,
      "longitude": 4.8465930696013,
      "postal_address": {
        "line_1": "Kabelweg 21L",
        "line_2": "1014BA AMSTERDAM",
        "line_3": "Netherlands"
      }
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "results_per_page": 10,
    "is_last_page": true
  }
}

New address-suggestions endpoint

  • Added new endpoint 'address-suggestions' to the Netherlands V6 API, which returns a list of
    addresses based on a part of the streetname. This endpoint is faster and more accurate than the
    previous 'find' endpoint.
V6 address suggestions:
https://api.postcodeservice.com/nl/v6/address-suggestions?street=Kab&city=Amsterdam&page=1&page_limit=10

New address-streetid endpoint

  • Added new endpoint 'address-streetid' to the Netherlands V6 API, which returns details of an
    address based on a streetid. This endpoint can, but not required, used in combination with the '
    address-suggestions' endpoint to give a complete autocomplete experience to end-users.
V6 address suggestions:
https://api.postcodeservice.com/nl/v6/address-streetid?street_id=st_81586623457798&house_number=21&house_letter=L&house_letter_validation=0&only_status=0&page=1&page_limit=10

New address-streetcity endpoint

  • Added new endpoint 'address-streetcity' to the Netherlands V6 API, which returns details of an
    address based on a streetname and city. This endpoint can be used to do a reversed look-up when a
    user has the streetname, house number and city already.

Note that some Dutch addresses, like Beatrixstraat 1 in Rossum, may return multiple results due to
identical street and identical city names. To validate a unique address, use the
address-validation
endpoint, as each zipcode with a house number is unique in the Netherlands. See the
documentation https://developers.postcodeservice.com/#netherlands-api-GETnl-v6-address-streetcity.
This endpoint is more accurate because of the multiple results feature in edge cases as the above
than other reversed
look-up services on the market.

Changed zipcode-location endpoint

Old V5:

{
  "latitude": 52.395421328766,
  "longitude": 4.8463096822221
}

New V6:

{
  "results": [
    {
      "zipcode": "1014BA",
      "province": "Noord-Holland",
      "is_on_wadden_islands": false,
      "geo_precision": "geometric_center",
      "latitude": 52.395421328766,
      "longitude": 4.8463096822221
    }
  ],
  "error_code": null,
  "errors": [],
  "pagination": {
    "current_page": 1,
    "results_per_page": 10,
    "is_last_page": true
  }
}

🇧🇪 Belgium

Added V4 support for Belgium. The V3 API is still supported, but will be deprecated in the future.
Version 4 introduces the new uniform API structure and new features like pagination, geo precision,
house letter validation and only status. See the documentation for more information:
https://developers.postcodeservice.com/#belgium-api-GETbe-v4-address-validation

In particular, the Belgium Postal address label is added to the response data including the for
Belgium specific bus field besides the house letter field.

"postal_address": {
"line_1": "Aalststraat 2A bus 10",
"line_2": "9000 OUDENAARDE",
"line_3": "Belgium"
}

In addition, the following new endpoints are added:

New address-validation endpoint

This endpoint is a combination of the address-suggestions and address-streetid endpoints. It
returns address details based on a zipcode, house number and house letter. This endpoint is
faster and more ac...

Read more
Assets 2
Loading