यो सजीलो अन्तपोइन्ट प्रयोग गरेर तपाईले हुलाक कोडहरूको सूची पाउनुहुनेछ जुन दिईएको दूरीमा हुन्छ। अनुरोध उदाहरणले अद्वितीय पोस्टल कोडहरूको सूची, हुलाक कोडहरूको पूर्ण सूची र प्रत्येक हुलाक कोडको विवरण फिर्ता गर्नेछ।
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", ...]
}
}