Описание Api

  • Начало работы
  • Ограничения
  • Авторизация
  • Информация о пользователе
  • Поиск
    • JSON объект
    • Варианты запросов
    • Примеры
    • Значения полей ответа
  • Ошибки

Начало работы

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

Ограничения

API имеет ограничение на число запросов в секунду (RPS) и составляет 1 запрос в 1 секунду.

Распространенный вопрос от наших клиентов касающийся этого лимита:
1 запрос в 1 секунду это очень медленно, как мне работать с большими объемами данных при таких лимитах?
Ответ:
Для обработки больших объемов данных мы предусмотрели возможность отправки за один запрос от 1 до 75 идентификаторов, что позволит ускорить процесс взаимодействия с сервисом.

Авторизация

Авторизация происходит путем передачи в заголовке запроса ключа X-Api-Key с вашим токеном в его значении. Пример:

'X-Api-Key: YOU-TOKEN_HERE'

Информация о пользователе

Этот метод можно использовать для получения баланса и остатка запросов. Для его выполнения вам необходимо отправить GET запрос на адрес https://breachka.com/api/v1/user/info

Type: GET
Request URL: https://breachka.com/api/v1/user/info
Request (примеры запросов):

curl --location 'https://breachka.com/api/v1/user/info' \
--header 'X-Api-Key: YOU-TOKEN_HERE'
                                            

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://breachka.com/api/v1/user/info");
request.Headers.Add("X-Api-Key", "YOU-TOKEN_HERE");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
                                            

$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://breachka.com/api/v1/user/info',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'X-Api-Key: YOU-TOKEN_HERE'
), ));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
                                            

import requests
url = "https://breachka.com/api/v1/user/info"
payload = {}
headers = {'X-Api-Key': 'YOU-TOKEN_HERE'}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
Response (примеры ответов):

{
    "Email": "some@email.com",
    "Balance": 0,
    "ApiKey": "YOU-TOKEN_HERE",
    "ApiQueryLimit": 0,
    "ApiQueryMade": 0,
    "Role": "Премиум",
    "RoleDateValid": "08.06.2029 15:34:38",
    "RoleQueryLimit": 0,
    "RoleQueryMade": 0,
}

Errors (возможные ошибки и их значение)

В случае ожидаемой ошибки поведения клиента вы можете получить объект типа:

{
    "error": "string"
}
В поле error будет передано текстовое сообщение об ошибке, мы постарались сделать его информативным, в связи с чем, в основном, они не должны требовать дополнительной расшифровки. В случае проблем с пониманием описанием ошибки воспользуйтесь гугл переводчиком, или обратитесь в техническую поддержку.

An unhandled error has occurred. Reload 🗙