Mat dësem einfach benotzbaren Endpunkt kritt Dir eng Lëscht vu Postcode, déi an enger bestëmmter Distanz sinn. De Beispillerbeispiel gëtt eng Lëscht mat eenzegaartege Postcode, eng komplett Lëscht vu Postleitzueler an d'Detailer vun all Postleetzuel zréck.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usEis API acceptéiert Distanzmiessungen a Kilometer (Standard) oder Meilen.
Fir d'Messung op Kilometer z'änneren, musst Dir de ms Parameter an Ärer Ufro setzen:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usD'Äntwert wäert esou ausgesinn:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...],
"range_codes": ["07010", "07020", "07022", "07024", "07026", ...],
"range_codes_details": [
{
"postal_code":"07010",
"country_code":"US",
"city":"Cliffside Park",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07020",
"country_code":"US",
"city":"Edgewater",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07022",
"country_code":"US",
"city":"Fairview",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07024",
"country_code":"US",
"city":"Fort Lee",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07026",
"country_code":"US",
"city":"Garfield",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
...
],
}
}
Dat folgend Beispill wäert d'Detailer vun de Postcode zréckginn, déi mat der Sichufro passen.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usD'Äntwert wäert esou ausgesinn:
{
"query":{
"code": "10005",
"country": "us",
"range": "",
"measure": ""
},
"results":{
"range_codes_unique": ["10005"],
"range_codes": ["10005"],
"range_codes_details": [
{
"postal_code":"10005",
"country_code":"US",
"city":"New York",
"state":"New York",
"state_code":"NY",
"province":"New York",
"province_code":"061"
}
],
}
}
Dir kënnt extra params Ugrëff nëmme gespillt, wat Dir am Resultater mussen, just de Wäert Foto fields an Ärer Demande.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usD'Äntwert wäert esou ausgesinn:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}