Mei dit maklik te brûken einpunt krije jo in list mei postkoades dy't binnen in bepaalde ôfstân binne. It fersykfoarbyld sil in list mei unike postkoades, in folsleine list fan postkoades en de details fan elke postkoade weromjaan.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usUs API aksepteart ôfmjittings yn kilometers (standert) as milen.
Om de mjitting te feroarjen yn kilometers moatte jo de ms parameter yn jo fersyk sette:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usIt antwurd sil der sa útsjen:
{
"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"
},
...
],
}
}
It folgjende foarbyld sil de details weromjaan fan 'e postkoades dy't oerienkomme mei de sykfraach.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usIt antwurd sil der sa útsjen:
{
"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"
}
],
}
}
Jo kinne ekstra params trochjaan om allinich te krijen wat jo nedich binne yn 'e resultaten, foegje gewoan de fields yn jo fersyk.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usIt antwurd sil der sa útsjen:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}