С тази лесна за използване крайна точка ще получите списък с пощенски кодове, които са в рамките на дадено разстояние. Примерът за заявка ще върне списък с уникални пощенски кодове, пълен списък с пощенски кодове и подробности за всеки пощенски код.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usНашият API приема измерване на разстояние в километри (по подразбиране) или мили.
За да промените измерването на километри, трябва да поставите ms във вашата заявка:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usОтговорът ще изглежда така:
{
"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"
},
...
],
}
}
Следващият пример ще върне подробностите за пощенските кодове, които съответстват на заявката за търсене.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usОтговорът ще изглежда така:
{
"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"
}
],
}
}
Можете да предадете допълнителни параметри, за да получите само това, от което се нуждаете, в резултатите, просто добавете fields за стойност в заявката си.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usОтговорът ще изглежда така:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}