Izmantojot šo ērti izmantojamo galapunktu, jūs saņemsiet pasta indeksu sarakstu, kas atrodas noteiktā attālumā. Pieprasījuma piemērā tiks parādīts unikālo pasta kodu saraksts, pilnīgs pasta kodu saraksts un katra pasta indeksa informācija.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usMūsu API pieņem attāluma mērījumus kilometros (noklusējums) vai jūdzēs.
Lai mainītu mērījumu uz kilometriem, pieprasījumā jāievieto parametrs ms
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usAtbilde izskatīsies šādi:
{
"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"
},
...
],
}
}
Šis piemērs atgriezīs pasta indeksu informāciju, kas atbilst meklēšanas vaicājumam.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usAtbilde izskatīsies šādi:
{
"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"
}
],
}
}
Jūs varat nodot papildu parametrus, lai rezultātos iegūtu tikai to, kas jums nepieciešams, vienkārši pievienojiet pieprasījuma vērtību fields .
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usAtbilde izskatīsies šādi:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}