api Finance API v1

REST API для обогащения финансовых данных

key Ваши API ключи
Загрузка ключей...
dns Базовый URL
Все запросы должны содержать заголовки X-Client-Id и X-Client-Secret для авторизации.
GET Баланс
/api/v1/balance
Проверка текущего баланса и общей суммы потраченных средств.
Пример запроса
cURL
Python
curl BASE_URL/api/v1/balance \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET"
import requests

headers = {
    "X-Client-Id": "YOUR_CLIENT_ID",
    "X-Client-Secret": "YOUR_CLIENT_SECRET",
}

response = requests.get(
    "BASE_URL/api/v1/balance",
    headers=headers
)

data = response.json()
print(f"Баланс: {data['balance']} руб.")
Пример ответа
{
  "balance": 97.50,
  "total_spent": 42.50
}
POST Единичный поиск
/api/v1/search
Поиск финансовых данных по ФИО и дате рождения. Возвращает депозиты, доходы, долги ФССП и полный JSON-ответ из базы.
Тело запроса (JSON)
ПолеТипОписание
fio * string ФИО (например "Иванов Иван Иванович")
birth_date * string Дата рождения в формате ДД.ММ.ГГГГ
Пример запроса
cURL
Python
curl -X POST BASE_URL/api/v1/search \
  -H "Content-Type: application/json" \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -d '{
    "fio": "Иванов Иван Иванович",
    "birth_date": "01.01.1990"
  }'
import requests

headers = {
    "Content-Type": "application/json",
    "X-Client-Id": "YOUR_CLIENT_ID",
    "X-Client-Secret": "YOUR_CLIENT_SECRET",
}

data = {
    "fio": "Иванов Иван Иванович",
    "birth_date": "01.01.1990"
}

response = requests.post(
    "BASE_URL/api/v1/search",
    headers=headers,
    json=data
)

print(response.json())
Пример ответа
// Полный JSON-ответ из базы данных
{
  "contacts": [ ... ],
  "addrs": [ ... ],
  "incomes": { "result": [ ... ] },
  "bank_deposit": { "deposits": [ ... ] },
  "cars": { "result": [ ... ] },
  "archive_fssp_debt_sum": 0,
  ...
}
POST Обогащение Excel
/api/v1/enrich/excel
Загрузите Excel файл (.xlsx) с именами и датами рождения. В ответ получите обогащенный Excel с финансовыми данными (депозиты, доходы, ФССП, автомобили).
Запрос (multipart/form-data)
ПолеТипОписание
file * файл .xlsx файл с колонками: ИМЯ, Дата Рождения, Телефон
Пример запроса
cURL
Python
curl -X POST BASE_URL/api/v1/enrich/excel \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -F "file=@data.xlsx" \
  -o enriched_results.xlsx
import requests

headers = {
    "X-Client-Id": "YOUR_CLIENT_ID",
    "X-Client-Secret": "YOUR_CLIENT_SECRET",
}

with open("data.xlsx", "rb") as f:
    response = requests.post(
        "BASE_URL/api/v1/enrich/excel",
        headers=headers,
        files={"file": ("data.xlsx", f)}
    )

with open("enriched_results.xlsx", "wb") as f:
    f.write(response.content)

print("Файл сохранен: enriched_results.xlsx")
Ответ -- скачивание .xlsx файла. Стоимость = цена_за_запрос * количество_строк.
POST Обогащение JSON (с фильтром по возрасту)
/api/v1/enrich/json
Отправьте массив записей с опциональным фильтром по возрасту. Обогащаются только записи, попадающие в указанный диапазон. Возвращает JSON с финансовыми данными.
Тело запроса (JSON)
ПолеТипОписание
entries * array Массив объектов с полями fio и birth_date
min_age опц. number Минимальный возраст
max_age опц. number Максимальный возраст
Пример запроса
cURL
Python
curl -X POST BASE_URL/api/v1/enrich/json \
  -H "Content-Type: application/json" \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -d '{
    "entries": [
      { "fio": "Иванов Иван Иванович", "birth_date": "01.01.1990" },
      { "fio": "Петров Петр Петрович", "birth_date": "15.06.1985" }
    ],
    "min_age": 25,
    "max_age": 60
  }'
import requests

headers = {
    "Content-Type": "application/json",
    "X-Client-Id": "YOUR_CLIENT_ID",
    "X-Client-Secret": "YOUR_CLIENT_SECRET",
}

data = {
    "entries": [
        {"fio": "Иванов Иван Иванович", "birth_date": "01.01.1990"},
        {"fio": "Петров Петр Петрович", "birth_date": "15.06.1985"},
    ],
    "min_age": 25,
    "max_age": 60
}

response = requests.post(
    "BASE_URL/api/v1/enrich/json",
    headers=headers,
    json=data
)

result = response.json()
print(f"Обогащено: {result['enriched_count']}")
for item in result["results"]:
    print(item["fio"], item["deposits"])
Пример ответа
{
  "results": [
    {
      "fio": "Иванов Иван Иванович",
      "birth_date": "01.01.1990",
      "deposits": 150000,
      "income": 85000,
      "fssp_debt": 0,
      "json_response": { ... },
      "cached": true
    }
  ],
  "total_received": 2,
  "filtered_by_age": 0,
  "enriched_count": 2
}
Максимум 5000 записей за один запрос. Обрабатываются только записи с валидными fio и birth_date (ДД.ММ.ГГГГ).
info Коды ответов
200 Успешный запрос
400 Некорректный запрос (отсутствуют или невалидные параметры)
401 Не авторизован (невалидные ключи API)
402 Недостаточно средств на балансе
404 Пользователь не найден
503 Сервис недоступен (база данных или API не работает)
500 Внутренняя ошибка сервера