Kody Pocztowe API

Darmowe API pozwalające pobrać adres przy użyciu kodu pocztowego Poczty Polskiej.

Wspierane formaty odpowiedzi:

application/json - format JSON (domyślny format)
application/xml - format XML
text/plain - format tekstowy

Użycie:

Pobranie informacji o kodzie pocztowym:

http: GET http://kodpocztowy.intami.pl/api/KOD

W miejsce KOD wpisz kod pocztowy w formacie xx-xxx.
Ustaw nagłówek Accept na wybrany format odpowiedzi.

W odpowiedzi zwrócone zostaną informacje opiane w opis pól.

Przykład:
curl -H 'Accept:application/json' 'http://kodpocztowy.intami.pl/api/01-111'
Pobranie kodów pocztowych przypisanych do miasta:

http: GET http://kodpocztowy.intami.pl/city/MIASTO

W miejsce MIASTO wpisz nazwę miasta.
Ustaw nagłówek Accept na wybrany format odpowiedzi.

W odpowiedzi zwrócona lista kodów pocztowych przypisanych do miasta.
Uwaga: Jeśli istnieje więcej niż jedno miasto o tej nazwie to zostaną zwrócne kody ze wszystkich miast.

Przykład:
curl -H 'Accept:application/json' 'http://kodpocztowy.intami.pl/city/Wrocław'
Pobranie kodów pocztowych przypisanych do dzielnicy miasta:

http: GET http://kodpocztowy.intami.pl/city/MIASTO/district/DZIELNICA

W miejsce MIASTO wpisz nazwę miasta, a w miejsce DZIELNICA nazwę dzielnicy.
Ustaw nagłówek Accept na wybrany format odpowiedzi.

W odpowiedzi zwrócona lista kodów pocztowych przypisanych do dzielnicy miasta.

Przykład:
curl -H 'Accept:application/json' 'http://kodpocztowy.intami.pl/city/Wrocław/district/Oporów'
Pobranie kodów pocztowych przypisanych do ulicy w mieście:

http: GET http://kodpocztowy.intami.pl/city/MIASTO/street/ULICA

W miejsce MIASTO wpisz nazwę miasta, a w miejsce ULICA nazwę ulicy.
Ustaw nagłówek Accept na wybrany format odpowiedzi.

W odpowiedzi zwrócona lista kodów pocztowych przypisanych do ulicy w tym miescie.

Przykład:
curl -H 'Accept:application/json' 'http://kodpocztowy.intami.pl/city/Wrocław/street/Grodzka'

Ograniczenia:

Ilość zapytań z jednego adresu IP jest ograniczona do 100 zapytań na dobę. W przypadku przekroczenia tego limitu usługa odpowie kodem http 429 - "Too Many Requests".

Jeśli Twoja aplikacja potrzebuje zwiększonego limitu możesz skorzystać z jednego z płatnych planów dostępnych za pośrednictwem Polish zip codes . Sprawdź dostępne plany subskrypcji.

Opis pól:

nazwa pola opis wymagalność
kodkod pocztowy w formacie xxx-xxxzawsze
nazwanazwa jednostkiwystępuje dla jednostek, którym przydzielono indywidualny kod pocztowy
miejscowośćnazwa miejscowościzawsze
ulicauilcaopcjonalnie
numernumer budynkuwystępuje dla jednostek, którym przydzielono indywidualny kod pocztowy
numeracjaopis numeracjiopcjonalnie
gminagminazawsze
powiatpowiatzawsze
dzielnicadzielnica miastaopcjonalnie

Wypróbuj

Przykład - format JSON

curl -H 'Accept:application/json' 'http://kodpocztowy.intami.pl/api/01-111'

[ { "kod": "01-111", "nazwa": "Zakład XYZ", "miejscowosc": "Warszawa", "ulica": "Jana Olbrachta", "gmina": "Warszawa", "powiat": "Warszawa", "wojewodztwo": "mazowieckie", "dzielnica": "Wola", "numeracja": [ { "od": "1", "do": "9b", "parzystosc": "NIEPARZYSTE" } ] } ]

Przykład - format XML

curl -H 'Accept:application/xml' 'http://kodpocztowy.intami.pl/api/01-111'

<?xml version="1.0" encoding="UTF-8"?> <result> <entry kod="01-111" nazwa="Zakład XYZ" miejscowosc="Warszawa" ulica="Jana Olbrachta" gmina="Warszawa" powiat="Warszawa" wojewodztwo="mazowieckie" dzielnica="Wola" > <numeracja> <zasada od="1" do="11a" parzystosc="NIEPARZYSTE" /> <zasada od="2" do="82" parzystosc="PARZYSTE" /> </numeracja> </entry> </result>

Przykład - format testowy

curl -H 'Accept:text/plain' 'http://kodpocztowy.intami.pl/api/01-111'

01-111 mazowieckie Warszawa Warszawa Wola Jana Olbrachta 1-11a-nieparzyste;2-82-parzyste