Стандартизация адреса #

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

Адрес метода #

POST /clean/address

Функциональность #

очищает входящие данные от лишних символов для стандартизации адреса;
определяет координаты адреса (при наличии их в эталонном справочнике);
определяет индекс дома;
дополняет недостающие адресные уровни (регион, район);
определяет идентификаторы в различных эталонных базах.

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

Параметр	Описание
query	Строка для разбора адреса
countryCode	Код страны, в которой происходит поиск адреса, в формате ISO 3166 (https://www.iso.org/iso-3166-country-codes.html)

Пример данных запроса #

{
  "query": "санкт-петербург козлова 30",
  "countryCode": "RU"
}

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

Параметр	Описание
original	Входящая строка с адресом, которая участвовала в стандартизации
address	Строка с разобранным и стандартизированным адресом
addressFull	Строка с разобранным и стандартизированным адресом вместе с домовой частью
postcodeIn	Почтовый индекс найденный во входящей строке
postcode	Почтовый индекс определенный по эталонной базе в процессе стандартизации
region	Регион, область. См. описание структуры `addressLevel`
area	Район области. См. описание структуры `addressLevel`
municipal	Муниципальное образование. См. описание структуры `addressLevel`
city	Город. См. описание структуры `addressLevel`
cityArea	Район города. См. описание структуры `addressLevel`
settlement	Населенный пункт. См. описание структуры `addressLevel`
planStructure	Планировочная структура (микрорайон). См. описание структуры `addressLevel`
street	Улица. См. описание структуры `addressLevel`
houseDetails	Домовая часть адреса. См. описание структуры `houseDetails`
coordinates	Географические координаты. См. описание структуры `coordinates`
country	Страна. См. описание структуры `country`
valid	Признак корректности адреса
quality	Код качества адреса. См Код качества адреса
timezone	Часовой пояс

Вложенные структуры #

Описание структуры `addresslevel` #

Параметр	Описание
fullName	Наименование и тип адресного элемента
name	Наименование адресного элемента
type	Тип адресного элемента
codes	Коды адресного элемента

Описание структуры `codes` #

Параметр	Описание
fias	Код в базе ФИАС
ga	GaCode - глобальный адресный код
osm	Код в базе OpenStreetMap
gar	Код в базе ГАР
kladr	Код в базе КЛАДР

Описание структуры `housedetails` #

Параметр	Описание
full_name	дом строкой
house	дом
case	корпус
build	строение
liter	литера
lend	владение
constr	сооружение
stead	участок
flat	квартира
office	офис
room	комната
kab	кабинет
place	помещение
entr	подъезд
floor	этаж
block	блок
pav	павильон
sek	секция
abon	а/я
munit	в/ч
codes	Коды дома

Описание структуры `coordinates` #

Параметр	Описание
latitude	Широта
longitude	Долгота

Описание структуры `country` #

Параметр	Описание
name	Наименование страны
alpha2	Код страны, в формате ISO 3166-1 alpha-2
alpha3	Код страны, в формате ISO 3166-1 alpha-3
numeric	Код страны, в формате ISO 3166-1 numeric

Пример данных ответа #

{
  "original": "санкт-петербург гороховая улица, 44",
  "addressFull": "г Санкт-Петербург, ул Гороховая, дом 44",
  "address": "г Санкт-Петербург, ул Гороховая",
  "postcodeIn": "",
  "postcode": "190000",
  "region": {
    "fullName": "г Санкт-Петербург",
    "name": "Санкт-Петербург",
    "type": "г",
    "codes": {
      "fias": "c2deb16a-0330-4f05-821f-1d09c93331e6",
      "ga": "RU0780000000000000000000000",
      "osm": "R337422",
      "gar": "1414662",
      "kladr": "7800000000000"
    }
  },
  "area": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "municipal": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "city": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "cityArea": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "settlement": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "planStructure": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "",
      "gar": "",
      "kladr": ""
    }
  },
  "street": {
    "fullName": "ул Гороховая",
    "name": "Гороховая",
    "type": "ул",
    "codes": {
      "fias": "7daba2d5-ccdd-4a51-b55c-1f73f67fe4a5",
      "ga": "RU0780000000000000000000314",
      "osm": "W218508357",
      "gar": "1418859",
      "kladr": "78000000000031400"
    }
  },
  "houseDetails": {
	"fullName": "дом 44",
	"house": "44",
	"case": "",
	"build": "",
	"liter": "",
	"lend": "",
	"constr": "",
	"stead": "",
	"flat": "",
	"office": "",
	"room": "",
	"kab": "",
	"place": "",
	"entr": "",
	"floor": "",
	"block": "",
	"pav": "",
	"sek": "",
	"abon": "",
	"munit": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": "W66319028",
      "gar": "",
      "kladr": ""
    }
  },
  "coordinates": {
    "latitude": 59.92743425,
    "longitude": 30.32504983
  },
  "country": {
    "name": "Россия",
    "alpha2": "RU",
    "alpha3": "RUS",
    "numeric": 643
  },
  "valid": true,
  "quality": {
    "unique": 0,
    "actuality": 0,
    "undefined": 0,
    "level": 8,
    "house": 3,
    "geo": 8
  },
  "timezone": "UTC+3"
}