API Documentation

Биздин колдонууга жеңил 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 Почта индекстеринин чоо-жайын билип алыңыз

Төмөнкү мисалда издөө сурамына дал келген почта индекстеринин маалыматтары келтирилет.

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 (Man (аралы))
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 (Малави)
MX (Мексика)
MY (Малайзия)
Flag of New Caledonia
NC (Жаңы Каледония)
NL (Нидерланды The)
NO (Норвегия)
NZ (Жаңы Зеландия)
PE (Перу)
Flag of the Philippines Coding according to the official "description and specification of the FILIPINO flag" in Executive Order No. 23 from 1936
PH (Филиппиндер)
Flag of Pakistan
PK (Пакистан)
PL (Польша)
PM (Сент-Джонс и Микелон)
the star is in the center of gravity of the triangle, so the x-pos is irrational (tan(30 deg) * 15)
PR (Пуэрто Рико)
PT (Португалия)
PW (Палау)
RE (чогулуш)
RO (Румыния)
RS (Сербия)
RU (Орусия)
SE (Швеция)
SG (Сингапур)
Flag of Slovenia
SI (Словения)
SJ (Svalbard жана Ян-Майен)
Flag of Slovakia
SK (Словакия)
SM (Сан Марино)
TH (Тайланд)
TR (Туркия)
UA (Украина)
US (Кошмо штаттар)
Flag of Uruguay
UY (Уругвай)
Flag of Vatican City
VA (Vatican City State (Ыйык Тактыдагы))
VI (Virgin Islands (US))
WF (Уоллис и Полинезия аралдары)
YT (Майотта)
ZA (Түштүк Африка)