本文へ移動

APIを使う

APIは無料で、読み取り専用です。キーも登録も要りません。応答はすべてJSONです。

curl https://api.thebgdb.org/v1/search?q=azul

OpenAPI定義

すべてのルート、パラメーター、応答を機械可読な形で記述した完全な定義を、リリースのたびにapi.thebgdb.org/v1/openapi.jsonで公開しています。OpenAPI対応のツールに読み込めば、APIを調べたりクライアントを生成したりできます。アカウント、写真、リストも対象です。

同じ定義をページとしても読めます:APIリファレンス。

主なリクエスト

リクエスト返すもの
GET /v1/search?q=catan名前にqのすべての単語を含むゲーム。大文字と小文字、アクセント記号は区別しません。入力ミスは補正しません。qは2文字以上が必要です。
GET /v1/games/{id}ゲーム1件。各ゲームのオブジェクトにあるidで指定します。説明、プレイ人数、プレイ時間、クレジット、写真を返します。
GET /v1/games?limit=50カタログを1ページずつ。受け取ったnextCursorをcursorとして渡すと、次のページを取得できます。
GET /v1/healthAPIが稼働しているかどうか。

AIアシスタントを接続する(MCP)

Model Context Protocolに対応したアシスタントは、カタログを直接使えます。次のサーバーアドレスをアシスタントに追加してください。

https://mcp.thebgdb.org/mcp

ログインは要りません。アシスタントにあなたのリストを見せたり編集させたりするには、代わりにhttps://mcp.thebgdb.org/memberを使ってください。最初にログインと承認を求められます。アカウントのページで作ったAPIトークンは、1つ目のアドレスでも使えます。

制限

トークンなし:アドレスごとに1分あたり300リクエスト。アカウントのページで作ったAPIトークンあり:1分あたり1,200リクエスト、有料プランでは6,000リクエスト。上限を超えるとAPIは429を返します。1分待ってから続けてください。応答は最長5分キャッシュされるため、変更が反映されるまでそのくらいかかることがあります。