Вы можете создать API ключ в настройках своего аккаунта.
После получения ключа, передайте его в заголовке X-API-Key
Accept: application/json
X-API-Key: 8cb2237d0679ca88db6464eac60da96345513964
↪️ GET https://leakcheck.io/api/v2/query/example@example.com
{
"success": true,
"found": 1,
"quota": 400,
"result": [
{
"email": "example@example.com",
"source": {
"name": "BreachedWebsite.net",
"breach_date": "2019-07",
"unverified": 0,
"passwordless": 0,
"compilation": 0
},
"first_name": "Example",
"last_name": "Example",
"username": "leakcheck",
"fields": ["first_name", "last_name", "username"]
}
]
}
Если ничего не нашлось:
{
"success": true,
"found": 0,
"quota": 400,
"result": []
}
Column | Description |
---|---|
found | Найденное количество результатов |
quota | Оставшееся количество запросов |
result | Массив содержащий результат проверки |
ℹ️ В ответе могут присутствовать следующие поля, собранные из утечек:
username
,password
,first_name
,last_name
,dob
,address
,zip
,phone
,name
.
По умолчанию, тип проверки определяется автоматически. Вы можете установить его параметром ?type=
.
Тип | Пример | Примечания |
---|---|---|
auto | example@example.com, example, 12345678, 31c5543c1734d25c7206f5fd | Автоматически может быть определена только почта, логин, номер телефона, хеш. Для остальных типов поиска следует выставлять тип вручную. |
example@example.com | ||
domain | gmail.com | |
keyword | example | |
username | example | |
phone | 12063428631 | |
hash | 31c5543c1734d25c7206f5fd | Хеш почты, приведенной к нижнему регистру (SHA256). Вы также можете обрезать его до 24 символов (Только Enterprise) |
phash | 31c5543c1734d25c7206f5fd | Хеш пароля (SHA256). Вы также можете обрезать его до 24 символов (Только Enterprise) |
origin | example.com | Только Enterprise |
password | example | Только Enterprise |
Вы также можете указать limit
и offset
в параметрах запроса. В данный момент limit
ограничен до 1000, offset
- 2500.
Ошибка | Статус |
---|---|
Missing X-API-Key header | 401 |
Invalid X-API-Key | 400 |
Invalid type | 400 |
Invalid email | 400 |
Invalid query | 400 |
Invalid domain | 400 |
Too short query (< 3 characters) | 400 |
Invalid characters in query | 400 |
Too many requests | 429 |
Active plan required | 403 |
Limit reached | 403 |
Could not determine search type automatically | 422 |
По умолчанию, API ограничено 3 (тремя) запросами в секунду. Вы можете увеличить этот лимит в настройках.
Вы можете использовать публичное API для коммерческих целей, однако для использования Pro API (описанного в этой документации), пожалуйста свяжитесь с нашей командой и опишите ваш проект.
В версии v2 мы объединили все данные вместе, поэтому здесь нет типов поиска, таких как domain_email
или pass_login
. Просто используйте username
или domain
.