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

Sherk API

Один endpoint для поиска. Ключ из бота, ответ — JSON или YAML.

Старт

1. Откройте бота → Профиль → API → Создать ключ (skay-...).

2. Отправьте запрос:

curl "https://sherk.opik.net/api/v1/search?key=skay-KEY&query=@durov&type=username"

3. YAML вместо JSON:

curl "https://sherk.opik.net/api/v1/search?key=skay-KEY&query=@durov&type=username&format=yaml"

Авторизация

Ключ можно передать тремя способами (достаточно одного):

curl -H "X-Api-Key: skay-ваш_ключ" \
  "https://sherk.opik.net/api/v1/search?query=+79991234567&type=phone&format=yaml"

Запрос

GET https://sherk.opik.net/api/v1/search

Только GET. Тело запроса не используется.

Параметры

* ключ обязателен, но может быть в заголовке вместо query.

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

По умолчанию — JSON (application/json). YAML включается так:

• параметр format=yaml или format=yml
• заголовок Accept: application/yaml (или application/x-yaml / text/yaml)

Content-Type ответа: application/yaml.

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

Замените skay-KEY на свой ключ. Ниже — готовые URL по типам.

Username Telegram

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=@durov&type=username
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=durov&type=username&format=yaml

Telegram ID

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=123456789&type=id
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=123456789&type=tgid&format=yaml

Телефон

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=%2B79991234567&type=phone
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=79991234567&type=phone&format=yaml
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=8+999+123-45-67&type=phone

ФИО

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=Иванов+Иван+Иванович&type=fio
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=Иванов+Иван+01.01.1990&type=fio&format=yaml
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=Петров+Пётр+15.03.1985&type=fio

Email

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=ivanov@mail.ru&type=email
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=name%2Btag%40gmail.com&type=email&format=yaml

Авто (госномер)

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=А001АА77&type=car
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=A001AA77&type=car&format=yaml

VIN

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=XTA212130T1186583&type=vin
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=WVWZZZ1JZYW123456&type=vin&format=yaml

ВКонтакте

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=https://vk.com/id1&type=vk
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=vk.com/durov&type=vk&format=yaml
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=id1&type=vk

Паспорт

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=6516244966&type=passport
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=45+08+123456&type=passport&format=yaml

ИНН / СНИЛС / ОГРН

https://sherk.opik.net/api/v1/search?key=skay-KEY&query=383600465404&type=inn
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=11531187016&type=snils&format=yaml
https://sherk.opik.net/api/v1/search?key=skay-KEY&query=1027700132195&type=ogrn

Код

cURL — JSON

curl -sG "https://sherk.opik.net/api/v1/search" \
  --data-urlencode "key=skay-ваш_ключ" \
  --data-urlencode "query=@durov" \
  --data-urlencode "type=username"

cURL — YAML

curl -sG "https://sherk.opik.net/api/v1/search" \
  -H "Accept: application/yaml" \
  --data-urlencode "key=skay-ваш_ключ" \
  --data-urlencode "query=+79991234567" \
  --data-urlencode "type=phone"

Python — JSON

import requests

r = requests.get("https://sherk.opik.net/api/v1/search", params={
    "key": "skay-ваш_ключ",
    "query": "@durov",
    "type": "username",
})
print(r.json())

Python — YAML

import requests
import yaml  # pip install pyyaml

r = requests.get("https://sherk.opik.net/api/v1/search", params={
    "key": "skay-ваш_ключ",
    "query": "Иванов Иван 01.01.1990",
    "type": "fio",
    "format": "yaml",
})
print(r.text)
data = yaml.safe_load(r.text)
print(data.get("ok"), data.get("balance"))

JavaScript (fetch)

const url = new URL("https://sherk.opik.net/api/v1/search");
url.searchParams.set("query", "А001АА77");
url.searchParams.set("type", "car");
url.searchParams.set("format", "yaml");

const res = await fetch(url, {
  headers: { "X-Api-Key": "skay-ваш_ключ" },
});
console.log(await res.text());

Ответ

JSON

{
  "ok": true,
  "balance": 47,
  "daily_free": 0,
  "data": {
    "id": 123456789,
    "username": "@durov",
    "phone": "+79991234567",
    "first_name": "Pavel"
  }
}

YAML

ok: true
balance: 47
daily_free: 0
data:
  id: 123456789
  username: "@durov"
  phone: "+79991234567"
  first_name: Pavel

Ничего не найдено

ok: true
balance: 47
data: null
message: Не найдено

Ошибки

Тело ошибки в том же формате, что и успешный ответ:

ok: false
error: Неверный API ключ

Типы

Лимиты и защита

• 1 запрос в секунду на ключ
• 1 IP на ключ — закрепляется с первого запроса
• Сброс IP: 50₽ в боте (Профиль → API) или через @sherkpro_bot
• Списание с баланса запросов аккаунта
• Таймаут поиска ≈ 90 секунд