{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": "mi",
},
"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&distance=25&zipcode=10005&country=us
අපගේ API දුර කිලෝමීටර (පෙරනිමි) හෝ සැතපුම් වලින් පිළිගනී.
මිනුම් කිලෝමීටරයකට වෙනස් කිරීම සඳහා ඔබ ඔබේ ඉල්ලීමෙහි 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": "mi"
},
"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": "mi"
},
"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"
}
],
}
}
ප්රති results ල වලදී ඔබට අවශ්ය දේ පමණක් ලබා ගැනීම සඳහා ඔබට අමතර පරාමිතීන් පසු කළ හැකිය, ඔබගේ ඉල්ලීමෙහි 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": "mi"
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}