इस उपयोग में आसान एंडपॉइंट के साथ आपको पोस्टल कोड की एक सूची मिलेगी जो एक निश्चित दूरी के भीतर हैं। अनुरोध उदाहरण अद्वितीय पोस्टल कोड की सूची, पोस्टल कोड की पूरी सूची और प्रत्येक पोस्टल कोड का विवरण लौटाएगा।
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usहमारा एपीआई किलोमीटर (डिफ़ॉल्ट) या मील में दूरी माप स्वीकार करता है।
माप को किलोमीटर में बदलने के लिए आपको अपने अनुरोध में 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", ...]
}
}