مستندات API

همین امروز از API استفاده آسان ما استفاده کنید ، برای یادگیری نحوه استفاده از آن مثالها را دنبال کنید.




GET در فاصله کمی کد پستی دریافت کنید

با استفاده از این نقطه پایانی آسان ، لیستی از کد پستی را که در یک فاصله معین قرار دارند دریافت خواهید کرد. مثال درخواست لیستی از کد پستی منحصر به فرد ، لیست کاملی از کد پستی و جزئیات هر کد پستی را باز می گرداند.

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

API ما اندازه گیری مسافت را به کیلومتر (پیش فرض) یا مایل می پذیرد.

برای تغییر اندازه گیری به کیلومتر ، باید 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 جزئیات کد پستی را دریافت کنید

مثال زیر جزئیات کدهای پستی را که مطابق با س searchال جستجو است باز می گرداند.

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 (آندورا)
AR (آرژانتین)
AS (ساموآ آمریکا)
AT (اتریش)
AU (استرالیا)
AX (جزایر الند)
AZ (آذربایجان)
BD (بنگلادش)
BE (بلژیک)
BG (بلغارستان)
BM (برمودا)
BR (برزیل)
Flag of Belarus
BY (بلاروس)
CA (کانادا)
CH (سوئیس)
CL (شیلی)
CO (کلمبیا)
CR (کاستاریکا)
CY (قبرس)
CZ (جمهوری چک)
Flag of Germany
DE (آلمان)
DK (دانمارک)
DO (جمهوری دومینیکن)
DZ (الجزایر)
EE (استونی)
ES (اسپانیا)
FI (فنلاند)
FM (میکرونزی)
FO (جزایر فارو)
FR (فرانسه)
GB (انگلستان)
GF (گویان فرانسه)
GG (گورنسی و آلدرین)
GL (گرینلند)
GP (گوادلوپ)
GT (گواتمالا)
GU (گوام)
HR (کرواسی (Hrvatska))
HU (مجارستان)
IE (ایرلند)
IM (مرد (جزیره))
IN (هندوستان)
IS (ایسلند)
IT (ایتالیا)
JE (جرسی)
JP (ژاپن)
Flag of South Korea
KR (کره جنوبی)
LI (لیختن اشتاین)
LK (سری لانکا)
LT (لیتوانی)
LU (لوکزامبورگ)
LV (لتونی)
MC (موناکو)
MD (مولداوی)
Flag of the Marshall Islands
MH (جزایر مارشال)
MK (مقدونیه)
MP (جزایر ماریانای شمالی)
MQ (مارتینیک)
MT (مالت)
Flag of Malawi
MW (مالاوی)