1- # Postcode Service API 6.1.0 Release
1+ # Postcode Service API - Latest release notes version 6
22
33This is a major version release of the Postcode Service API containing new endpoints, features and
44some UX/UC improvements.
@@ -317,6 +317,44 @@ address details based on a zipcode, house number and house letter.
317317See the documentation for more information:
318318https://developers.postcodeservice.com/#germany-api-GETde-v2-address-validation
319319
320+ ``` json
321+ {
322+ "results" : [
323+ {
324+ "street" : " Tucherweg" ,
325+ "street_language" : " de" ,
326+ "street_id" : " st_407247266946847986" ,
327+ "house_number" : 48 ,
328+ "house_letter" : " A" ,
329+ "house_letter_validated" : false ,
330+ "house_number_addition" : " treppe 1" ,
331+ "zipcode" : 40724 ,
332+ "city" : " Hilden" ,
333+ "is_po_box" : false ,
334+ "address_function" : [
335+ " unknown"
336+ ],
337+ "geo_precision" : " rooftop" ,
338+ "latitude" : 51.1722206 ,
339+ "longitude" : 6.9403854 ,
340+ "postal_address" : {
341+ "line_1" : " Tucherweg 48A treppe 1" ,
342+ "line_2" : " 40724 HILDEN" ,
343+ "line_3" : " Germany"
344+ }
345+ }
346+ ],
347+ "error_code" : null ,
348+ "errors" : [],
349+ "pagination" : {
350+ "current_page" : 1 ,
351+ "results_per_page" : 10 ,
352+ "is_last_page" : true
353+ }
354+ }
355+
356+ ```
357+
320358### New address-suggestions endpoint
321359
322360Added new endpoint 'address-suggestions' to the Germany V2 API, which returns a list of addresses
@@ -326,6 +364,34 @@ autocomplete experience.
326364See the documentation for more information:
327365https://developers.postcodeservice.com/#germany-api-GETde-v2-address-suggestions
328366
367+ ``` json
368+ {
369+ "results" : [
370+ {
371+ "street" : " Marbacher Berg" ,
372+ "street_language" : " de" ,
373+ "street_id" : " st_993342231655576189" ,
374+ "zipcode" : 99334 ,
375+ "city" : " Amt Wachsenburg"
376+ },
377+ {
378+ "street" : " Marbacher Chaussee" ,
379+ "street_language" : " de" ,
380+ "street_id" : " st_990928511797344426" ,
381+ "zipcode" : 99092 ,
382+ "city" : " Erfurt"
383+ }
384+ ],
385+ "error_code" : null ,
386+ "errors" : [],
387+ "pagination" : {
388+ "current_page" : 1 ,
389+ "results_per_page" : 10 ,
390+ "is_last_page" : true
391+ }
392+ }
393+ ```
394+
329395### New address-streetid endpoint
330396
331397Added new endpoint 'address-streetid' to the Germany V2 API, which returns details of an address
@@ -335,6 +401,43 @@ give a complete autocomplete experience to end-users.
335401See the documentation for more information:
336402https://developers.postcodeservice.com/#germany-api-GETde-v2-address-streetid
337403
404+ ``` json
405+ {
406+ "results" : [
407+ {
408+ "street" : " Tucherweg" ,
409+ "street_language" : " de" ,
410+ "street_id" : " st_407247266946847986" ,
411+ "house_number" : 48 ,
412+ "house_letter" : " A" ,
413+ "house_letter_validated" : false ,
414+ "house_number_addition" : " treppe 1" ,
415+ "zipcode" : 40724 ,
416+ "city" : " Hilden" ,
417+ "is_po_box" : false ,
418+ "address_function" : [
419+ " unknown"
420+ ],
421+ "geo_precision" : " rooftop" ,
422+ "latitude" : 51.1722206 ,
423+ "longitude" : 6.9403854 ,
424+ "postal_address" : {
425+ "line_1" : " Tucherweg 48A treppe 1" ,
426+ "line_2" : " 40724 HILDEN" ,
427+ "line_3" : " Germany"
428+ }
429+ }
430+ ],
431+ "error_code" : null ,
432+ "errors" : [],
433+ "pagination" : {
434+ "current_page" : 1 ,
435+ "results_per_page" : 10 ,
436+ "is_last_page" : true
437+ }
438+ }
439+ ```
440+
338441### Changes to the existing zipcode-find endpoint
339442
340443The zipcode-find endpoint is expanded with geo precision field.
@@ -483,6 +586,68 @@ all the additions are in lower case.
483586 }
484587```
485588
589+ ### New zipcode-find endpoint
590+
591+ - Added ` zipcode-find ` endpoint. This endpoint expects a part of zipcode or city name and will
592+ return a list of matches.
593+
594+ See https://developers.postcodeservice.com/#french-api-GETfr-v1-zipcode-find
595+
596+ ``` json
597+ {
598+ "results" : [
599+ {
600+ "zipcode" : " 01000" ,
601+ "city" : " Bourg-en-Bresse" ,
602+ "geo_precision" : " geometric_center" ,
603+ "latitude" : 46.202836199928 ,
604+ "longitude" : 5.23269573883
605+ },
606+ {
607+ "zipcode" : " 01000" ,
608+ "city" : " Saint-Denis-lès-Bourg" ,
609+ "geo_precision" : " geometric_center" ,
610+ "latitude" : 46.202687320372 ,
611+ "longitude" : 5.1976543021978
612+ }
613+ ],
614+ "error_code" : null ,
615+ "errors" : [],
616+ "pagination" : {
617+ "current_page" : 1 ,
618+ "results_per_page" : 10 ,
619+ "is_last_page" : true
620+ }
621+ }
622+ ```
623+
624+ ### New street-find endpoint
625+
626+ - Added ` street-find ` endpoint. This endpoint needs a correct zipcode, city name and part of a
627+ street name. It will return all found matches.
628+
629+ See https://developers.postcodeservice.com/#french-api-GETfr-v1-street-find
630+
631+ ``` json
632+ {
633+ "results" : [
634+ {
635+ "street" : " Allée Bièvre" ,
636+ "street_language" : " fr" ,
637+ "street_id" : " st_10009533927221583"
638+ }
639+ ],
640+ "error_code" : null ,
641+ "errors" : [],
642+ "pagination" : {
643+ "current_page" : 1 ,
644+ "results_per_page" : 10 ,
645+ "is_last_page" : true
646+ }
647+ }
648+
649+ ```
650+
486651## 🍰 Overall improvements
487652
488653### Pagination
@@ -742,10 +907,11 @@ https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_nu
742907* We have added links to the System status https://postcodeservice.statuspage.io/ and release
743908 history pages (here, yeah).
744909* The Postman Collection has been updated to reflect the new API structure and new features
745- at https://developers-staging .postcodeservice.com/collection.json
910+ at https://developers.postcodeservice.com/collection.json
746911* The Netherlands V1, V2 and V3 legacy documentation is added to the deprecated endpoints
747912 documentation with this release for reference purposes. Speaking about Marty McFly, we are going
748913 back to the future with this V1..V3 added documentation.
914+ * Added P.O. box example in the documentation for NL V6 endpoint.
749915
750916## 🐠 UX/UC improvements
751917
@@ -766,6 +932,9 @@ https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_nu
766932- Fixes in German data for villages that are on the border where some street names were also
767933 available in Chech language.
768934- Cleaned up Belgium redundant street names in the data with human error mistyped street names.
935+ - Fixed rare HTTP code 500 server response for users with Dutch legacy /json/ endpoint calls and
936+ the address is a postbus.
937+ - Fixed pagination update bug in NL V6 endpoint.
769938
770939## ✨ Behind the scenes
771940
@@ -783,5 +952,6 @@ https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_nu
783952
784953## 🐰 Release credits
785954
786- - Thanks go out to the following external people for contributing to this release: Peter S. and Tim S.,
955+ - Thanks go out to the following external people for contributing to this release: Peter S. and Tim
956+ S.,
787957 Viktoria S.
0 commit comments