Пайдалануға ыңғайлы соңғы нүктенің көмегімен сіз берілген қашықтықта орналасқан Пошта индексінің тізімін аласыз. Сұраным мысалында бірегей пошта индексінің тізімі, пошта индексінің толық тізімі және әрбір пошта индексі туралы мәліметтер келтіріледі.
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", ...]
}
}