CarbonMeld API(v1)
プレミアムに含まれる REST API v1:プロジェクト記録、絞り込み一覧、市場統計。Bearerキー、標準で1キーあたり1日300リクエスト。
APIが返すデータ
CarbonMeldが保有するプロジェクト一覧、市場統計、利用可能な評価と文書に基づく分析を含む個別記録を取得できます。プレミアムの詳細がある場合は公開データと統合して返します。評価と分析は公開済みの記録に依存し、プレミアムによって未作成の分析が生成されることはありません。
キーを取得する
有効なプレミアムのアクセスがある状態でアカウントページにログインし、APIキーを発行してください。キーは一度だけ表示されるため、その場で保存してください。再発行すると以前のキーは無効になります。プレミアムのアクセスが終了すると認証できなくなり、再びアクセスできるようになると、失効させていないキーは再び使えます。
アカウントページを開く認証
毎回のリクエストでAuthorizationヘッダーにキーを指定します。キーはcmk_に続く64文字の小文字16進数です。例ではプレースホルダーを使っています。ご自身のキーに置き換え、キーは非公開にしてください。アプリケーションは代わりにCarbonMeldアカウントでサインイン(OAuth 2.1、PKCE、スコープ carbonmeld.read)し、受け取ったアクセストークンを同じ方法で送ることもできます。
Authorization: Bearer cmk_YOUR_KEY_HERE このAPIの機械可読な説明(OpenAPI 3.1): https://carbonmeld.com/api/v1/openapi.json
エンドポイント
APIのすべてのリクエストです。MCPツール名のある行は、そのツールと同じオブジェクトを返します。各リクエストのパラメータとレスポンスはOpenAPIの説明にあります。
| リクエスト | レスポンス |
|---|---|
GET /api/v1/stats | 現在のエクスポートによる市場統計。プロジェクト数、レジストリ数、updated_atを含みます。収録プロジェクト数であり、評価完了件数ではありません。 |
GET /api/v1/projects | 絞り込み後の一覧:updated_at、total(絞り込み後の件数)、limit、offset、projects。 |
GET /api/v1/projects/<id_or_slug> | 登録コード、正規スラッグまたは別名で1件を取得します。プレミアムの詳細がある場合は共通の日次プロジェクト枠を使用します。 |
POST /api/v1/projects/batch | 1回の呼び出しで複数のプロジェクト記録を取得します:各idにget_projectと同じ記録を指定順で返し、失敗したidにはそのid自身のエラーを付けます。返された各記録は、get_projectとまったく同じく共通のプロジェクト枠を使用します。呼び出しのリクエスト上限を超えたidは、再試行可能な状態で開かれずに返されます(枠は使いません)——そのidだけ再度お試しください。同じオブジェクトを返すMCPツール: get_projects |
GET /api/v1/projects/<id_or_slug>/page | ページに表示されるとおりの、記録以外にプロジェクトページが示す内容:ページ上のお知らせ、「この分析はどう行われたか」、類似プロジェクト、PDFレポートのアドレス、ランキングでのプロジェクトの順位。 |
GET /api/v1/projects/<id_or_slug>/ranks | プロジェクトページに表示されるとおりの、ランキングでのプロジェクトの順位。 |
GET /api/v1/methodologies/<code> | CarbonMeldの方法論ページの内容どおりに1つの方法論を返します:出典付きの識別カード、方法論 v3 がこの種類のプロジェクトをどう読むか(v3でも変わらないv2.2のルール、変更されたルールとその変更後のv3のルール、v2.2の当時のルールへのリンク)、バージョン履歴と移行、そのプロジェクト(v3 評価のランキングまたは一覧)、ページのURL。同じオブジェクトを返すMCPツール: get_methodology |
GET /api/v1/standards/<code> | CarbonMeldの基準ページの内容どおりに1つの基準を返します:出典付きの識別カード、方法論 v3 がこの基準のプロジェクトをどう読むか(v3でも変わらないv2.2のプログラム規則、変更されたルールとその変更後のv3のルール、v2.2の当時のルールへのリンク)、その基準が発行する方法論とプロジェクトが使う方法論、そのプロジェクト(v3 評価のランキングまたは一覧)、ページのURL。同じオブジェクトを返すMCPツール: get_standard |
GET /api/v1/rankings/<dimension>[/<value>] | サイトに表示されるとおりのランキング:ある軸のランキング一覧とその件数・平均、または1つのランキングの評価順のプロジェクト(評価済み5件以上)とページのURL。分野別ランキングは、評価時の分野でプロジェクトをまとめます。同じオブジェクトを返すMCPツール: get_ranking |
GET /api/v1/developers/<slug> | CarbonMeldの開発者ページの内容どおりに1つのプロジェクト開発者を返します:プロジェクト数、方法論 v3 の評価があるプロジェクト数、登録状況が却下・取り下げ・終了・停止中・発行拒否のプロジェクト数、基準と国、ページの順のプロジェクト。各プロジェクトには登録コード、国、登録状況、評価または分析状況、プロジェクトURLを付けます。評価は一覧のとおりで、方法論 v3 の評価とその区分、v2.2 と明示した v2.2 のスコア、または「評価には時期尚早」/「まだ評価できません」/「適用される公開の評点はまだありません」/「評価は表示していません」です。再評価中は暫定と表示します。ページのURLも付けます。会社単位の評価はありません。名前が曖昧な場合は確認が必要です。同じオブジェクトを返すMCPツール: get_developer |
GET /api/v1/buyers/<slug> | CarbonMeldのページの内容どおりの組織の公開償却記録:トン数、償却回数、償却したものの品質、プロジェクト(それぞれ償却トン数とプロジェクトの現在の評価)、最近の償却。償却の受益者が購入者とは限りません。名前が曖昧な場合は確認が必要です。同じオブジェクトを返すMCPツール: get_buyer |
GET /api/v1/ccp-tracker | サイトに表示されるとおりのICVCM CCPトラッカー:インテグリティ評議会による方法論の評価とその状況・状況ごとの件数、各評価について同じ方法論コードでCarbonMeldが追跡しているそのプログラムのプロジェクト数(全バージョン。CCPラベル付きクレジットの数ではありません)とランキング、表の出典と取得日。同じオブジェクトを返すMCPツール: ccp_tracker |
GET /api/v1/corsia | サイトに表示されるとおりの、レジストリ別・フェーズ別のCORSIAレジストリラベル、First Phaseの高評価プロジェクト、レジストリごとの平均評価(いずれもプロジェクトの現在の評価から)。残高は全ビンテージの未償却ユニットであり、CORSIA適格ユニットではありません。同じオブジェクトを返すMCPツール: corsia_supply |
GET /api/v1/claims-changes | CarbonMeld が記録した直近30日間の変化:ルール策定機関の公式通知(ICVCM、Verra、Gold Standard、SBTi など。発行元、タイトル、リンク、日付)と、プロジェクトのレジストリラベルの付与・削除(各プロジェクトページのURL付き)、および期間全体でラベル変更の種類ごとのプロジェクト数。同じオブジェクトを返すMCPツール: what_changed |
GET /api/v1/method | サイトに表示されるとおりのCarbonMeldの評価方法(/methodology/):方法論 v3、文書に基づく評価。引数なしでは、ページの各セクション、方法論のバージョン、4つの評価軸とその重み、アーカイブされたv2.2のルールのアドレス。あるセクション:ページ上の文章と、そこに記載されたルールのID、ルールカードごとに1行。ID(A-START、Q-FNRB-ABOVE)またはルールカードのキーで1つのルール:名称、内容、各効果とその幅、適用開始時期、出典と出典の原文。v2.2のID(CM-…)は、v2.2でのそのルールと、v3での扱い(同じ、変更(変更後のv3のルール付き)、削除)を返します。ある評価軸(additionality、quantification、permanence、claim_safety、overall):その評価軸に作用するルールをページ単位で(limit・offset、続きがあるときはnext_offset)。方法論 v3 にはcriterionはありません。同じオブジェクトを返すMCPツール: get_method |
GET /api/v1/articles | サイトの記事インデックスのとおりに、CarbonMeldの英語・中国語・日本語の記事を検索します:語句で(すべての語句がタイトル、要約、トピックのいずれかに含まれること)、トピックで(サイトのそのトピックのページの記事)、日付で。該当件数の合計とその1ページ分を最新順または古い順で返します(続きがあるときはnext_offset):タイトル、日付、要約、トピック、カテゴリー、URL。該当がない場合は空のリストを返し、エラーにはなりません。同じオブジェクトを返すMCPツール: search_articles |
GET /api/v1/portfolio | ページに表示されるとおりのご自身のポートフォリオ(マイポートフォリオ):保存したプロジェクトと、それぞれの評価(一覧のとおり:方法論 v3 の評価とその区分、v2.2 と明示した v2.2 のスコア、または「評価には時期尚早」/「まだ評価できません」/「適用される公開の評点はまだありません」/「評価は表示していません」。再評価中は暫定と表示)、分析状況、登録状況、ビンテージ、出品数、分析日。方法論 v3 で読んだプロジェクトは不利な事実、v2.2 のスコアを維持するプロジェクトはレッドフラグ(v2.2 と明示)。評価軸の値は、評価済みのすべてのプロジェクトが同じ方法論バージョンのときだけ。v3 評価の平均、別々に数える2つの合計(方法論 v3 で読んだプロジェクトの不利な事実の合計と、v2.2 のスコアを維持するプロジェクトのレッドフラグの合計)、今週の残り変更回数、これらのプロジェクトの過去30日間の変更通知。読み取り専用です:プロジェクトの保存と削除はサイトで行います。1日のプロジェクト枠は使いません。同じオブジェクトを返すMCPツール: my_portfolio |
POST /api/v1/check-offer | 貼り付けたオファーを登録、ビンテージ、数量、主張、開発者の記録と照合します。特定のシリアル番号の所有権や利用可能性は確認しません。同じオブジェクトを返すMCPツール: check_offer |
POST /api/v1/mcp | AIアシスタント向けのMCPサーバー(HTTP POSTによるJSON-RPC 2.0)。MCPガイド |
一覧のパラメーター
| パラメーター | 指定できる値 |
|---|---|
registry | データに存在する基準コード。大文字・小文字を区別しません(例:VCS)。未知の値は400となり、有効な値の一覧が返ります。 |
min_score | 0~10の数値。0を含め、指定した場合は数値スコアのないプロジェクトを除外します。未評価のプロジェクトも含める場合は省略してください。 |
q | プロジェクト名、登録コード、国、方法論、分野のいずれかにすべて含まれる語句(100文字まで)。 |
country | ISO 3166-1 アルファ2コード(例:KE)または国名(例:Kenya)。未知の値は400となります。 |
methodology | 方法論のカタログコード。大文字・小文字と空白は区別しません(例:VM0048)。未知の値は400となり、近いコードを示します。 |
sector | プロジェクトの種類:arr、biochar、biogas、biomass、blue_carbon、cookstoves、dac、industrial、industrial_gases、methane、other、redd、renewable_energy、soil_carbon、water。未知の値は400となります。 |
limit | 1~200の10進整数。既定値は50。 |
offset | 0以上の10進整数。既定値は0。 |
上限とフェアユース
- 300 リクエスト/日/キーが標準上限です。RESTとMCPで共有します。
- 30 件の異なるプレミアムプロジェクト/日を、サイト、PDFレポート、REST、MCPで共有します。同日に同じプロジェクトを再表示しても1件です。ポートフォリオ内および個別にアンロックされたプロジェクトは対象外です。公開記録のみの取得もこの枠を使いません。
- Pro の場合:1キーあたり1日 1,000 リクエスト、1日 300 件の異なるプロジェクト。その他は上記と同じです。
- 20 回のオファーチェック/日/アカウント。サイトのオファーチェックと共有します。
日次カウンターは00:00 UTCにリセットされます。IPごとに毎分120リクエストのバースト上限もあります。一覧と統計の取得はリクエスト上限に含まれますが、プレミアムプロジェクト枠は使いません。
エラー
| ステータス | 意味と対処 |
|---|---|
400 | プロジェクト識別子または一覧パラメーターが無効です。メッセージと指定可能な値を確認してください。 |
401 | キーの欠落、無効化、失効、または有効なプレミアムのアクセスがありません。Authorizationヘッダーとアカウントを確認してください。 |
403 | サインインで取得したアクセストークンのアカウントに、有効なプレミアムアクセスがありません。アカウントをご確認ください。 |
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'サンプルプロジェクトを見る:VCS-1318 APIの対象外の機能
CarbonMeldデータの読み取り用APIです。レジストリの発行・MRVワークフローとの連携、クレジットの発行・移転、個別シリアル番号の所有権確認は行いません。レジストリのラベルや記録数量は保有データを示すもので、オファーを保証するものではありません。
利用条件
業務にデータを利用する前に、利用条件と評価算出方法をご確認ください。
利用規約AIアシスタントから利用する
MCPサーバーは同じAPIキーと利用枠を使います。
MCPガイド