API стандартизации

Нормализация ФИО и адресов. Адреса проверяются по ФИАС и дополняются координатами.

Стандартизация ФИО

POST /api/v1/clean/name

Разбирает строку с ФИО на компоненты, определяет пол, проверяет по справочникам.

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

ПараметрТипОписание
querystringФИО в произвольном формате

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

curl -X POST https://api.humandata.ru/api/v1/clean/name \
-H "Content-Type: application/json" \
-H "Authorization: Token YOUR_API_KEY" \
-d '{"query": "иванов сергей петрович"}'

Пример ответа

{
"source": "иванов сергей петрович",
"result": {
"surname": "Иванов",
"name": "Сергей",
"patronymic": "Петрович",
"gender": "m",
"qc": 0
}
}

Поля ответа

ПолеТипОписание
surnamestring | nullФамилия
namestring | nullИмя
patronymicstring | nullОтчество
genderstring | null"m" — мужской, "f" — женский
qcnumberКод качества: 0 — найдено в справочниках, 1 — неполное ФИО, 2 — не найдено

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

POST /api/v1/clean/address

Разбирает адрес на компоненты, проверяет по ФИАС, возвращает координаты. Один запрос — нормализация и геокодирование сразу.

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

ПараметрТипОписание
querystringАдрес в произвольном формате

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

curl -X POST https://api.humandata.ru/api/v1/clean/address \
-H "Content-Type: application/json" \
-H "Authorization: Token YOUR_API_KEY" \
-d '{"query": "москва ленинский 42"}'

Пример ответа

{
"source": "москва ленинский 42",
"result": {
"result": "г Москва, пр-кт Ленинский",
"region": "г Москва",
"city": null,
"street": "пр-кт Ленинский",
"house": "42",
"flat": null,
"postal_code": null,
"fias_id": "5f2a1243-a57b-418e-baee-ff76f4993b45",
"geo_lat": 55.7034,
"geo_lon": 37.5659,
"qc_geo": 0,
"qc": 0
}
}

Поля ответа

ПолеТипОписание
resultstring | nullПолный нормализованный адрес
regionstring | nullРегион (субъект РФ)
citystring | nullГород или населённый пункт
streetstring | nullУлица
housestring | nullНомер дома
flatstring | nullКвартира
postal_codestring | nullПочтовый индекс
fias_idstring | nullИдентификатор в реестре ФИАС (UUID)
geo_latnumber | nullШирота (WGS-84)
geo_lonnumber | nullДолгота (WGS-84)
qc_geonumber | nullТочность координат: 0 — дом, 2 — улица, 3 — город, 4 — не определено
qcnumberКод качества адреса: 0 — найден в ФИАС, 1 — не найден, 2 — неполный, 3 — низкая уверенность

Коды качества геокодирования (qc_geo)

КодОписание
0Координаты дома
2Координаты улицы (дом не найден)
3Координаты города (улица не найдена)
4Координаты не определены
nullГеокодирование отключено