Intelligence search platform

SpartaWar API

Единый интерфейс поиска по подключённым источникам и индексированным базам. Запрос запускает основной поиск, выделяет связанные сущности и выполняет второй проход.

REST · JSONHTTPSv1.2.0Cross-search

Авторизация

Передавайте ключ в заголовке поискового запроса.

X-API-Key: SPARTA-••••••••••••

В боте SpartaWar API можно создать ключ, дать ему имя, срок действия и лимит запросов. Не размещайте ключ в открытом коде.

curl -H "X-API-Key: YOUR_API_KEY" "/v1/search?query=%2B992000000000&type=phone"

Методы API

Доступные маршруты сервиса.

GET/v1/search

Поиск через параметры URL.

GET /v1/search?query=VALUE&type=auto

POST/v1/search

Поиск с JSON-телом.

{
  "query": "VALUE",
  "type": "auto"
}

GET/v1/types

Возвращает актуальные типы запросов.

GET/health

Показывает состояние и версию сервиса.

Параметры поиска

Тип auto определяется автоматически.

ПараметрТипОписание
query ОБЯЗАТЕЛЬНОstringТелефон, email, username, ID, IP, домен, MAC или ФИО
typestringauto, phone, email, tg, vk, social_id, fio, ip, domain, mac

Формат ответа

Ответ содержит нормализованные и исходные данные.

{
  "status": "success",
  "timed_out": false,
  "query": "VALUE",
  "search_type": "phone",
  "count": 12,
  "parsed_count": 48,
  "entities_found": {},
  "cross_results": {},
  "smart_sections": {},
  "results": [],
  "aggregated": {},
  "data": {}
}

results — разобранные записи, aggregated — объединённые значения, data — ответы источников, cross_results — второй проход.

Коды ошибок

КодПричина
400Неверный запрос или тип
401Ключ отсутствует или не распознан
403Ключ отключён, просрочен или исчерпал лимит
500Поиск не удалось завершить

Проверить API

Ключ используется только для этого запроса и не сохраняется страницей.

Поиск может занять до общего таймаута системы.
Здесь появится ответ API.