ghfind APIドキュメント
ghfind は決定論的なオープンソースエンジンで、任意のGitHubアカウントの実コントリビューション価値と信頼度を0-100点で採点します。サイト上のすべての機能はプログラムからも利用可能:公開REST API、AIエージェント向けMCPサーバー、公式SDK。このページはその完全なドキュメントです。
ghfind REST API
Base URL: https://ghfind.com。スコアの読み取りに認証は不要。エラーは構造化JSON({error, message, hint})、レスポンスには RateLimit-* ヘッダーが付き、一覧系エンドポイントは limit/offset ページネーションに対応します。
GET /api/score/{username}- 決定論的な0-100点スコア、ティア、6ディメンションの内訳。未知のアカウントもライブで採点。認証不要、LLM不使用。
POST /api/scan- 決定論的スキャンの完全ペイロード:生メトリクス、トップリポジトリ、直近のPR、レッドフラグ、サブスコア。
POST /api/roast- AIが書くローストレポート(唯一のLLMエンドポイント。自前キー持ち込み対応)。
POST /api/vs-verdict- 2アカウントの直接対決の判定。
GET /api/leaderboard- トレンド・スコア・ヒート・進捗で並べた開発者ランキング。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クライアントに追加すれば、エージェント内からGitHubアカウントの採点と比較ができます。
score_user— 任意のGitHubログインの0-100点スコア、ティア、6ディメンションの内訳。scan_user— スキャンの完全ペイロード:メトリクス、トップリポジトリ、直近のPR、レッドフラグ。compare_users— 決定論的な直接対決の比較。勝者とスコア差を返します。get_leaderboard— 発見用の公開開発者ランキング。search_users— 採点済みアカウントの前方一致検索。
認証
読み取りエンドポイントはすべて公開です。書き込みエンドポイント(POST /api/scan、POST /api/roast)はブラウザのTurnstile認証またはBearer APIキーを受け付けます。エージェントは /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— 全入り口へのmarkdownリンクを含むエージェント向けガイド/index.md— ホームページのmarkdown版(Accept: text/markdown でも返却)/.well-known/agent-card.json— /.well-known/ 配下のA2A agent card、MCP server card、APIカタログとスキル