Документация по API

Начните использовать наш простой в использовании API сегодня, следуйте примерам, чтобы узнать, как его использовать.




GET Получите почтовые индексы на расстоянии

С помощью этой простой в использовании конечной точки вы получите список почтовых индексов, находящихся на заданном расстоянии. Пример запроса вернет список уникальных почтовых индексов, полный список почтовых индексов и сведения о каждом почтовом индексе.

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

Наш API принимает измерения расстояний в километрах (по умолчанию) или милях.

Чтобы изменить измерение на километры, вы должны ms в своем запросе параметр 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 (Хорватия (Грвацкая))
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 (Малави)