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

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

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

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

POST /clean/address

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

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

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

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

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

{
  "query": "Москва, Профсоюзная улица, 42к1, 242",
  "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Часовой пояс
undefinedPartsНераспознанная часть адреса
metroСписок ближайших станций метро (не более 3 станций в радиусе 5 км). Заполняется только для POST /clean/address, для остальных методов адресного поиска — пустой список. См. описание структуры metro

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

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

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

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

ПараметрОписание
fiasКод в базе ФИАС
gaGaCode - глобальный адресный код
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Коды дома. См. описание структуры codes
apartmentCodesКоды найденного помещения (квартиры). Заполняется только для POST /clean/address и POST /idsearch/address. См. описание структуры codes
additionalДополнительные атрибуты дома/помещения. Заполняется только для POST /clean/address и POST /idsearch/address. См. описание структуры additional

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

ПараметрОписание
houseIsMultiFlatПризнак многоквартирного дома
houseFlatCountКоличество квартир в доме
houseCadnumКадастровый номер дома
apartmentCadnumКадастровый номер помещения

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

ПараметрОписание
nameНазвание станции
lineНазвание линии
cityГород
distanceРасстояние до станции в метрах

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

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

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

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

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

{
  "original": "Москва, Профсоюзная улица, 42к1, 242",
  "addressFull": "г Москва, ул Профсоюзная, дом 42, корпус 1, квартира 242",
  "address": "г Москва, ул Профсоюзная",
  "postcodeIn": "",
  "postcode": "117335",
  "region": {
    "fullName": "г Москва",
    "name": "Москва",
    "type": "г",
    "codes": {
      "fias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
      "ga": "RU0770000000000000000000000",
      "osm": "R102269",
      "gar": "1405113",
      "kladr": "7700000000000"
    }
  },
  "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": "9a661426-e65c-4223-af4d-aa5e95b7caac",
      "ga": "RU0770000000000000000002392",
      "osm": "W30750376",
      "gar": "1401987",
      "kladr": "77000000000239200"
    }
  },
  "houseDetails": {
    "fullName": "дом 42, корпус 1, квартира 242",
    "house": "42",
    "case": "1",
    "build": "",
    "liter": "",
    "lend": "",
    "constr": "",
    "stead": "",
    "flat": "242",
    "office": "",
    "room": "",
    "kab": "",
    "place": "",
    "entr": "",
    "floor": "",
    "block": "",
    "pav": "",
    "sek": "",
    "abon": "",
    "munit": "",
    "codes": {
      "fias": "2d960636-942f-48bd-8362-b39fea91a3e4",
      "ga": "",
      "osm": "",
      "gar": "56965994",
      "kladr": ""
    },
    "apartmentCodes": {
      "fias": "0361c9ca-1703-4535-b11a-6fbd372448e1",
      "ga": "",
      "osm": "",
      "gar": "56968181",
      "kladr": ""
    },
    "additional": {
      "houseIsMultiFlat": true,
      "houseFlatCount": "143",
      "houseCadnum": "77:06:0003009:1025",
      "apartmentCadnum": "77:06:0003009:2561"
    }
  },
  "coordinates": {
    "latitude": 55.674565,
    "longitude": 37.55814
  },
  "country": {
    "name": "Россия",
    "alpha2": "RU",
    "alpha3": "RUS",
    "numeric": 643
  },
  "valid": true,
  "quality": {
    "unique": 0,
    "actuality": 0,
    "undefined": 0,
    "level": 9,
    "house": 3,
    "geo": 8
  },
  "timezone": "UTC+3",
  "undefinedParts": "",
  "metro": [
    {
      "name": "Профсоюзная",
      "line": "Калужско-Рижская",
      "city": "Москва",
      "distance": 479
    },
    {
      "name": "Новые Черемушки",
      "line": "Калужско-Рижская",
      "city": "Москва",
      "distance": 550
    },
    {
      "name": "Вавиловская",
      "line": "Троицкая",
      "city": "Москва",
      "distance": 1580
    }
  ]
}