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

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

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

GET /legacy/searchAddressDetailDHL

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

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

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

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

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

# GET параметры

-X GET 
--header 'Accept: application/json' 
'https://api.apidq.ru/api/legacy/searchAddressDetailDHL?addr=санкт-петербург гороховая улица, 44'

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

Параметр	Описание
c_ischeck	Статус проверки
c_index_in	Индекс во входящей строке
c_zipcode	Индекс найденный
c_address_original	Полученный на вход адрес
c_address_full	Найденный адрес (до улицы)
c_kladr	Код КЛАДР найденный
c_region_name	Наименование региона
c_region_abbr	Сокращенное название аббревиатуры региона
c_region_fias	ФИАС региона
c_district_name	Наименование района
c_district_abbr	Сокращенное название аббревиатуры района
c_district_fias	ФИАС района
c_city_name	Наименование города
c_city_abbr	Сокращенное название аббревиатуры города
c_city_fias	ФИАС города
c_community_name	Наименование населенного пункта
c_community_abbr	Сокращенное название аббревиатуры населенного пункта
c_community_fias	ФИАС населенного пункта
c_street_name	Наименование улицы
c_street_abbr	Сокращенное название аббревиатуры улицы
c_street_fias	ФИАС улицы
c_json_kvant	Детальная информация домовой части. См. описание структуры `c_json_kvant`
c_house_str	Номер дома
c_addr_lost	Неразобранная часть входящей строки
c_status_error	Код качества
c_house_error	Статус разбора дома (код)
c_house_error_desc	Статус разбора дома (описание)
c_kladr19	19-значный КЛАДР
c_gninmb	Код ИФНС
c_okato	Код ОКАТО
c_oktmo	Код ОКТМО
c_aoguid	Код ФИАС до улицы
c_aolevel	Уровень по ФИАС
c_houseguid	Идентификатор дома
c_timezone	Часовой пояс
c_coordinate	Координаты адреса. См. описание структуры `coordinates`

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

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

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

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

Параметр	Описание
c_lat	Широта
c_lon	Долгота
c_level	Уровень

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

[
    {
        "c_ischeck": "1",
        "c_index_in": "",
        "c_zipcode": "190031",
        "c_address_original": "санкт-петербург гороховая улица, 44",
        "c_address_full": "г Санкт-Петербург, ул Гороховая",
        "c_kladr": "78000000000031400",
        "c_region_name": "Санкт-Петербург",
        "c_region_abbr": "г",
        "c_region_fias": "c2deb16a-0330-4f05-821f-1d09c93331e6",
        "c_district_name": "",
        "c_district_abbr": "",
        "c_district_fias": "",
        "c_city_name": "",
        "c_city_abbr": "",
        "c_city_fias": "",
        "c_community_name": "",
        "c_community_abbr": "",
        "c_community_fias": "",
        "c_street_name": "Гороховая",
        "c_street_abbr": "ул",
        "c_street_fias": "7daba2d5-ccdd-4a51-b55c-1f73f67fe4a5",
        "c_json_kvant": {
            "house": "44"
        },
        "c_house_str": "дом 44",
        "c_addr_lost": "",
        "c_status_error": "000035",
        "c_house_error": "3",
        "c_house_error_desc": "дом найден по КЛАДР/ФИАС",
        "c_kladr19": "",
        "c_gninmb": "",
        "c_okato": "",
        "c_oktmo": "40302000",
        "c_aoguid": "7daba2d5-ccdd-4a51-b55c-1f73f67fe4a5",
        "c_aolevel": "7",
        "c_houseguid": "",
        "c_timezone": "",
        "c_coordinate": {
            "c_lon": "30.3102",
            "c_lat": "59.9356",
            "c_level": "7"
        }
    }
]