API dokumintaasje

Begjin mei ús maklik te brûken API hjoed, folgje de foarbylden om te learen hoe't jo it brûke.




GET Krij postkoades binnen in ôfstân

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=us

Us 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=us

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

GET Krij details oer postkoades

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=us

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

GET Krij oanpaste gegevens

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=us

It antwurd sil der sa útsjen:

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



Begjin hjoed ús API fergees te brûken!

Krij 240 deistige fergese oanfragen

+94 Stipe lannen

AD (Andorra)
AR (Argentynje)
AS (Amerikaansk-samoa)
AT (Eastenryk)
AU (Austraalje)
AX (Aland Islands)
AZ (Azerbeidzjan)
BD (Banglades)
BE (Belgje)
BG (Bulgarije)
BM (Bermuda)
BR (Brazylje)
Flag of Belarus
BY (Wyt-Ruslân)
CA (Kanada)
CH (Switserlân)
CL (Sily)
CO (Kolombia)
CR (Kosta Rika)
CY (Syprus)
CZ (Tsjechje)
Flag of Germany
DE (Dútslân)
DK (Denemark)
DO (Dominikaanske Republyk)
DZ (Algerije)
EE (Estlân)
ES (Spanje)
FI (Finlân)
FM (Mikroneezje)
FO (Fêreu-eilannen)
FR (Frankryk)
GB (Feriene Keninkryk)
GF (Frânsk Guiana)
GG (Guernsey en Alderney)
GL (Grienlân)
GP (Guadeloupe)
GT (Gûatemala)
GU (Gûam)
HR (Kroaasje (Hrvatska))
HU (Hongarije)
IE (Ierlân)
IM (Man (Isle of))
IN (Yndia)
IS (Yslân)
IT (Itaalje)
JE (Jersey)
JP (Japan)
Flag of South Korea
KR (Korea Súd)
LI (Lychtenstein)
LK (Sry Lanka)
LT (Litouwen)
LU (Lúksemboarch)
LV (Letlân)
MC (Monako)
MD (Moldaavje)
Flag of the Marshall Islands
MH (de Marshalleilannen)
MK (Massedoanje)
MP (de Noardlike Marianen)
MQ (Martinique)
MT (Malta)
Flag of Malawi
MW (Malawy)