З дапамогай гэтай простай у выкарыстанні канчатковай кропкі вы атрымаеце спіс паштовых індэксаў, якія знаходзяцца на пэўнай адлегласці. Прыклад запыту верне спіс унікальных паштовых індэксаў, поўны спіс паштовых індэксаў і звесткі аб кожным паштовым індэксе.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usНаш API прымае вымярэнне адлегласці ў кіламетрах (па змаўчанні) альбо ў мілях.
Каб змяніць вымярэнне на кіламетры, неабходна ms у сваім запыце параметр 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", ...]
}
}