CarbonMeld API（v1）
30日間プレミアムパスに含まれる REST API v1：プロジェクト記録、絞り込み一覧、市場統計。Bearerキー、標準で1キーあたり1日300リクエスト。
APIが返すデータ
CarbonMeldが保有するプロジェクト一覧、市場統計、利用可能な品質スコアと文書に基づく分析を含む個別記録を取得できます。プレミアムの詳細がある場合は公開データと統合して返します。スコアと分析は公開済みの記録に依存し、パスによって未作成の分析が生成されることはありません。
キーを取得する
有効な30日間プレミアムパスでアカウント欄にログインし、APIキーを発行してください。キーは一度だけ表示されるため、その場で保存してください。再発行すると以前のキーは無効になります。パスの期限が切れると認証できなくなり、新しいパスの購入後、失効させていないキーは再び使えます。
アカウント欄を開く認証
毎回のリクエストでAuthorizationヘッダーにキーを指定します。キーはcmk_に続く64文字の小文字16進数です。例はプレースホルダーを使用しています。手元で自分のキーに置き換え、秘密に保管してください。
Authorization: Bearer cmk_YOUR_KEY_HEREエンドポイント
| リクエスト | レスポンス |
|---|---|
GET /api/v1/stats | 現在のエクスポートによる市場統計。プロジェクト数、レジストリ数、updated_atを含みます。収録プロジェクト数であり、評価完了件数ではありません。 |
GET /api/v1/projects | 絞り込み後の一覧：updated_at、total（絞り込み後の件数）、limit、offset、projects。 |
GET /api/v1/projects/<id_or_slug> | 登録コード、正規スラッグまたは別名で1件を取得します。プレミアムの詳細がある場合は共通の日次プロジェクト枠を使用します。 |
一覧のパラメーター
| パラメーター | 指定できる値 |
|---|---|
registry | データに存在する基準コード。大文字・小文字を区別しません（例：VCS）。未知の値は400となり、有効な値の一覧が返ります。 |
min_score | 0～10の数値。0を含め、指定した場合は数値スコアのないプロジェクトを除外します。未評価のプロジェクトも含める場合は省略してください。 |
limit | 1～200の10進整数。既定値は50。 |
offset | 0以上の10進整数。既定値は0。 |
上限とフェアユース
- 300 リクエスト／日／キーが標準上限です。RESTとMCPで共有します。
- 30 件の異なるプレミアムプロジェクト／日を、サイト、PDFレポート、REST、MCPで共有します。同日に同じプロジェクトを再表示しても1件です。ポートフォリオ内および個別にアンロックされたプロジェクトは対象外です。公開記録のみの取得もこの枠を使いません。
日次カウンターは00:00 UTCにリセットされます。IPごとに毎分120リクエストのバースト上限もあります。一覧と統計の取得はリクエスト上限に含まれますが、プレミアムプロジェクト枠は使いません。
エラー
| ステータス | 意味と対処 |
|---|---|
400 | プロジェクト識別子または一覧パラメーターが無効です。メッセージと指定可能な値を確認してください。 |
401 | キーの欠落、無効化、失効、または有効なパスがありません。Authorizationヘッダーとアカウントを確認してください。 |
404 | プロジェクトが見つかりません。登録コードまたはスラッグを確認してください。 |
429 | リクエスト、バースト、またはプロジェクトの上限です。Retry-Afterレスポンスヘッダーに従って待ってください。 |
503 | プロジェクトを更新中です。Retry-Afterに従って後で再試行してください。 |
リクエスト例
絞り込み一覧を取得し、次に登録コードで個別記録を取得します。2つ目のリクエストはプレミアムプロジェクト枠を使用する場合があります。
curl 'https://carbonmeld.com/api/v1/projects?registry=VCS&min_score=7&limit=5&offset=0' \
-H 'Authorization: Bearer cmk_YOUR_KEY_HERE'
curl 'https://carbonmeld.com/api/v1/projects/VCS-1318' \
-H 'Authorization: Bearer cmk_YOUR_KEY_HERE'APIの対象外の機能
CarbonMeldデータの読み取り用APIです。レジストリの発行・MRVワークフローとの連携、クレジットの発行・移転、個別シリアル番号の所有権確認は行いません。レジストリのラベルや記録数量は保有データを示すもので、オファーを保証するものではありません。
利用条件
業務にデータを利用する前に、利用条件とスコア算出方法をご確認ください。
利用規約AIアシスタントから利用する
MCPサーバーは同じAPIキーと利用枠を使います。
MCPガイド