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

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

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

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

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
cityГород. См. описание структуры addressLevel
cityAreaРайон города. См. описание структуры addressLevel
settlementНаселенный пункт. См. описание структуры addressLevel
planStructureПланировочная структура (микрорайон). См. описание структуры addressLevel
streetУлица. См. описание структуры addressLevel
houseDetailsДомовая часть адреса. См. описание структуры houseDetails
coordinatesГеографические координаты. См. описание структуры coordinates
countryСтрана. См. описание структуры country
validПризнак корректности адреса
qualityКод качества адреса. См Код качества адреса

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

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

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

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

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

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

ПараметрОписание
houseдом
caseкорпус
buildстроение
literлитера
vladвладение
blockблок
pomпомещение
pavпавильон
uchучасток
obschобщежитие
komкомната
flatквартира
officeофис
kabкабинет
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": ""
    }
  },
  "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",
    "floor": "",
    "house": "44",
    "case": "",
    "build": "",
    "liter": "",
    "lend": "",
    "block": "",
    "pav": "",
    "flat": "",
    "office": "",
    "kab": "",
    "abon": "",
    "plot": "",
    "sek": "",
    "entr": "",
    "room": "",
    "hostel": "",
    "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
  }
}