Документация ReFind API

Используйте наш API для интеграции сервиса ReFind в свои приложения. Сервис предоставляет возможность поиска данных по утечкам.

Защищенный доступ к API

URL API и ключи доступны только через Telegram

Бот

@refindbot

Канал

@refindchannel

Получить доступ к API

Основная информация

ReFind API предоставляет доступ к базе данных утечек для поиска информации по номерам телефонов. Ниже приведены основные сведения о работе с API и ключевые эндпоинты.

Базовый URL API

Все запросы к API должны отправляться на базовый URL:

https://

Аутентификация

Для доступа к API необходимо использовать API ключ, который передается в заголовке X-API-Key:

Пример
                                    аутентификации

curl -X GET "https:///search?phone=79991234567" \
     -H "X-API-Key: ваш_api_ключ"

Формат номера телефона

API поддерживает поиск только по российским номерам телефонов в следующих форматах:

7XXXXXXXXXX — 11 цифр, начиная с 7
89XXXXXXXX — 10 цифр, начиная с 9 (автоматически преобразуется в формат с 7)

Примеры корректных номеров: 79991234567, 89991234567

Лимиты запросов

Количество запросов зависит от типа вашего API ключа:

Infinite: Без ограничений
Requests: Лимит запросов от 50 до 1000 в зависимости от тарифа
Both: Ограниченное количество запросов

Поиск по номеру телефона

GET /search?phone=номер_телефона

Поиск информации по номеру телефона в базах данных утечек.

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

ПАРАМЕТР	ТИП	ОБЯЗАТЕЛЬНЫЙ	ОПИСАНИЕ
phone	string	Да	Номер телефона в формате 7XXXXXXXXXX (только цифры, без символов)
full	boolean	Нет	Если true, возвращает полную информацию без маскирования данных (только для ключей с расширенным доступом)

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

curl -X GET "https:///search?phone=79991234567" \
     -H "X-API-Key: ваш_api_ключ"

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

Успешный ответ

200 OK

{
  "t": "+79999999999",
  "u": "muhammadebzaev",
  "id": 3141657989,
  "database": "ИнстаграмПарсинг",
  "explain": "Неизвестная утечка",
  "results": [
    {
      "database": "VK 2019",
      "source": "Утечка данных ВКонтакте 2019",
      "data": {
        "name": "Иван",
        "surname": "Ива***",
        "email": "iva***@***il.com",
        "vk_id": "id****234",
        "city": "Москва"
      }
    },
  ],
}

Ответ, если данные не найдены

200 OK

{
  "results": [],
  "analysis": null,
  "execution_time": 0....,
  "remaining_requests": "Unlimited"
}

Ответ с ошибкой

400 Bad Request

{
  "status": "error",
  "code": 400,
  "message": "Неверный формат номера телефона. Используйте формат 7XXXXXXXXXX"
}

Коды ошибок

При работе с API могут возникать различные ошибки. Ниже приведен список кодов ошибок и их описание.

400

Bad Request

Неверный формат запроса. Проверьте параметры и формат данных.

{
  "status": "error",
  "code": 400,
  "message": "Неверный формат номера телефона"
}

401

Unauthorized

Недействительный или просроченный API ключ. Проверьте ключ или получите новый.

{
  "status": "error",
  "code": 401,
  "message": "Недействительный API ключ"
}

403

Forbidden

Недостаточно прав для выполнения запроса или превышен лимит запросов.

{
  "status": "error",
  "code": 403,
  "message": "Превышен лимит запросов"
}

429

Too Many Requests

Слишком много запросов за короткий промежуток времени. Повторите попытку позже.

{
  "status": "error",
  "code": 429,
  "message": "Слишком много запросов",
  "retry_after": 60
}

500

Internal Server Error

Внутренняя ошибка сервера. Повторите попытку позже или обратитесь в поддержку.

{
  "status": "error",
  "code": 500,
  "message": "Внутренняя ошибка сервера"
}