Mit diesem benutzerfreundlichen Endpunkt erhalten Sie eine Liste der Postleitzahlen, die sich in einer bestimmten Entfernung befinden. Das Anforderungsbeispiel gibt eine Liste eindeutiger Postleitzahlen, eine vollständige Liste der Postleitzahlen und die Details jeder Postleitzahl zurück.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usUnsere API akzeptiert Entfernungsmessungen in Kilometern (Standard) oder Meilen.
Um die Messung in Kilometer zu ändern, müssen Sie den ms Parameter in Ihre Anfrage einfügen:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usDie Antwort wird wie folgt aussehen:
{
"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"
},
...
],
}
}
Das folgende Beispiel gibt die Details der Postleitzahlen zurück, die mit der Suchanfrage übereinstimmen.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usDie Antwort wird wie folgt aussehen:
{
"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"
}
],
}
}
Sie können zusätzliche params passieren nur zu bekommen , was Sie in den Ergebnissen benötigen, nur um den Mehrwert fields in Ihrer Anfrage.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usDie Antwort wird wie folgt aussehen:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}