API-Dokumentaro

Komencu uzi nian facile uzeblan API hodiaŭ, sekvu la ekzemplojn por lerni kiel uzi ĝin.




GET Akiru poŝtkodojn en distanco

Per ĉi tiu facile uzebla finpunkto vi ricevos liston de Poŝtaj kodoj, kiuj troviĝas en difinita distanco. La peta ekzemplo redonos liston de unikaj poŝtkodoj, kompletan liston de poŝtkodoj kaj la detalojn de ĉiu poŝtkodo.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=us

Nia API akceptas distancajn mezuradojn en kilometroj (Defaŭlte) aŭ mejloj.

Por ŝanĝi mezuradon al kilometroj, vi devas enmeti la ms en vian peton:

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=us

La respondo aspektos jene:

{
   "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 Akiru poŝtkodajn detalojn

La sekva ekzemplo redonos la detalojn de la poŝtkodoj, kiuj kongruas kun la serĉpeto.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=us

La respondo aspektos jene:

{
   "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"
          }
       ],
   }
}

GET Akiru proprajn datumojn

Vi povas doni pliajn paramojn por akiri nur tion, kion vi bezonas en la rezultoj, nur aldonu la valorajn fields en via peto.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=us

La respondo aspektos jene:

{
   "query":{
      "code": "10005",
      "country": "US",
      "range": "25",
      "measure": ""
   },
   "results":{
       "range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
   }
}



Komencu uzi nian API senpage hodiaŭ!

Akiru 240 ĉiutagajn senpagajn petojn

+94 Subtenataj landoj

AD (Andoro)
AR (Argentino)
AS (Usona Samoo)
AT (Aŭstrio)
AU (Aŭstralio)
AX (Insuloj Aland)
AZ (Azerbajĝano)
BD (Bangladeŝo)
BE (Belgio)
BG (Bulgario)
BM (Bermudo)
BR (Brazilo)
Flag of Belarus
BY (Belorusujo)
CA (Kanado)
CH (Svislando)
CL (Ĉilio)
CO (Kolombio)
CR (Kostariko)
CY (Kipro)
CZ (Ĉeĥio)
Flag of Germany
DE (Germanio)
DK (Danujo)
DO (Dominika Respubliko)
DZ (Alĝerio)
EE (Estonio)
ES (Hispanio)
FI (Finnlando)
FM (Mikronezio)
FO (Ferooj)
FR (Francio)
GB (Unuiĝinta Reĝlando)
GF (Franca Gviano)
GG (Seyerzjako kaj Alderney)
GL (Gronlando)
GP (Gvadelupo)
GT (Gvatemalo)
GU (Gvamo)
HR (Kroatio (Hrvatska))
HU (Hungario)
IE (Irlando)
IM (Viro (Insulo de))
IN (Barato)
IS (Islando)
IT (Italio)
JE (.Erzo)
JP (Japanio)
Flag of South Korea
KR (Sud-Koreio)
LI (Liensteintenŝtejno)
LK (Srilanko)
LT (Litovio)
LU (Luksemburgio)
LV (Latvio)
MC (Monako)
MD (Moldavio)
Flag of the Marshall Islands
MH (Marŝalaj Insuloj)
MK (Makedonio)
MP (Nordaj Marianaj Insuloj)
MQ (Martiniko)
MT (Malto)
Flag of Malawi
MW (Malavio)