Перейти к содержанию

Поиск субъекта ФИАС (регионы, улицы, районы)

Поиск элементов адресной системы ФИАС: регионов, городов, районов, улиц, населенных пунктов и дополнительных территорий. Поддерживает фильтрацию по иерархии адресных объектов.

URL

Метод: GET

  • Production: https://registry.wallet.kvell.group/reg2/dictionary/fias/{element}

Параметры запроса

Название Тип данных Обязательно Описание
element string (path) Да Элемент ФИАС: additional_area (дополнительные территории), city (город), district (район), intra_area (населенные пункты), region (регион), settlement (поселок), street (улица)
search string Да Строка поиска
regionId uuid Нет ID региона (UUID)
districtId uuid Нет ID района (UUID)
cityId uuid Нет ID города (UUID)
settlementId uuid Нет ID поселка (UUID)
intraAreaId uuid Нет ID населённого пункта (UUID)
streetId uuid Нет ID улицы (UUID)
additionalAreaId uuid Нет ID дополнительной территории (UUID)

Пример запроса

GET https://registry.wallet.kvell.group/reg2/dictionary/fias/{element}?search=Москва

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор (UUID)

Ответ запроса

Пример ответа

[
  {
    "id": "9e79f949-9a68-48ff-b2bb-36958c1d5038",
    "name": "Москва",
    "type": "city",
    "prefix": "г",
    "postalCode": "125130",
    "kladrCode": "9400000000000",
    "2Gis": true
  }
]

Параметры ответа

Название Тип данных Описание
id uuid Идентификатор объекта
name string Название объекта
type string Тип объекта
prefix string Префикс
postalCode string Индекс
kladrCode string Код по КЛАДР
okatoCode string Код по ОКАТО
2Gis boolean Есть в 2ГИС