Avèk sa a fasil yo sèvi ak pwen final ou pral jwenn yon lis kòd postal ki nan yon distans bay yo. Egzanp demann lan ap retounen yon lis kòd postal inik, yon lis konplè kòd postal ak detay yo nan chak kòd postal.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usAPI nou an aksepte mezi distans an kilomèt (Default) oswa mil.
Pou chanje mezi a kilomèt ou dwe mete ms nan demann ou an:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usRepons lan pral sanble tankou sa a:
{
"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"
},
...
],
}
}
Egzanp sa a ap retounen detay yo nan kòd postal yo ki matche ak rechèch rechèch la.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usRepons lan pral sanble tankou sa a:
{
"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"
}
],
}
}
Ou ka pase params siplemantè yo ka resevwa sèlman sa ou bezwen nan rezilta yo, jis ajoute fields valè nan demann ou an.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usRepons lan pral sanble tankou sa a:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}