API подсказок

Что умеет

Подсказывает ФИО одной строкой или отдельно фамилию, имя, отчество.

Исправляет клавиатурную раскладку («fynjy» → «Антон»).

Определяет пол.

Ранжирует по распространенности («Евгений» > «Евгениус», «Кузнецов» > «Кузнечиков»).

Ищет адреса:

  • по любой части адреса от региона до дома («тверская нижний 12» → «Нижегородская обл, г Нижний Новгород, ул Тверская, д 12»);
  • почтовому индексу («105568» → «г Москва, ул Магнитогорская»);
  • коду КЛАДР или ФИАС (до улицы).

Находит актуальные адреса по историческим названиям (Свердловск → Екатеринбург) и синонимам (Питер → Санкт-Петербург).

Понимает слитное и раздельное написание домов («Москва Тверская 6с5», «зеленоград к1104», «Москва Никольская 19 - 21 строение 1»).

Ищет по частичному совпадению («москва болот» → «г Москва, Болотная наб»), но только в последнем слове запроса («мос болот» не найдет).

Исправляет опечатки («самара авиционная») и запросы в неправильной раскладке («vjcrdf» → «москва»).

Парсит адрес одной строкой на гранулярные части (до квартиры).

Поддерживает гранулярные подсказки по отдельным частям адреса (регионы, города, улицы, дома).

Подсказывает адреса в конкретных регионах, районах, городах и населенных пунктах. Понимает названия («Петергоф»), коды КЛАДР («7800000800000») и ФИАС («8f238984-812b-4bb1-850b-49749fb5c56d»).

Подсказывает именно те адреса, которые вы и имели в виду. Учитывает, где вы находитесь (геолокация до города).

Ищет организации и индивидуальных предпринимателей:

  • по ИНН / ОГРН;
  • названию (полному, краткому, латинскому);
  • ФИО (для индивидуальных предпринимателей);
  • ФИО руководителя компании;
  • адресу до улицы.

Ищет по комбинации ИНН, названия и адреса в одном запросе («7736050003 Газ» → «ПАО Газпром», «вавилова сбер» → «ПАО Сбербанк»).

Понимает слитное и раздельное написание («БазэлЦемент» = «Базэл Цемент»).

Исправляет опечатки («идельвейс» → «Эдельвейс»).

Ищет по частичному совпадению в ИНН / ОГРН («77094209» → «ООО Акварель») и названиях («росне» → «ПАО «НК «Роснефть»).

Возвращает дополнительную информацию из ЕГРЮЛ (полный адрес, генеральный директор, дата регистрации, КПП, коды ОПФ, ОКПО и ОКВЭД).

Подсказывает только организации или только ИП, или и тех и других. Умеет искать только в действующих или ликвидированных компаниях. Может ограничить подсказки конкретным регионом России.

Ищет кредитные организации:

  • по БИК;
  • SWIFT;
  • названию (полному/краткому).

Фильтрует по типу: банки, НКО и филиалы, а также РКЦ и другие организации.

Ищет только действующие или только ликвидированные банки.

Подсказывает локальную (до «собачки») и доменную (после «собачки») части для e-mail.

Использует почтовые сервисы (yandex.ru) и популярные сайты (топ 40 тысяч рунета) в качестве доменной части.

Ранжирует по популярности сайтов в России.

Исправляет опечатки (yadex.ru → yandex.ru).

Как вызвать

  1. Зарегистрируйтесь и получите ключ
  2. Вызовите REST-метод, как в примере:
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "Викт" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/fio
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "Хабар", "count": 10 }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/address
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "сбербанк" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/party
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "сбербанк" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/bank
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "anton@" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/email

Укажите при вызове:

  • Content-Type: application/json или application/xml.
  • Accept — аналогично.
  • ${API_KEY} — API-ключ.
  • Тело запроса передавайте в кодировке UTF-8.

Что в ответе

Возвращаем объект с массивом подсказок в поле suggestions:

{
"suggestions": [
        {
            "value": "Виктор",
            "unrestricted_value": "Виктор",
            "data": {
                "surname": null,
                "name": "Виктор",
                "patronymic": null,
                "gender": "MALE",
                "qc": null
            }
        },
        ...
    ]
}
НазваниеОписание
valueФИО одной строкой (как показывается в списке подсказок)
unrestricted_valueФИО одной строкой (полное)
data.surnameФамилия
data.nameИмя
data.patronymicОтчество
data.genderПол
  • MALE — мужской;
  • FEMALE — женский;
  • UNKNOWN — не удалось однозначно определить.
data.qcКод качества (не заполняется)

Частые вопросы

Как сделать всякое

Как сделать отдельные подсказки по имени?

Как сделать гранулярные подсказки по ФИО? Чтобы отдельно фамилия, имя, отчество?

Почему не так, как ожидалось

Подсказки не работают: ошибка 403 Forbidden

Скорее всего, вы не подтвердили адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от Дадаты. Пройдите по ссылке в письме, и вы в игре.

Прочее

Что будет, если превысить 10 000 бесплатных запросов в день?

Подсказки перестанут подсказывать :–) До начала нового дня, затем снова заработают.

10 000 запросов считаются суммарно по всем видам подсказок: адреса, ФИО, организации, банки и емейлы.

Как защитить API-ключ от злоумышленников?

Если вы используете jQuery-плагин Подсказок, то API-ключ виден в исходном коде страниц вашего сайта. Чтобы злоумышленник не мог воспользоваться вашим ключом, можно привязать его к конкретному домену.

Например, если вы владелец интернет-магазина myshop.ru, то привязка ключа к этому домену запретит пользоваться им на всех остальных сайтах.

Если хотите включить привязку API-ключа к своему домену, напишите приватное сообщение в службу поддержки.

{
    "suggestions": [
        {
            "value": "г Москва, ул Хабаровская",
            "unrestricted_value": "г Москва, ул Хабаровская",
            "data": {
                "postal_code": null,
                "country": "Россия",
                "region_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "region_kladr_id": "7700000000000",
                "region_with_type": "г Москва",
                "region_type": "г",
                "region_type_full": "город",
                "region": "Москва",
                "area_fias_id": null,
                "area_kladr_id": null,
                "area_with_type": null,
                "area_type": null,
                "area_type_full": null,
                "area": null,
                "city_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "city_kladr_id": "7700000000000",
                "city_with_type": "г Москва",
                "city_type": "г",
                "city_type_full": "город",
                "city": "Москва",
                "city_area": null,
                "city_district": null,
                "city_district_fias_id": null,
                "city_district_kladr_id": null,
                "city_district_with_type": null,
                "city_district_type": null,
                "city_district_type_full": null,
                "settlement_fias_id": null,
                "settlement_kladr_id": null,
                "settlement_with_type": null,
                "settlement_type": null,
                "settlement_type_full": null,
                "settlement": null,
                "street_fias_id": "32fcb102-2a50-44c9-a00e-806420f448ea",
                "street_kladr_id": "77000000000713400",
                "street_with_type": "ул Хабаровская",
                "street_type": "ул",
                "street_type_full": "улица",
                "street": "Хабаровская",
                "house_fias_id": null,
                "house_kladr_id": null,
                "house_type": null,
                "house_type_full": null,
                "house": null,
                "block_type": null,
                "block_type_full": null,
                "block": null,
                "flat_type": null,
                "flat_type_full": null,
                "flat": null,
                "flat_area": null,
                "square_meter_price": null,
                "flat_price": null,
                "postal_box": null,
                "fias_id": "32fcb102-2a50-44c9-a00e-806420f448ea",
                "fias_level": "7",
                "kladr_id": "77000000000713400",
                "capital_marker": "0",
                "okato": "45263564000",
                "oktmo": "45305000",
                "tax_office": "7718",
                "tax_office_legal": null,
                "timezone": null,
                "geo_lat": null,
                "geo_lon": null,
                "beltway_hit": null,
                "beltway_distance": null,
                "qc_geo": null,
                "qc_complete": null,
                "qc_house": null,
                "unparsed_parts": null,
                "qc": null
            }
        },
        ...
    ]
}
НазваниеОписание
valueАдрес одной строкой (как показывается в списке подсказок)
unrestricted_valueАдрес одной строкой (полный, от региона)
data.postal_codeИндекс
data.countryСтрана
data.region_fias_idКод ФИАС региона
data.region_kladr_idКод КЛАДР региона
data.region_with_typeРегион с типом
data.region_typeТип региона (сокращенный)
data.region_type_fullТип региона
data.regionРегион
data.area_fias_idКод ФИАС района в регионе
data.area_kladr_idКод КЛАДР района в регионе
data.area_with_typeРайон в регионе с типом
data.area_typeТип района в регионе (сокращенный)
data.area_type_fullТип района в регионе
data.areaРайон в регионе
data.city_fias_idКод ФИАС города
data.city_kladr_idКод КЛАДР города
data.city_with_typeГород с типом
data.city_typeТип города (сокращенный)
data.city_type_fullТип города
data.cityГород
data.city_areaАдминистративный округ (только для Москвы)
data.city_district_fias_idКод ФИАС района города (заполняется, только если район есть в ФИАС)
data.city_district_kladr_idКод КЛАДР района города (не заполняется)
data.city_district_with_typeРайон города с типом
data.city_district_typeТип района города (сокращенный)
data.city_district_type_fullТип района города
data.city_districtРайон города
data.settlement_fias_idКод ФИАС нас. пункта
data.settlement_kladr_idКод КЛАДР нас. пункта
data.settlement_with_typeНаселенный пункт с типом
data.settlement_typeТип населенного пункта (сокращенный)
data.settlement_type_fullТип населенного пункта
data.settlementНаселенный пункт
data.street_fias_idКод ФИАС улицы
data.street_kladr_idКод КЛАДР улицы
data.street_with_typeУлица с типом
data.street_typeТип улицы (сокращенный)
data.street_type_fullТип улицы
data.streetУлица
data.house_fias_idКод ФИАС дома
data.house_kladr_idКод КЛАДР дома
data.house_typeТип дома (сокращенный)
data.house_type_fullТип дома
data.houseДом
data.block_typeТип корпуса/строения (сокращенный)
data.block_type_fullТип корпуса/строения
data.blockКорпус/строение
data.flat_typeТип квартиры (сокращенный)
data.flat_type_fullТип квартиры
data.flatКвартира
data.flat_areaПлощадь квартиры (не заполняется)
data.square_meter_priceРыночная стоимость м² (не заполняется)
data.flat_priceРыночная стоимость квартиры (не заполняется)
data.postal_boxАбонентский ящик
data.fias_id Код ФИАС:
  • HOUSE.HOUSEGUID, если дом найден в ФИАС по точному совпадению;
  • HOUSEINT.INTGUID, если дом найден в ФИАС как часть интервала;
  • ADDROBJ.AOGUID в противном случае.
data.fias_levelУровень детализации, до которого адрес найден в ФИАС:
  • 0 — страна;
  • 1 — регион;
  • 3 — район;
  • 4 — город;
  • 5 — район города;
  • 6 — населенный пункт;
  • 7 — улица;
  • 8 — дом;
  • 90 — доп. территория;
  • 91 — улица в доп. территории;
  • -1 — иностранный или пустой.
data.kladr_idКод КЛАДР
data.capital_markerПризнак центра района или региона:
  • 1 — центр района (Московская обл, Одинцовский р-н, г Одинцово)
  • 2 — центр региона (Новосибирская обл, г Новосибирск);
  • 3 — центр района и региона (Томская обл, г Томск);
  • 4 — центральный район региона (Тюменская обл, Тюменский р-н);
  • 0 — ничего из перечисленного (Московская обл, г Балашиха).
data.okatoКод ОКАТО
data.oktmoКод ОКТМО
data.tax_officeКод ИФНС для физических лиц
data.tax_office_legalКод ИФНС для организаций (не заполняется)
data.timezoneЧасовой пояс (не заполняется)
data.geo_latКоординаты: широта
data.geo_lonКоординаты: долгота
data.beltway_hitВнутри кольцевой? (не заполняется)
data.beltway_distanceРасстояние от кольцевой в км (не заполняется)
data.qc_geoКод точности координат
data.qc_completeКод пригодности к рассылке (не заполняется)
data.qc_houseКод проверки дома (не заполняется)
data.qcКод проверки (не заполняется)
data.unparsed_partsНераспознанная часть адреса (не заполняется)

Подсказки заполняют поля geo_*, city_district, city_area, если указать в запросе параметр count = 1. Иначе оставляют их пустыми.

Частые вопросы

Как сделать всякое

Как сделать гранулярные подсказки по адресу? Чтобы отдельно город, улица, дом?

Как разложить адрес по полям? Индекс, регион, город, улица, дом, квартира?

Как подсказывать только внутри конкретного города или области?

Как заставить подсказки учитывать местонахождение пользователя?

Подсказки делают это «из коробки»: определяют город пользователя по IP-адресу и подсказывают ближайшие варианты.

Как отключить геолокацию?

Передайте параметр geoLocation = false.

Как подсказывать только город?

Пример: подсказки по городам

Пример: подсказки по городам и населенным пунктам

Почему не так, как ожидалось

Почему индекс неправильный — не такой, как у Почты России?

Если получили от Дадаты неправильный индекс — напишите в службу поддержки.

Дадата работает по объединенному справочнику налоговой службы (ФИАС) и Почты России. В нем исправлены более 7 000 некорректных и отсутствующих индексов.

К сожалению, справочник индексов Почты детализирован только до населенных пунктов. Привязки к улицам и домам нет. Поэтому все-все индексы исправить не удалось, однако мы готовы оперативно исправлять их по вашим обращениям.

Надеемся, что в 2017 году Почта выпустит базу индексов с привязкой к домам и улицам. Тогда проблема неправильных индексов уйдет навсегда.

Почему подсказки не возвращают геокоординаты и район города?

Подсказки возвращают геокоординаты и район после того, как человек выбрал конкретный адрес из списка.

В API это запрос с параметром count = 1.

Почему подсказки не возвращают часовой пояс и коды качества?

Подсказки возвращают только базовую информацию по адресу. Полная информация об адресе — в стандартизации.

Почему на картах дом есть, а в подсказках — нет?

Подсказки используют справочник адресов налоговой службы (ФИАС). В нем нет некоторых реально существующих домов и строений. К сожалению, более полной базы, чем ФИАС, просто не существует.

Почему вернулся неправильный КЛАДР-код дома?

Подсказки работают по справочнику адресов налоговой службы (ФИАС).
В ФИАС нет кодов КЛАДР для домов.

Поэтому код дома (последние четыре цифры в коде КЛАДР) подсказки берут из поля «Счетчик записей домов для КЛАДР 4» (COUNTER). Эти коды часто отличаются от указанных в КЛАДРе.

Впрочем, в самом КЛАДРе с каждым обновлением базы коды домов меняются, поэтому использовать их в качестве «постоянного» идентификатора адреса невозможно.

Мы рекомендуем для идентификации адреса использовать код ФИАС до улицы + дом + квартиру.

Подробности в статье на Хабре

Подсказки не работают: ошибка 403 Forbidden

Скорее всего, вы не подтвердили адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от Дадаты. Пройдите по ссылке в письме, и вы в игре.

Прочее

Что будет, если превысить 10 000 бесплатных запросов в день?

Подсказки перестанут подсказывать :–) До начала нового дня, затем снова заработают.

10 000 запросов считаются суммарно по всем видам подсказок: адреса, ФИО, организации, банки и емейлы.

Как защитить API-ключ от злоумышленников?

Если вы используете jQuery-плагин Подсказок, то API-ключ виден в исходном коде страниц вашего сайта. Чтобы злоумышленник не мог воспользоваться вашим ключом, можно привязать его к конкретному домену.

Например, если вы владелец интернет-магазина myshop.ru, то привязка ключа к этому домену запретит пользоваться им на всех остальных сайтах.

Если хотите включить привязку API-ключа к своему домену, напишите приватное сообщение в службу поддержки.

Есть ли подсказки по адресам Украины, Белоруссии и Казахстана?

Пока нет. Возможно, в будущем появятся, но сроков пока нет.

Как часто обновляется справочник адресов (ФИАС)?

В течение двух дней после выхода обновления в налоговой. При условии, что в налоговой ничего не разломали (это случается).

{
    "suggestions": [
        {
            "value": "ПАО СБЕРБАНК",
            "unrestricted_value": "ПАО СБЕРБАНК",
            "data": {
                "kpp": "775001001",
                "management": {
                    "name": "Греф Герман Оскарович",
                    "post": "Президент-председатель правления"
                },
                "branch_type": "MAIN",
                "branch_count": 1,
                "type": "LEGAL",
                "opf": {
                    "code": "12247",
                    "full": "Публичное акционерное общество",
                    "short": "ПАО"
                },
                "name": {
                    "full_with_opf": "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"СБЕРБАНК РОССИИ\"",
                    "short_with_opf": "ПАО СБЕРБАНК",
                    "latin": null,
                    "full": "СБЕРБАНК РОССИИ",
                    "short": "СБЕРБАНК"
                },
                "inn": "7707083893",
                "ogrn": "1027700132195",
                "okpo": null,
                "okved": null,
                "state": {
                    "status": "ACTIVE",
                    "actuality_date": 1443312000000,
                    "registration_date": 677376000000,
                    "liquidation_date": null
                },
                "address": {
                    "value": "г Москва, ул Вавилова, д 19",
                    "unrestricted_value": "г Москва, ул Вавилова, д 19",
                    "data": { ... }
                }
            }
        },
        ...
    ]
}
НазваниеОписание
valueНаименование компании одной строкой (как показывается в списке подсказок)
unrestricted_valueНаименование компании одной строкой (полное)
data.address.valueАдрес одной строкой:
  • адрес организации для юридических лиц;
  • город проживания для индивидуальных предпринимателей.
data.address.unrestricted_valueАдрес одной строкой (полный, от региона)
data.address.dataГранулярный адрес. Может отсутствовать
data.branch_countКоличество филиалов
data.branch_typeТип подразделения
  • MAIN — головная организация;
  • BRANCH — филиал.
data.innИНН
data.kppКПП
data.management.nameФИО руководителя
data.management.postДолжность руководителя
data.name.full_with_opfПолное наименование с ОПФ
data.name.short_with_opfКраткое наименование с ОПФ
data.name.latinНаименование на латинице
data.name.fullПолное наименование
data.name.shortКраткое наименование
data.ogrnОГРН
data.okpoКод ОКПО (не заполняется)
data.okvedКод ОКВЭД
data.opf.codeКод ОКОПФ
data.opf.fullПолное название ОПФ
data.opf.shortКраткое название ОПФ
data.state.actuality_dateДата актуальности сведений
data.state.registration_dateДата регистрации
data.state.liquidation_dateДата ликвидации
data.state.statusСтатус организации
  • ACTIVE — действующая;
  • LIQUIDATING — ликвидируется;
  • LIQUIDATED — ликвидирована.
data.typeТип организации
  • LEGAL — юридическое лицо;
  • INDIVIDUAL — индивидуальный предприниматель.

Частые вопросы

Как сделать всякое

Как разложить компанию по полям? Наименование, ИНН, КПП, адрес?

Как подсказывать компании, зарегистрированные в конкретном городе или области?

Как подсказывать только индивидуальных предпринимателей?

Как подсказывать ликвидированные компании?

Как заставить подсказки учитывать местонахождение пользователя?

Подсказки делают это «из коробки»: определяют город пользователя по IP-адресу и подсказывают ближайшие варианты.

Как отключить геолокацию?

Передайте параметр geoLocation = false.

Почему не так, как ожидалось

Почему не находится организация? Я точно знаю, она должна быть

Скорее всего, организация недавно зарегистрирована в ФНС, и мы еще не успели получить информацию о ней из налоговой. Отставание Дадаты от сайта налоговой (egrul.nalog.ru) не более 3 дней, так что организация скоро появится.

Подсказки не работают: ошибка 403 Forbidden

Скорее всего, вы не подтвердили адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от Дадаты. Пройдите по ссылке в письме, и вы в игре.

Прочее

Что будет, если превысить 10 000 бесплатных запросов в день?

Подсказки перестанут подсказывать :–) До начала нового дня, затем снова заработают.

10 000 запросов считаются суммарно по всем видам подсказок: адреса, ФИО, организации, банки и емейлы.

Как защитить API-ключ от злоумышленников?

Если вы используете jQuery-плагин Подсказок, то API-ключ виден в исходном коде страниц вашего сайта. Чтобы злоумышленник не мог воспользоваться вашим ключом, можно привязать его к конкретному домену.

Например, если вы владелец интернет-магазина myshop.ru, то привязка ключа к этому домену запретит пользоваться им на всех остальных сайтах.

Если хотите включить привязку API-ключа к своему домену, напишите приватное сообщение в службу поддержки.

Как часто обновляется справочник компаний (ЕГРЮЛ)?

По мере поступления обновлений от налоговой службы. Отставание от сайта налоговой (egrul.nalog.ru) не более 3 дней.

{
    "suggestions": [
        {
            "value": "ПАО СБЕРБАНК",
            "unrestricted_value": "ПАО СБЕРБАНК",
            "data": {
                "opf": {
                    "type": "BANK",
                    "full": "Сбербанк России",
                    "short": "СБ"
                },
                "name": {
                    "payment": "ПАО СБЕРБАНК",
                    "full": "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"СБЕРБАНК РОССИИ\"",
                    "short": "ПАО СБЕРБАНК"
                },
                "bic": "044525225",
                "swift": "SABRRUMMXXX",
                "okpo": "00032537",
                "correspondent_account": "30101810400000000225",
                "registration_number": "1481",
                "rkc": {
                    "opf": {
                        "type": "RKC",
                        "full": "Главное управление/Отделение (НБ)",
                        "short": "ГУ/О"
                    },
                    "name": {
                        "payment": "ГУ БАНКА РОССИИ ПО ЦФО",
                        "full": null,
                        "short": null
                    },
                    "bic": "044525000",
                    "swift": null,
                    "okpo": "09201220",
                    "correspondent_account": null,
                    "registration_number": null,
                    "rkc": null,
                    "address": {
                        "value": "115035, МОСКВА 35, УЛ.БАЛЧУГ,2",
                        "unrestricted_value": "115035, МОСКВА 35, УЛ.БАЛЧУГ,2",
                        "data": null
                    },
                    "phone": null,
                    "state": {
                        "status": "ACTIVE",
                        "actuality_date": 1455580800000,
                        "registration_date": 889488000000,
                        "liquidation_date": null
                    }
                },
                "address": {
                    "value": "г Москва, ул Вавилова, д 19",
                    "unrestricted_value": "г Москва, ул Вавилова, д 19",
                    "data": { ... }
                },
                "phone": null,
                "state": {
                    "status": "ACTIVE",
                    "actuality_date": 1455580800000,
                    "registration_date": 844387200000,
                    "liquidation_date": null
                }
            }
        },
        ...
    ]
}
НазваниеОписание
valueНаименование банка одной строкой (как показывается в списке подсказок)
unrestricted_valueНаименование банка одной строкой (полное)
data.address.valueАдрес регистрации одной строкой
data.address.unrestricted_valueАдрес одной строкой (полный, от региона)
data.address.dataГранулярный адрес. Может отсутствовать
data.bicБанковский идентификационный код (БИК) ЦБ РФ
data.correspondent_accountКорреспондентский счет в ЦБ РФ
data.name.paymentПлатежное наименование
data.name.fullПолное наименование
data.name.shortКраткое наименование
data.okpoКод ОКПО
data.opf.typeТип кредитной организации
  • BANK — банк;
  • BANK_BRANCH — филиал банка;
  • NKO — небанковская кредитная организация (НКО);
  • NKO_BRANCH — филиал НКО;
  • RKC — расчетно-кассовый центр;
  • OTHER — другой.
data.opf.fullТип кредитной организации (на русском)
data.opf.shortТип кредитной организации (на русском, сокращенный)
data.phoneНе заполняется
data.registration_numberРегистрационный номер в ЦБ РФ
data.rkcРасчетно-кассовый центр. Объект такой же структуры, как сам банк.
data.state.actuality_dateДата актуальности сведений
data.state.registration_dateДата регистрации
data.state.liquidation_dateДата ликвидации
data.state.statusСтатус организации
  • ACTIVE — действующая;
  • LIQUIDATING — ликвидируется;
  • LIQUIDATED — ликвидирована.
data.swiftБанковский идентификационный код в системе SWIFT

Частые вопросы

Как сделать всякое

Как разложить информацию о банке по полям? Наименование, БИК, SWIFT, адрес?

Как подсказывать ликвидированные банки

Как заставить подсказки учитывать местонахождение пользователя?

К сожалению, подсказки по банкам не умеют этого делать.

Почему не так, как ожидалось

Почему не находится банк? Я точно знаю, он должен быть

Скорее всего, он ликвидирован. Настройте подсказки для поиска по ликвидированным банкам и проверьте.

Подсказки не работают: ошибка 403 Forbidden

Скорее всего, вы не подтвердили адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от Дадаты. Пройдите по ссылке в письме, и вы в игре.

Прочее

Что будет, если превысить 10 000 бесплатных запросов в день?

Подсказки перестанут подсказывать :–) До начала нового дня, затем снова заработают.

10 000 запросов считаются суммарно по всем видам подсказок: адреса, ФИО, организации, банки и емейлы.

Как защитить API-ключ от злоумышленников?

Если вы используете jQuery-плагин Подсказок, то API-ключ виден в исходном коде страниц вашего сайта. Чтобы злоумышленник не мог воспользоваться вашим ключом, можно привязать его к конкретному домену.

Например, если вы владелец интернет-магазина myshop.ru, то привязка ключа к этому домену запретит пользоваться им на всех остальных сайтах.

Если хотите включить привязку API-ключа к своему домену, напишите приватное сообщение в службу поддержки.

Как часто обновляется справочник банков?

Каждый день. Мы берем его с сайта Банка России.

{
    "suggestions": [
        {
            "value": "anton@mail.ru",
            "unrestricted_value": "anton@mail.ru",
            "data": {
                "local": "anton",
                "domain": "mail.ru",
                "qc": null
            }
        },
        ...
    ]
}
НазваниеОписание
valueEmail одной строкой (как показывается в списке подсказок)
unrestricted_valueEmail одной строкой (полный)
data.localИменная часть
data.domainДоменная часть
data.qcКод качества (не заполняется)

Частые вопросы

Как сделать всякое

Как подсказывать только по доменной части емейла (которая после «собачки»)?

Установите параметр suggest_local = false

Подсказки не работают: ошибка 403 Forbidden

Скорее всего, вы не подтвердили адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от Дадаты. Пройдите по ссылке в письме, и вы в игре.

Прочее

Что будет, если превысить 10 000 бесплатных запросов в день?

Подсказки перестанут подсказывать :–) До начала нового дня, затем снова заработают.

10 000 запросов считаются суммарно по всем видам подсказок: адреса, ФИО, организации, банки и емейлы.

Как защитить API-ключ от злоумышленников?

Если вы используете jQuery-плагин Подсказок, то API-ключ виден в исходном коде страниц вашего сайта. Чтобы злоумышленник не мог воспользоваться вашим ключом, можно привязать его к конкретному домену.

Например, если вы владелец интернет-магазина myshop.ru, то привязка ключа к этому домену запретит пользоваться им на всех остальных сайтах.

Если хотите включить привязку API-ключа к своему домену, напишите приватное сообщение в службу поддержки.

Коды ответа на запрос

HTTP-код ответа Описание
200 Запрос успешно обработан
400 Некорректный запрос
401 В запросе отсутствует API-ключ
403 В запросе указан несуществующий API-ключ
405 Запрос сделан с методом, отличным от POST
413 Нарушены ограничения
5xx Произошла внутренняя ошибка сервиса во время обработки

Ограничения

Количество запросов в день — в соответствии с тарифным планом.

Длина запроса (параметр query) — не более 300 символов.

Количество условий (параметры locations и locations_boost) — не более 100.

Максимальная частота запросов — 30 в секунду.

Стоимость

API подсказок бесплатно до 10 тысяч запросов в день. Больше — в составе годовой подписки на Подсказки.

Примеры вызова


Примеры настройки подсказок

Подробная документация

Служба поддержки

ajax-spinner

Зарегистрируйтесь, чтобы подключить подсказки

до 10 тыс запросов бесплатно

чтобы обращаться к вам в письмах

Регистрируясь, вы принимаете публичную оферту

Уже зарегистрированы? Войти