↑ API подсказок

API подсказок по банкам

Что умеет

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

  • по БИК;
  • SWIFT;
  • названию (полному или краткому);
  • адресу до улицы.

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

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

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

Как вызвать

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

Пример запроса:

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

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

  • Content-Type: application/json или application/xml.
  • Accept — аналогично.
  • ${API_KEY} — API-ключ.

Тело запроса передавайте в кодировке UTF-8.

Что в ответе

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

Пример ответа
{
    "suggestions": [
        {
            "value": "СБЕРБАНК РОССИИ",
            "unrestricted_value": "СБЕРБАНК РОССИИ",
            "data": {
                "opf": {
                    "type": "BANK",
                    "full": null,
                    "short": null
                },
                "name": {
                    "payment": "ПАО СБЕРБАНК",
                    "full": null,
                    "short": "СБЕРБАНК РОССИИ"
                },
                "bic": "044525225",
                "swift": "SABRRUMMXXX",
                "okpo": null,
                "correspondent_account": "30101810400000000225",
                "registration_number": "1481",
                "rkc": null,
                "address": {
                    "value": "г Москва, ул Вавилова, д 19",
                    "unrestricted_value": "г Москва, Академический р-н, ул Вавилова, д 19",
                    "data": { ... }
                },
                "phones": null,
                "state": {
                    "status": "ACTIVE",
                    "actuality_date": 1548201600000,
                    "registration_date": 677376000000,
                    "liquidation_date": null
                }
            }
        },
        ...
    ]
}
НазваниеОписание
valueНаименование банка
unrestricted_value= value
data.address Адрес регистрации
└ value — адрес одной строкой
стандартизован, поэтому может отличаться от записанного в справочнике БИК.
└ unrestricted_value — адрес одной строкой (полный, от региона)
стандартизован, поэтому может отличаться от записанного в справочнике БИК.
└ data — гранулярный адрес
└ data.source — адрес одной строкой как в справочнике БИК
└ data.qc — код проверки адреса
  0        — адрес распознан уверенно
  1 или 3  — требуется ручная проверка
data.bicБанковский идентификационный код (БИК) ЦБ РФ
data.swiftБанковский идентификационный код в системе SWIFT
data.registration_numberРегистрационный номер в ЦБ РФ
data.correspondent_accountКорреспондентский счет в ЦБ РФ
data.name Наименование
└ payment — платежное наименование
└ full — не заполняется
└ short — краткое наименование
data.okpoНе заполняется
data.opf Тип кредитной организации
└ type — код типа:
  BANK        — банк
  BANK_BRANCH — филиал банка
  NKO         — небанковская кредитная организация (НКО)
  NKO_BRANCH  — филиал НКО
  RKC         — расчетно-кассовый центр
  OTHER       — другой
└ full — не заполняется
└ short — не заполняется
data.phoneНе заполняется
data.rkcНе заполняется
data.state Состояние
└ actuality_date — дата актуальности сведений
└ registration_date — дата регистрации
└ liquidation_date — дата ликвидации
└ status — статус организации
  ACTIVE      — действующая
  LIQUIDATING — ликвидируется
  LIQUIDATED  — ликвидирована

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

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

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

Заголовки и параметры

Фильтр: действующий / ликвидирован

Фильтр: банк / филиал / НКО

Фильтр по региону и городу

Приоритет города при ранжировании

Ограничения

Количество условий в параметрах locations и locations_boost — не более 10.

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

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

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

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

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

Скорее всего, он ликвидирован. «Дадата» не подсказывает большинство ликвидированных банков, потому что их нет в справочнике Банка России.

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

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

Подсказки не работают: ошибка 403 Forbidden (Feature SUGGESTIONS disabled for token)

Возможные причины:

  • Не подтверждён адрес эл. почты. Проверьте почтовый ящик и папку «спам» — там должно быть письмо от «Дадаты».
  • В запросе указан неправильный API-ключ. Проверьте в личном кабинете
  • Исчерпан лимит запросов на день. Проверьте в личном кабинете
  • Вы делаете запросы с сервера, при этом настроена привязка к домену. Отключите привязку к домену, либо делайте запросы из браузера.
Что будет, если превысить 10 000 бесплатных запросов в день?

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

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

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

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

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

Если вы используете и jQuery-плагин, и работу через API — привязку к домену придётся отключить (иначе она «не пропустит» API-запросы). Мы рекомендуем использовать что-то одно — или плагин, или API — но не оба способа одновременно.

Стоимость

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

ajax-spinner

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

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

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

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

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