- Создатель Никита Таныгин, отредактировано 17 июл. 2015
Вы просматриваете старую версию данной страницы. Смотрите текущую версию.
Сравнить с текущим просмотр истории страницы
« Предыдущий Версия 5 Следующий »
Метод доступен только через API (jQuery-плагин не поддерживается).
Метод ищет по коду ФИАС/КЛАДР до улицы (при поиске по коду дома вернется пустой ответ).
Обратите внимание – поиск адреса по коду ФИАС осуществляется только в случае, когда Подсказки используют справочник ФИАС.
Если справочник – КЛАДР, то поиск возможен только по коду КЛАДР.
Запрос
Для пользователей бесплатных подсказок DaData.ru:
curl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -H "Authorization: Token ${API_KEY}" \ -d '{ "query": "5f96fd6b-b3de-451f-b280-8fedf859e683" }' \ https://dadata.ru/api/v2/findById/address
Для пользователей платных подсказок DaData.ru:
curl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -H "Authorization: Token ${API_KEY}" \ -d '{ "query": "5f96fd6b-b3de-451f-b280-8fedf859e683" }' \ http://suggestions.dadata.ru/suggestions/api/4_1/rs/findById/address
Для пользователей standalone-подсказок:
curl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "query": "5f96fd6b-b3de-451f-b280-8fedf859e683" }' \ http://ВАШ_СЕРВЕР:ПОРТ/suggestions/api/4_1/rs/findById/address
Параметры
Параметр | Обязательный? | Описание |
---|---|---|
query | да | Код КЛАДР/ФИАС, по которому нужно получить подсказку |
Ответ
Возвращается объект адреса, который соответствует искомому коду КЛАДР/ФИАС:
Поле | Тип данных | Описание |
---|---|---|
value | string(1000) | Короткий адрес одной строкой |
unrestricted_value | string(1000) | Длинный адрес одной строкой |
data.postal_code | string(10) | Индекс |
data.country | string(150) | Страна |
data.country_iso_code | string(10) | Двухсимвольный код страны ISO 3166 (19.7+) |
data.federal_district | string(50) | Федеральный округ (19.5+) |
data.region_fias_id | string(50) | ФИАС-код региона |
data.region_kladr_id | string(20) | КЛАДР-код региона |
data.region_iso_code | string(10) | Код региона ISO 3166 (19.7+) |
data.region_with_type | string(150) | Регион с типом |
data.region_type | string(10) | Тип региона (сокращенный) |
data.region_type_full | string(50) | Тип региона |
data.region | string(150) | Регион |
data.area_fias_id | string(50) | ФИАС-код района в регионе для Белоруссии, Узбекистана и Казахстана — код OSM для остальных стран — код Geonames |
data.area_kladr_id | string(20) | КЛАДР-код района в регионе |
data.area_with_type | string(150) | Район в регионе с типом |
data.area_type | string(10) | Тип района в регионе (сокращенный) |
data.area_type_full | string(50) | Тип района в регионе |
data.area | string(150) | Район в регионе |
data.sub_area_fias_id | string(50) | ФИАС-код муниципального поселения (22.3+) |
data.sub_area_kladr_id | string(20) | КЛАДР-код муниципального поселения (22.3+) |
data.sub_area_with_type | string(150) | Муниципальное поселение с типом (22.3+) |
data.sub_area_type | string(10) | Тип муниципального поселения (сокращенный) (22.3+) |
data.sub_area_type_full | string(50) | Тип муниципального поселения (22.3+) |
data.sub_area | string(150) | Муниципальное поселение (22.3+) |
data.city_fias_id | string(50) | ФИАС-код города для Белоруссии, Узбекистана и Казахстана — код OSM для остальных стран — код Geonames |
data.city_kladr_id | string(20) | КЛАДР-код города |
data.city_with_type | string(150) | Город с типом |
data.city_type | string(10) | Тип города (сокращенный) |
data.city_type_full | string(50) | Тип города |
data.city | string(150) | Город |
data.city_district_fias_id | string(50) | Не заполняется |
data.city_district_kladr_id | string(20) | Не заполняется |
data.city_district_with_type ** | string(150) | Адм. район города с типом |
data.city_district_type ** | string(10) | Тип адм. района города (сокращенный) |
data.city_district_type_full ** | string(50) | Тип адм. района города |
data.city_district ** | string(150) | Адм. район города |
data.settlement_fias_id | string(50) | ФИАС-код нас. пункта для Белоруссии, Узбекистана и Казахстана — код OSM для остальных стран — код Geonames |
data.settlement_kladr_id | string(20) | КЛАДР-код нас. пункта |
data.settlement_with_type | string(150) | Населенный пункт с типом |
data.settlement_type | string(20) | Тип населенного пункта (сокращенный) |
data.settlement_type_full | string(50) | Тип населенного пункта |
data.settlement | string(150) | Населенный пункт |
data.street_fias_id | string(50) | ФИАС-код улицы для Белоруссии, Узбекистана и Казахстана — код OSM для остальных стран — код Geonames |
data.street_kladr_id | string(20) | КЛАДР-код улицы |
data.street_with_type | string(150) | Улица с типом |
data.street_type | string(10) | Тип улицы (сокращенный) |
data.street_type_full | string(50) | Тип улицы |
data.street | string(150) | Улица |
data.stead_fias_id | string(50) | ФИАС-код участка (21.12+) |
data.stead_type | string(10) | Тип участка (сокращенный) (21.12+) |
data.stead_type_full | string(50) | Тип участка (21.12+) |
data.stead | string(50) | Участок (21.12+) |
data.house_fias_id | string(50) | ФИАС-код дома для Белоруссии, Узбекистана и Казахстана — код OSM для остальных стран — код Geonames |
data.house_kladr_id | string(20) | КЛАДР-код дома |
data.house_type | string(10) | Тип дома (сокращенный) |
data.house_type_full | string(50) | Тип дома |
data.house | string(50) | Дом |
data.block_type | string(10) | Тип корпуса/строения (сокращенный) |
data.block_type_full | string(50) | Тип корпуса/строения |
data.block | string(50) | Корпус/строение |
data.flat_fias_id | string(50) | ФИАС-код квартиры ( 20.10+) |
data.flat_type | string(10) | Тип квартиры (сокращенный) |
data.flat_type_full | string(50) | Тип квартиры |
data.flat | string(50) | Квартира |
data.room_fias_id | string(50) | ФИАС-код комнаты (22.8+) |
data.room_type | string(10) | Тип комнаты (сокращенный) (22.8+) |
data.room_type_full | string(50) | Тип комнаты (22.8+) |
data.room | string(50) | Комната (22.8+) |
data.postal_box | string(50) | Абонентский ящик |
data.fias_id | string(50) | ФИАС-код адреса |
data.fias_level | string(10) | Уровень детализации, до которого адрес найден в ФИАС:
|
data.kladr_id | string(20) | КЛАДР-код адреса |
data.geoname_id | string(20) | Идентификатор объекта в международной базе GeoNames. |
data.capital_marker | string(10) | Признак центра района или региона:
|
data.okato | string(20) | Код ОКАТО |
data.oktmo | string(20) | Код ОКТМО |
data.tax_office | string(10) | Код ИФНС для физических лиц |
data.tax_office_legal | string(10) | Код ИФНС для организаций |
data.source | string(250) | Для организаций — адрес как в ЕГРЮЛ. |
data.history_values[ ] | string[](250) | Список исторических названий объекта нижнего уровня. |
Дополнительные поля, заполняются в зависимости от тарифа «Дадаты» * | ||
Все тарифы «Дадаты» | ||
data.geo_lat | string(20) | Координаты: широта |
data.geo_lon | string(20) | Координаты: долгота |
data.qc_geo | string(10) | Код точности координат:
|
data.fias_actuality_state | string(10) | Признак актуальности адреса в ФИАС:
|
data.city_area | string(150) | Административный округ (только для Москвы) |
Тарифы «Расширенный» и «Максимальный» | ||
data.beltway_hit | string(10) | Внутри кольцевой? |
data.beltway_distance | string(10) | Расстояние от кольцевой в километрах |
Тариф «Максимальный» | ||
data.stead_cadnum | string(100) | Кадастровый номер участка (22.4+), |
data.house_cadnum | string(100) | Кадастровый номер дома (22.4+) |
data.house_flat_count | string(10) | Количество квартир в доме (24.3+) |
data.flat_cadnum | string(100) | Кадастровый номер квартиры (22.4+) |
data.flat_area | string(50) | Площадь квартиры |
data.square_meter_price | string(50) | Рыночная стоимость м² |
data.flat_price | string(50) | Рыночная стоимость квартиры |
data.room_cadnum | string(100) | Кадастровый номер комнаты (22.8+) |
data.timezone | string(50) | Часовой пояс |
data.metro[ ] ** └ name └ line └ distance | string(50) string(50) double | Ближайшие станции метро (не более 3 станций в радиусе 5 км): — название станции — название линии — расстояние до станции в километрах |
Не заполняются | ||
data.entrance | string(10) | Подъезд (21.1+) |
data.floor | string(10) | Этаж (21.1+) |
data.fias_code | string(50) | Классификационный код ФИАС |
data.qc_complete | string(10) | Код пригодности к рассылке |
data.qc_house | string(10) | Код проверки дома |
data.qc | string(10) | Код проверки |
data.unparsed_parts | string(250) | Нераспознанная часть адреса |
data.divisions | {} | Поля адреса в Административно-территориальном и Муниципальном деленииях (22.3+) |
data.custom | [ ] | Зарезервировано (23.5+) |
* Для «коробки» заполненность полей зависит от лицензии. Уточните детали в технической поддержке.
** Поля заполняются при выборе конкретной подсказки или через метод API findById. До этого они пустые.
value
- postal_code (индекс),
- country (страна),
- region_with_type (регион с типом),
- area_with_type (район в регионе с типом),
- sub_area_with_type (мун. поселение с типом),
- city_with_type (город с типом),
- city_district_with_type (адм. район города с типом),
- settlement_with_type (населенный пункт с типом),
- street_with_type (улица с типом),
- stead_type (тип участка),
- stead (участок),
- house_type (тип дома),
- house (дом),
- block_type (тип корпуса/строения),
- block (корпус/строение),
- flat_type (тип квартиры),
- flat (квартира),
- room_type (тип комнаты),
- room (комната).
При этом действуют правила, описанные ниже.
Индекс
Обычно индекс (поле postal_code) не пишется. Но если в списке подсказок получаются полные дубли (обычно такое бывает, если в городе несколько улиц с одинаковым названием), и дописывание района города не помогло разрешить неоднозначность (обычно такое бывает, если район для улиц неизвестен) — то индекс пишется.
Страна
Обычно страна (поле country) не пишется. Но для международных подсказок (если в параметрах запроса явно задано ограничение на страну помимо России) — пишется.
Города-регионы и города-районы
Для городов-регионов (например, Москва) пишется регион (region_with_type), но не одноименный город (city_with_type).
Для городов-районов (например, Одинцово в Московской области) пишется район (area_with_type), но не одноименный город (city_with_type).
Областные и районные центры
Если город — областной центр, регион (region_with_type) не пишется (Новосибирская обл, г Новосибирск → г Новосибирск);
Если город — центр района, район (area_with_type) не пишется (Респ Татарстан, Верхнеуслонский р-н, село Верхний Услон → Респ Татарстан, село Верхний Услон).
Сокращенная запись муниципального деления
Для адресов в муниципальном делении действуют правила, которые записывают адрес в удобочитаемом виде (мун. деление в оригинале очень громоздкое). Примеры:
region_with_type: Московская обл area_with_type: г.о. Одинцовский city_with_type: г Одинцово → value = Московская обл, г Одинцово region_with_type: г Москва area_with_type: вн.тер.г. городской округ Щербинка city_with_type: г Щербинка street_with_type: Остафьевское шоссе → value = г Москва, г Щербинка, Остафьевское шоссе region_with_type: г Москва area_with_type: вн.тер.г. муниципальный округ Северное Медведково street_with_type: ул Сухонская house_type: д house: 11 → value = г Москва, ул Сухонская, д 11 region_with_type: Самарская обл area_with_type: г.о. Самара sub_area_with_type: вн.р-н Железнодорожный city_with_type: г Самара street_with_type: ул Сакко и Ванцетти house_type: д house: 20 → value = Самарская обл, г Самара, ул Сакко и Ванцетти, д 20
Район города
Обычно район города (в адм. делении это поле city_district_with_type, в мун. делении может быть в area_with_type или в sub_area_with_type) не пишется. Но если в списке подсказок получаются полные дубли (обычно такое бывает, если в городе несколько улиц с одинаковым названием, например улица 8 Марта в Москве) — то район пишется.
Параметр restrict_value
Если в запросе указан параметр restrict_value, то в поле value возвращается только часть адреса, которая подходит под ограничение. Например:
region = Москва, restrict_value = false, query = сакко → value = г Самара, ул Сакко и Ванцетти region = Москва, restrict_value = true, query = сакко → value = ул Сакко и Ванцетти
unrestricted_value
- postal_code (индекс),
- country (страна),
- region_with_type (регион с типом),
- area_with_type (район в регионе с типом),
- sub_area_with_type (мун. поселение с типом),
- city_with_type (город с типом),
- city_district_with_type (адм. район города с типом),
- settlement_with_type (населенный пункт с типом),
- street_with_type (улица с типом),
- stead_type (тип участка),
- stead (участок),
- house_type (тип дома),
- house (дом),
- block_type (тип корпуса/строения),
- block (корпус/строение),
- flat_type (тип квартиры),
- flat (квартира),
- room_type (тип комнаты),
- room (комната).
При этом действуют правила, описанные ниже.
Страна
Обычно страна (поле country) не пишется. Но для международных подсказок (если в параметрах запроса явно задано ограничение на страну помимо России) — пишется.
Города-регионы и города-районы
Для городов-регионов (например, Москва) пишется регион (region_with_type), но не одноименный город (city_with_type).
Для городов-районов (например, Одинцово в Московской области) пишется район (area_with_type), но не одноименный город (city_with_type).
Административное и муниципальное деление
Работает в «Подсказках» 22.4+
Подсказки могут возвращать адрес в административном либо в муниципальном делении. Это регулирует параметр запроса division
:
administrative
— административное;municipal
— муниципальное.
Если параметр не задан, используется административное деление.
В муниципальном делении возвращаются поля area*
(муниципальный район) и sub_area*
(муниципальное поселение). Поля city_district*
(административный район города), напротив, скрываются.
В административном делении возвращаются поля area*
(административный район региона) и city_district*
(административный район города). Поля sub_area*
(муниципальное поселение), напротив, скрываются.
Примеры
Запрос
{ "query": "5f96fd6b-b3de-451f-b280-8fedf859e683" }
либо
{ "query": "77000000000292300" }
Ответ:
{ "suggestions": [ { "value": "г Москва, ул Трехгорный Вал", "unrestricted_value": "г Москва, ул Трехгорный Вал", "data": { "qc_complete": null, "qc_house": null, "qc_geo": "2", "postal_code": "123022", "postal_box": null, "country": "Россия", "region_with_type": "г Москва", "region_type": "г", "region_type_full": "город", "region": "Москва", "area_with_type": null, "area_type": null, "area_type_full": null, "area": null, "city_with_type": "г Москва", "city_type": "г", "city_type_full": "город", "city": "Москва", "city_district": null, "settlement_with_type": null, "settlement_type": null, "settlement_type_full": null, "settlement": null, "street_with_type": "ул Трехгорный Вал", "street_type": "ул", "street_type_full": "улица", "street": "Трехгорный Вал", "house_type": null, "house_type_full": null, "house": null, "block_type": null, "block": null, "flat_area": null, "flat_type": null, "flat": null, "fias_id": "5f96fd6b-b3de-451f-b280-8fedf859e683", "kladr_id": "77000000000292300", "tax_office": "7703", "tax_office_legal": null, "okato": "45286575000", "oktmo": "45380000", "geo_lat": "55.7604033", "geo_lon": "37.5610847", "unparsed_parts": null, "qc": null } } ] }
Запрос:
<req> <query>5f96fd6b-b3de-451f-b280-8fedf859e683</query> </req>
Ответ:
<SuggestResponse> <suggestions> <value>г Москва, ул Трехгорный Вал</value> <unrestricted_value>г Москва, ул Трехгорный Вал</unrestricted_value> <data> <qc_complete/> <qc_house/> <qc_geo>2</qc_geo> <postal_code>123022</postal_code> <postal_box/> <country>Россия</country> <region_with_type>г Москва</region_with_type> <region_type>г</region_type> <region_type_full>город</region_type_full> <region>Москва</region> <area_with_type/> <area_type/> <area_type_full/> <area/> <city_with_type>г Москва</city_with_type> <city_type>г</city_type> <city_type_full>город</city_type_full> <city>Москва</city> <city_district/> <settlement_with_type/> <settlement_type/> <settlement_type_full/> <settlement/> <street_with_type>ул Трехгорный Вал</street_with_type> <street_type>ул</street_type> <street_type_full>улица</street_type_full> <street>Трехгорный Вал</street> <house_type/> <house_type_full/> <house/> <block_type/> <block/> <flat_area/> <flat_type/> <flat/> <fias_id>5f96fd6b-b3de-451f-b280-8fedf859e683</fias_id> <kladr_id>77000000000292300</kladr_id> <tax_office>7703</tax_office> <tax_office_legal/> <okato>45286575000</okato> <oktmo>45380000</oktmo> <geo_lat>55.7604033</geo_lat> <geo_lon>37.5610847</geo_lon> <unparsed_parts/> <qc/> </data> </suggestions> </SuggestResponse>
- Нет меток