ghfind API 文档
ghfind 用确定性的开源引擎为任意 GitHub 账号打出 0–100 的真实贡献含金量与可信度评分。站点的全部能力都可以编程调用:公开 REST API、面向 AI Agent 的 MCP 服务器,以及官方 SDK。本页是它们的完整文档。
ghfind REST API
Base URL:https://ghfind.com。评分读取接口无需认证。错误为结构化 JSON({error, message, hint}),响应携带 RateLimit-* 头,列表接口支持 limit/offset 分页。
GET /api/score/{username}- 确定性 0–100 分、段位和六维拆解。未见过的账号也能实时评分;无需认证,不经过 LLM。
POST /api/scan- 完整的确定性扫描载荷:原始指标、头部仓库、近期 PR、风险标记、子分数。
POST /api/roast- AI 吐槽报告(唯一的 LLM 接口,支持自带 key)。
POST /api/vs-verdict- 两个账号的对战裁决。
GET /api/leaderboard- 按 trending/score/heat/progress 排序的开发者榜单,支持 limit/offset 分页。
GET /api/developers- 按语言、组织或参与仓库的开发者目录,支持分页。
GET /api/search-users- 对已评分账号做前缀搜索。
GET /api/stats- 平台总量统计(已评分账号数)。
GET /api/badge/{username}- 可嵌入 README 的 SVG 评分徽章。
ghfind MCP 服务器
Streamable HTTP 协议的 Model Context Protocol 服务器位于 https://ghfind.com/mcp(无需认证、按 IP 限流、只读)。把它加进 Claude、Cursor 或任意 MCP 客户端,即可在 Agent 内直接评分和对比 GitHub 账号。
score_user— 任意 GitHub 账号的 0–100 分、段位和六维拆解。scan_user— 完整扫描载荷:指标、头部仓库、近期 PR、风险标记。compare_users— 确定性对战比较,给出胜者与分差。get_leaderboard— 公开开发者榜单,用于发现。search_users— 已评分账号的前缀搜索。
认证
读取接口全部公开。写入接口(POST /api/scan、POST /api/roast)接受浏览器 Turnstile 验证或 Bearer API key。Agent 请阅读 /auth.md 的机器可读指引。
官方 SDK 与 CLI
@hikariming/ghfind (npm)— JavaScript / TypeScript SDK 与 CLI:npm install -g @hikariming/ghfindghfind (PyPI)— Python SDK:pip install --upgrade ghfindghfind CLI— ghfind score {username} -o json · ghfind scan · ghfind roast · ghfind leaderboard · ghfind stats
机器可读入口
/openapi.json— 覆盖全部公开接口的 OpenAPI 3.1 规范/llms.txt— 面向 Agent 的指南,含所有入口的 markdown 链接/index.md— 首页的 markdown 孪生(Accept: text/markdown 时也会返回)/.well-known/agent-card.json— /.well-known/ 下的 A2A agent card、MCP server card、API catalog 与 skills