API подсказок по ФИО

Что умеет и не умеет

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

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

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

Не умеет:

❌ Автоматически (без участия человека) обработать ФИО из базы или файла.

❌ Транслитерировать (Juliia Somova → Юлия Сомова).

❌ Склонять по падежам (кого? кому? кем?).

Подсказки не подходят для автоматической обработки ФИО. Они предлагают варианты, но не гарантируют, что угадали правильно. Поэтому окончательное решение всегда должен принимать человек.

Для автоматической обработки, транслитерации и склонения по падежам используйте API Стандартизации

Как вызвать

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

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

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

// https://github.com/hflabs/dadata-csharp

var token = "${API_KEY}";
var api = new SuggestClientAsync(token);
var result = await api.SuggestName("Викт");

// https://github.com/ekomobile/dadata
// Использует API-ключ из переменной окружения DADATA_API_KEY

import (
    "context"
    dadata "github.com/ekomobile/dadata/v2"
    "github.com/ekomobile/dadata/v2/api/suggest"
)

func main() {
    api := dadata.NewSuggestApi()
    params := suggest.RequestParams{Query: "викт"}
    result, err := api.Name(context.Background(), &params)
}

var url = "https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/fio";
var token = "${API_KEY}";
var query = "Викт";

var options = {
    method: "POST",
    mode: "cors",
    headers: {
        "Content-Type": "application/json",
        "Accept": "application/json",
        "Authorization": "Token " + token
    },
    body: JSON.stringify({query: query})
}

fetch(url, options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));

// https://github.com/hflabs/dadata-php

$token = "${API_KEY}";
$dadata = new \Dadata\DadataClient($token, null);
$result = $dadata->suggest("fio", "Викт");

# https://github.com/hflabs/dadata-py

from dadata import Dadata
token = "${API_KEY}"
dadata = Dadata(token)
result = dadata.suggest("fio", "Викт")

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

• 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",
                "source": null,
                "qc": "0"
            }
        },
        ...
    ]
}

  MALE    — мужской
  FEMALE  — женский
  UNKNOWN — не удалось однозначно определить

  0 — все части ФИО известны
  1 — в ФИО есть неизвестная часть

Источники данных: собственные справочники имен, фамилий и отчеств.

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

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

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

Гранулярные подсказки (отдельно фамилия, отдельно имя, отдельно отчество)

• Angular
• C# / .NET
• Excel VBA
• Go
• Java (Spring)
• Laravel
• Node.js
• PHP
• PHP (одним файлом)
• Python
• R
• React
• WinHttpRequest
• iOS
• Symfony
• 1С: ФИО

Ограничения

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

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

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

Максимальная частота создания новых соединений — 60 в минуту с одного IP-адреса.

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

Стоимость

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