PUBLIC API · V1

黑名单查询 API

用于在机器人、管理面板或交易工具中查询已审核的公开记录。返回结果仅供风险参考。

当前服务要求在请求中提供 X-API-Key

CHECK

查询是否为黑名单

GET /api/v1/check?q=@username 可查询 Telegram 用户名或数字 ID。查询 IP 时请使用 POST,避免 IP 被写入 URL 或代理访问日志。

curl "https://your-domain.example/api/v1/check?q=@username"
curl -X POST https://your-domain.example/api/v1/check \
  -H "Content-Type: application/json" \
  -d '{"q":"203.0.113.10"}'

命中时的关键字段:

{
  "blacklisted": true,
  "match_count": 1,
  "matches": [{
    "id": 12,
    "telegram_id": "123456789",
    "telegram_username": "@example",
    "incident_count": 2,
    "detail_url": "/api/v1/subjects/12"
  }]
}

DETAIL

读取已公开的事件详情

GET /api/v1/subjects/{id} 返回该对象的已审事件、审核备注、外部证据链接和已公开图片 URL。

curl https://your-domain.example/api/v1/subjects/12

USAGE

响应与限制

无匹配时返回 200"blacklisted": false。参数缺失返回 400;IP 使用 GET 会返回 405;频率超限返回 429

默认每个来源地址每分钟最多 60 次 API 请求。若管理员配置了 API 密钥,请在每个请求附带 X-API-Key: your-key