Black Cat API · документация

Поиск данных
ПО API\документация.

Один эндпоинт, восемь методов. Всё в JSON. Ключ передаётся прямо в URL, а не в заголовке.

Быстрый старт → Примеры
Base URL
URL
https://api.black-cat.ccwu.cc
Auth
ключ
Black-Cat-Key:... прямо в пути
Format
JSON
application/json; charset=utf-8
CORS
открыт
можно звать прямо из браузера

Что тут есть

Восемь методов. Шесть поисковых, два служебных. Все — GET.

/api/phone/<key>
GET
Поиск по телефону.
/api/fio/<key>
GET
Поиск по ФИО. Ровно три слова.
/api/fio_bd/<key>
GET
ФИО + дата рождения.
/api/inn/<key>
GET
Поиск по ИНН.
/api/snils/<key>
GET
Поиск по СНИЛС.
/api/email/<key>
GET
Поиск по email.
/api/help/<key>
GET
Справка.
/api/stats/<key>
GET
Статистика ключа.

Быстрый старт

Ключ создаётся в боте — @lord1_zip_bot, раздел «API», кнопка «Создать ключ».

Black-Cat-Key:<20 символов a-zA-Z0-9>
curl -G "https://api.black-cat.ccwu.cc/api/phone/Black-Cat-Key:ВАШ_КЛЮЧ" \
     --data-urlencode "q=+79991234567"

Авторизация

Ключ в пути URL:

https://api.black-cat.ccwu.cc/api/phone/Black-Cat-Key:ВАШ_КЛЮЧ?q=+79991234567

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

{
  "ok": true,
  "method": "phone",
  "count": 8,
  "results": [ /* ... */ ]
}

Поля результата

key
string
то, по чему нашли
fio
string
ФИО
birth_date
string
дата рождения
phone
string
телефон
inn
string
ИНН
snils
string
СНИЛС
email
string
email
address
string
адрес
source
string
источник
line
string
оригинальная строка

Лимиты

min
1
меньше — 400
max
10000
больше — 400
default
100
если не указывать

Методы

GET/api/help/<key>

Справка.

GET/api/stats/<key>

Статистика ключа.

GET/api/phone/<key>?q=+79991234567

Поиск по телефону.

GET/api/fio/<key>?q=Иванов Иван Иванович

Поиск по ФИО.

GET/api/fio_bd/<key>?fio=...&bd=01.01.1990

ФИО + дата рождения.

GET/api/inn/<key>?q=7707083893

Поиск по ИНН.

GET/api/snils/<key>?q=11955894101

Поиск по СНИЛС.

GET/api/email/<key>[email protected]

Поиск по email.

Ошибки

200
OK
всё хорошо
400
Bad Request
параметры неверные
401
Unauthorized
проблема с ключом
404
Not Found
неизвестный путь
500
Internal
что-то упало

Примеры

curl

KEY="Black-Cat-Key:ВАШ_КЛЮЧ"
API="https://api.black-cat.ccwu.cc"

# телефон
curl -G "$API/api/phone/$KEY" --data-urlencode "q=+79991234567" | jq

# ФИО
curl -G "$API/api/fio/$KEY" --data-urlencode "q=Иванов Иван Иванович" | jq

# ФИО + ДР
curl -G "$API/api/fio_bd/$KEY" \
     --data-urlencode "fio=Иванов Иван Иванович" \
     --data-urlencode "bd=01.01.1990" | jq

# проверить ключ (бесплатно)
curl "$API/api/help/$KEY" | jq

# баланс (бесплатно)
curl "$API/api/stats/$KEY" | jq

Python

import requests

# ОБЯЗАТЕЛЬНО сначала определить API_BASE
API_BASE = "https://api.black-cat.ccwu.cc"
KEY      = "Black-Cat-Key:ВАШ_КЛЮЧ"

# телефон
r = requests.get(f"{API_BASE}/api/phone/{KEY}",
                 params={"q": "+79991234567"})
data = r.json()

if not data["ok"]:
    print("Ошибка:", data["error"], "поле:", data.get("field"))
else:
    print(f"нашлось {data['count']}, остаток {data['limit_left']}")
    for row in data["results"]:
        print(row["fio"], row["birth_date"])

Python — ФИО + дата рождения

import requests

API_BASE = "https://api.black-cat.ccwu.cc"
KEY      = "Black-Cat-Key:ВАШ_КЛЮЧ"

r = requests.get(f"{API_BASE}/api/fio_bd/{KEY}",
                 params={
                     "fio": "Иванов Иван Иванович",
                     "bd":  "01.01.1990",
                 })
print(r.json())

Python — проверить ключ (бесплатно)

import requests

API_BASE = "https://api.black-cat.ccwu.cc"
KEY      = "Black-Cat-Key:ВАШ_КЛЮЧ"

r = requests.get(f"{API_BASE}/api/help/{KEY}")
print(r.json())

JavaScript

const API_BASE = "https://api.black-cat.ccwu.cc";
const KEY      = "Black-Cat-Key:ВАШ_КЛЮЧ";

const res = await fetch(
  `${API_BASE}/api/fio/${KEY}?q=${encodeURIComponent("Иванов Иван Иванович")}`
);
const data = await res.json();
console.log(data);

Замечания

Кириллицу и пробелы кодируй. Ответы в UTF-8. count=0 — не ошибка. CORS открыт.

Поддержка

@anonChadEXE Канал