אַפּי דאָקומענטאַטיאָן

אָנהייבן ניצן אונדזער גרינג צו נוצן אַפּי הייַנט. נאָכגיין די ביישפילן צו לערנען ווי צו נוצן עס.




GET באַקומען פּאָסטאַל קאָודז אין אַ ווייַטקייט

מיט דעם גרינג צו נוצן ענדפּוינט, איר וועט באַקומען אַ רשימה פון פּאָסטאַל קאָודז וואָס זענען אין אַ געגעבן ווייַטקייט. די בעטן ביישפּיל וועט ווייַזן אַ רשימה פון יינציק פּאָוסטאַל קאָודז, אַ גאַנץ רשימה פון פּאָוסטאַל קאָודז און די דעטאַילס פון יעדער פּאָסטאַל קאָד.

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

אונדזער אַפּי אַקסעפּץ ווייַטקייט מעזשערמאַנץ אין קילאָמעטערס (פעליקייַט) אָדער מייל.

צו טוישן מעזשערמאַנט צו קילאָמעטערס, איר מוזן שטעלן די 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": ""
   },
   "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 באַקומען אינפֿאָרמאַציע וועגן פּאָסטאַל קאָודז

די פאלגענדע בייַשפּיל וועט צוריקקומען די דעטאַילס פון די פּאָסטאַל קאָודז וואָס שטימען מיט די זוכן אָנפֿרעג.

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

דער ענטפער וועט קוקן ווי דאָס:

{
   "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 באַקומען מנהג דאַטן

איר קענט דורכפירן עקסטרע פּאַראַמס צו באַקומען בלויז וואָס איר דאַרפֿן אין די רעזולטאַטן, נאָר לייגן די ווערט 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": ""
   },
   "results":{
       "range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
   }
}



אָנהייבן אונדזער API פֿאַר פריי הייַנט!

באַקומען 240 פריי ריקוועס טעגלעך

+94 שטיצט לענדער

AD (Andorra)
AR (ארגענטינע)
AS (אמעריקאנער סאַמאָאַ)
AT (עסטרייַך)
AU (אויסטראַליע)
AX (Aland Islands)
AZ (אַזערביידזשאַן)
BD (באַנגלאַדעש)
BE (Belgium)
BG (בולגאריע)
BM (בערמודאַ)
BR (Brazil)
Flag of Belarus
BY (Belarus)
CA (קאַנאַדע)
CH (שווייץ)
CL (Chile)
CO (Colombia)
CR (קאסטא ריקא)
CY (Cyprus)
CZ (טשעכיי)
Flag of Germany
DE (דייַטשלאַנד)
DK (Denmark)
DO (דאָמיניקאַן רעפובליק)
DZ (אַלדזשיריאַ)
EE (עסטאָניאַ)
ES (ספּאַין)
FI (פינלאַנד)
FM (מיקראָנעסיאַ)
FO (פאַראָע אינזלען)
FR (פֿראַנקרייַך)
GB (פֿאַראייניקטע מלכות)
GF (פראנצויזיש גיאַנאַ)
GG (גורנסיי און אַלדערני)
GL (גרינלאַנד)
GP (גואַדעלאָופּע)
GT (גואַטעמאַלאַ)
GU (Guam)
HR (קראָאַטיאַ (Hrvatska))
HU (אונגארן)
IE (ירעלאַנד)
IM (מענטש (ייל פון))
IN (India)
IS (Iceland)
IT (איטאליע)
JE (דזשערזי)
JP (יאַפּאַן)
Flag of South Korea
KR (דרום קארעע)
LI (Liechtenstein)
LK (סרי לאנקא)
LT (ליטע)
LU (Luxembourg)
LV (לאַטוויאַ)
MC (מאָנאַקאָ)
MD (מאָלדאָוואַ)
Flag of the Marshall Islands
MH (מאַרשאַל אינזלען)
MK (Macedonia)
MP (Northern Mariana Islands)
MQ (Martinique)
MT (Malta)
Flag of Malawi
MW (מאַלאַווי)