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

Поиск субъекта ФИАС

Поиск элементов ФИАС: регионы, города, районы, улицы, поселения, населённые пункты.

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 региона
districtId uuid Нет ID района
cityId uuid Нет ID города
settlementId uuid Нет ID поселения
intraAreaId uuid Нет ID населённого пункта
streetId uuid Нет ID улицы
additionalAreaId uuid Нет ID дополнительной территории

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

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 Код по КЛАДР
2Gis boolean Наличие в 2ГИС