Sa madaling gamitin na endpoint makakakuha ka ng isang listahan ng mga Postal code na nasa loob ng isang naibigay na distansya. Ang halimbawa ng kahilingan ay magbabalik ng isang listahan ng mga natatanging mga postal code, isang kumpletong listahan ng mga postal code at ang mga detalye ng bawat postal code.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usTumatanggap ang aming API ng mga pagsukat sa distansya sa mga kilometro (Default) o milya.
Upang baguhin ang pagsukat sa mga kilometro dapat mong ilagay ang ms sa iyong kahilingan:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usMagiging ganito ang tugon:
{
"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"
},
...
],
}
}
Ang sumusunod na halimbawa ay ibabalik ang mga detalye ng mga postal code na tumutugma sa query sa paghahanap.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usMagiging ganito ang tugon:
{
"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"
}
],
}
}
Maaari kang pumasa ng labis na mga params upang makuha lamang ang kailangan mo sa mga resulta, idagdag lamang ang mga fields halaga sa iyong kahilingan.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usMagiging ganito ang tugon:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}