{"openapi":"3.1.0","info":{"title":"CarbonMeld API","version":"1.0.0","summary":"Carbon credit project records, quality ratings and registry facts (read only), with CarbonMeld Premium.","description":"Read-only access to the project data CarbonMeld holds. Every call needs an active Premium or Pro pass. Limits per UTC day: Premium 300 requests per key and 30 different projects; Pro 1000 requests per key and 300 different projects (all of an account's signed-in assistants share one request counter); 120 requests a minute per IP. Guide: https://carbonmeld.com/premium/api/","termsOfService":"https://carbonmeld.com/terms/","contact":{"name":"CarbonMeld","email":"hello@carbonmeld.com","url":"https://carbonmeld.com/premium/api/"}},"servers":[{"url":"https://carbonmeld.com/api/v1"}],"security":[{"apiKey":[]},{"oauth":["carbonmeld.read"]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Your Premium API key (cmk_ + 64 hex), from your account page."},"oauth":{"type":"oauth2","description":"Sign in with your CarbonMeld account (PKCE S256; dynamic client registration at /oauth/register).","flows":{"authorizationCode":{"authorizationUrl":"https://carbonmeld.com/oauth/authorize","tokenUrl":"https://carbonmeld.com/oauth/token","refreshUrl":"https://carbonmeld.com/oauth/token","scopes":{"carbonmeld.read":"Read your Premium project data"}}}}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]},"Quota":{"type":"object","required":["limit","used_today","left"],"properties":{"limit":{"type":"integer","description":"Distinct premium projects per UTC day."},"used_today":{"type":"integer","description":"Distinct projects opened today that count."},"left":{"type":"integer","description":"limit − used_today (never below 0)."}},"description":"The daily project quota after the call, from the same counter the quota check uses. Projects already opened today, owned or gifted projects and public-only records count 0."},"Project":{"type":"object","description":"One project record: registry facts, rating and analysis when published, vintages, claims, and the caller's quota after the call.","properties":{"quota":{"$ref":"#/components/schemas/Quota"}},"additionalProperties":true},"ProjectList":{"type":"object","properties":{"updated_at":{"type":"string"},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}}},"paths":{"/stats":{"get":{"operationId":"getStats","summary":"Market statistics of the current export (project and registry counts, updated_at).","responses":{"200":{"description":"Statistics.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/projects":{"get":{"operationId":"listProjects","summary":"Filtered project list.","parameters":[{"name":"registry","in":"query","schema":{"type":"string"},"description":"Standard code, e.g. VCS (case-insensitive). An unknown value → 400 with the valid ones."},{"name":"min_score","in":"query","schema":{"type":"number","minimum":0,"maximum":10},"description":"Minimum rating; when given, unscored projects are left out."},{"name":"q","in":"query","schema":{"type":"string","maxLength":100},"description":"Words that must all appear in the project's name, registry code, country, methodology or sector."},{"name":"country","in":"query","schema":{"type":"string"},"description":"ISO 3166-1 alpha-2 code (e.g. KE) or a country name (e.g. Kenya). An unknown value → 400."},{"name":"methodology","in":"query","schema":{"type":"string"},"description":"Methodology catalogue code (e.g. VM0048), case and spaces ignored. An unknown value → 400."},{"name":"sector","in":"query","schema":{"type":"string","enum":["arr","biochar","biogas","biomass","blue_carbon","cookstoves","dac","industrial","industrial_gases","methane","other","redd","renewable_energy","soil_carbon","water"]},"description":"Project type. An unknown value → 400."},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"The list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/projects/{id}":{"get":{"operationId":"getProject","summary":"One project by registry code, slug or alias (Premium details use the daily project quota).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9-]{1,100}$"}}],"responses":{"200":{"description":"The record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The project is being updated: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/projects/batch":{"post":{"operationId":"getProjectsBatch","summary":"Several project records in one call (the same records as /projects/{id}, in the ids' order, with each id's own status and error). Each record found uses the daily project quota exactly as the single GET. An id past the invocation's request limit comes back 503, unopened (no quota used): ask again for those ids.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"additionalProperties":false,"properties":{"ids":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"},"description":"1 to 10 registry codes, slugs or aliases"}}}}}},"responses":{"200":{"description":"The per-id results (200 with project, or the single GET's status with error; 503 also for an id not opened for the invocation's request limit, 429 with the batch's message once the day's leftover is spent), with the quota after the call.","content":{"application/json":{"schema":{"type":"object","required":["total","found","results"],"properties":{"total":{"type":"integer"},"found":{"type":"integer"},"quota":{"$ref":"#/components/schemas/Quota"},"results":{"type":"array","items":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string"},"status":{"type":"integer"},"project":{"$ref":"#/components/schemas/Project"},"error":{"type":"string"}}}}}}}}},"400":{"description":"Invalid body or ids.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/methodologies/{code}":{"get":{"operationId":"getMethodology","summary":"One methodology as its CarbonMeld page shows it (the same object as the MCP's get_methodology).","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9._%-]{1,120}$"},"description":"Catalogue code, e.g. VM0048, AMS-II.G"},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The methodology page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Methodology not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/rankings/{dimension}":{"get":{"operationId":"listRankings","summary":"A dimension's leaderboards as the site's index lists them (the same object as the MCP's get_ranking with a dimension only).","parameters":[{"name":"dimension","in":"path","required":true,"schema":{"type":"string","enum":["sector","country","standard","methodology"]}},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The boards.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/rankings/{dimension}/{value}":{"get":{"operationId":"getRanking","summary":"One leaderboard as its page shows it (the same object as the MCP's get_ranking).","parameters":[{"name":"dimension","in":"path","required":true,"schema":{"type":"string","enum":["sector","country","standard","methodology"]}},{"name":"value","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9._%-]{1,120}$"}},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The board.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Board not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/standards/{code}":{"get":{"operationId":"getStandard","summary":"One standard as its CarbonMeld page shows it (the same object as the MCP's get_standard).","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9._%-]{1,120}$"},"description":"Standard code, e.g. VCS, GS"},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The standard page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Standard not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/developers/{slug}":{"get":{"operationId":"getDeveloper","summary":"One project developer as its CarbonMeld page shows it (the same object as the MCP's get_developer). No company-level score: each project keeps its own rating.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,118}$"},"description":"The developer's slug, as in https://carbonmeld.com/developers/<slug>/"},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0},"description":"Skip this many of its projects (the page's order)"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50},"description":"At most this many projects (default: all of them)"}],"responses":{"200":{"description":"The developer page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Developer not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ccp-tracker":{"get":{"operationId":"getCcpTracker","summary":"The ICVCM CCP tracker as its CarbonMeld page shows it (the same object as the MCP's ccp_tracker).","parameters":[{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}},{"name":"status","in":"query","schema":{"type":"string","enum":["approved","does_not_meet","remedial_action","unlikely_to_meet","withdrawn","under_assessment"]}},{"name":"program","in":"query","schema":{"type":"string","maxLength":120},"description":"A programme's name (part of it) or a standard code, e.g. VCS, GS"},{"name":"methodology","in":"query","schema":{"type":"string","maxLength":120},"description":"A methodology code (ACM0002, AMS-I.E) or words of its name"}],"responses":{"200":{"description":"The tracker's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/buyers/{slug}":{"get":{"operationId":"getBuyer","summary":"An organisation that retired credits, as its CarbonMeld buyer page shows it (the same object as the MCP's get_buyer): each project's rating from the project's current record.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9-]{1,90}$"},"description":"The buyer's slug, as in https://carbonmeld.com/buyers/<slug>/"},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0},"description":"Skip this many of its project entries"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50},"description":"At most this many project entries (default: all of them)"}],"responses":{"200":{"description":"The buyer page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Buyer not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/corsia":{"get":{"operationId":"getCorsia","summary":"The CORSIA registry labels as the CarbonMeld page shows them (the same object as the MCP's corsia_supply).","parameters":[{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The CORSIA page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/claims-changes":{"get":{"operationId":"getClaimsChanges","summary":"The last 30 days' official rule-setter notices and registry label changes CarbonMeld recorded (the same object as the MCP's what_changed).","parameters":[{"name":"view","in":"query","schema":{"type":"string","enum":["all","notices","labels"],"default":"all"}},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"},"description":"Language of the project links"},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0},"description":"Skip this many rows"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100},"description":"At most this many rows (default: 50)"}],"responses":{"200":{"description":"The claims changes' model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/projects/{id}/ranks":{"get":{"operationId":"getProjectRanks","summary":"A project's positions in the leaderboards, as its page shows them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,118}[a-z0-9]$"}},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The ranks.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/projects/{id}/page":{"get":{"operationId":"getProjectPage","summary":"What a project's page says beyond the record, as the page shows it (the same object as the MCP's get_project page part, with the rank chips): its notices, «How this analysis was made», the similar projects and the PDF report's address.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,118}[a-z0-9]$"}},{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}}],"responses":{"200":{"description":"The project page's model.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/mcp":{"post":{"operationId":"mcp","summary":"Model Context Protocol server (JSON-RPC 2.0 over HTTP POST, JSON responses) for AI assistants.","description":"Tools: search_projects, get_project, get_projects, check_offer, corsia_supply, get_buyer, get_methodology, get_ranking, get_standard, get_developer, ccp_tracker, my_portfolio, what_changed, get_method, search_articles. Protocol 2025-06-18. Only tool calls (tools/call) count towards the daily request limit; connecting, listing tools and other protocol messages have their own limit (3000 a day per account). Guide: https://carbonmeld.com/premium/mcp/","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"method":{"type":"string"},"params":{"type":"object"}}}}}},"responses":{"200":{"description":"A JSON-RPC response.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"202":{"description":"A notification, accepted."},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/method":{"get":{"operationId":"getMethod","summary":"CarbonMeld's rating method, methodology v3, as its page /methodology/ shows it: sections, rule cards and dimensions (the same object as the MCP's get_method). Ask one of section, rule or dimension, or none for the page's index; a v2.2 rule id gives that rule and its place in v3.","parameters":[{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}},{"name":"section","in":"query","schema":{"type":"string","maxLength":120},"description":"A section of /methodology/: its id (how-the-number-is-made, bands, start-rules, no-number) or words of its title"},{"name":"rule","in":"query","schema":{"type":"string","maxLength":120},"description":"A rule id, e.g. Q-FNRB-ABOVE, the start of ids, e.g. Q-FNRB, or a card's key (case ignored); a v2.2 id (CM-…) gives that rule and its place in v3"},{"name":"criterion","in":"query","schema":{"type":"string","maxLength":120},"description":"Methodology v2.2 only: methodology v3 has no criteria (ask a dimension)"},{"name":"dimension","in":"query","schema":{"type":"string","enum":["additionality","quantification","permanence","claim_safety","overall"]}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0},"description":"Skip this many rules (criterion, dimension, start of ids)"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":25}}],"responses":{"200":{"description":"The page's model for the question.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such section, rule, criterion or dimension.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/articles":{"get":{"operationId":"searchArticles","summary":"CarbonMeld's articles searched as the site's article index lists them (the same object as the MCP's search_articles).","parameters":[{"name":"lang","in":"query","schema":{"type":"string","enum":["en","zh","ja"],"default":"en"}},{"name":"query","in":"query","schema":{"type":"string","maxLength":120},"description":"Words that must all appear in the title, the summary or a tag"},{"name":"tag","in":"query","schema":{"type":"string","maxLength":120},"description":"A tag or its page's slug"},{"name":"from","in":"query","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"description":"First day (included)"},{"name":"to","in":"query","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"description":"Last day (included)"},{"name":"sort","in":"query","schema":{"type":"string","enum":["newest","oldest"],"default":"newest"}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}}],"responses":{"200":{"description":"One page of the matching articles (none: total 0).","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/portfolio":{"get":{"operationId":"getPortfolio","summary":"Your own portfolio (My portfolio), as its page shows it: the saved projects with their ratings (a methodology v3 rating with its band, a v2.2 score labelled v2.2, or no number), the dimension values when every rated project is on one methodology version, the negative facts of the projects read under methodology v3 and the red flags of the projects that keep a v2.2 score, analysis and registry states, vintages and listings; the average of the v3 ratings, the negative-facts total and the red-flag total (never added together); the changes left this week; the change alerts of the last 30 days (the same object as the MCP's my_portfolio). Read only; it uses none of the daily project quota.","responses":{"200":{"description":"The portfolio.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["model","model_version","url","projects_count","max","average_rating","red_flags_total","unavailable_count","weekly_changes","projects","recent_alerts"],"properties":{"model":{"const":"portfolio"},"model_version":{"type":"integer"},"url":{"type":"string","description":"The portfolio page"},"projects_count":{"type":"integer","description":"The projects saved"},"max":{"type":"integer","description":"The most an account can save"},"average_rating":{"type":["number","null"],"description":"The average CarbonMeld rating of the rated projects (one decimal); null when none is rated or a record could not be loaded"},"dimensions_version":{"type":["string","null"],"enum":["v3","v2.2",null],"description":"Methodology v3: whose dimension values the rows give (v3's, Premium; or v2.2's); null when the projects mix versions"},"dimensions_note":{"type":"string","description":"Why no dimension values are given: the projects are rated under different methodology versions"},"red_flags_total":{"type":["integer","null"],"description":"The red flags of the projects that keep a v2.2 score (version 2.2's red flags); null when there is none or a record could not be loaded. Never added to negative_facts_total"},"negative_facts_total":{"type":["integer","null"],"description":"Methodology v3: the negative facts of the projects read under v3 (rated, too early to rate, not yet assessable, or no public grade applies yet); null when there is none or a record could not be loaded. Never added to red_flags_total"},"unavailable_count":{"type":"integer","description":"Projects whose record could not be loaded now (their row says why)"},"weekly_changes":{"type":"object","additionalProperties":false,"required":["left","per_week"],"properties":{"left":{"type":"integer"},"per_week":{"type":"integer"}},"description":"Portfolio changes (add or remove, on the site) left this ISO week"},"projects":{"type":"array","description":"The saved projects, oldest first, as the portfolio page's rows","items":{"type":"object","additionalProperties":false,"required":["id","registry_code","name","url","added_at","loaded","rating","dimension_scores","red_flags_count","analysis_status","analysis","registry_status","vintages","listings_count","analysis_date"],"properties":{"id":{"type":"string"},"registry_code":{"type":"string"},"name":{"type":["string","null"]},"url":{"type":"string"},"added_at":{"type":["string","null"]},"loaded":{"type":"boolean","description":"false: the record could not be loaded now (error says why); retry later"},"error":{"type":"string"},"rating":{"type":["number","null"],"description":"The published CarbonMeld rating 0-10, or null (the page's score gate)"},"provisional":{"const":true,"description":"The last published rating, kept while the project is re-assessed"},"rating_note":{"type":"string"},"methodology_version":{"type":"string","description":"CarbonMeld's method version of a provisional rating"},"dimension_scores":{"type":["object","null"],"additionalProperties":false,"properties":{"integrity":{"type":["number","null"]},"transparency":{"type":["number","null"]},"claim_safety":{"type":["number","null"]},"documentation":{"type":["number","null"]},"additionality":{"type":["number","null"]},"quantification":{"type":["number","null"]},"permanence":{"type":["number","null"]}},"description":"The dimension values (0-10) of the version dimensions_version names: methodology v3's additionality, quantification, permanence (only where carbon is stored) and claim safety, or version 2.2's integrity, transparency, claim safety and documentation; null when the premium record is not available"},"rating_state":{"type":["string","null"],"enum":["rated","v22","too_early","not_yet","type_not_graded","withheld",null],"description":"Methodology v3: rated (the v3 number), v22 (a version 2.2 score kept, labelled), too_early / not_yet / type_not_graded / withheld (no number; type_not_graded: no public grade of this type of project applies yet; withheld: no rating shown at present)"},"rating_band":{"type":"string","enum":["high","moderate","low","very_low"],"description":"Methodology v3: the band of a v3 rating"},"red_flags_count":{"type":["integer","null"],"description":"Only for a rated project that keeps its v2.2 score (version 2.2's red flags); null for a project read under methodology v3"},"red_flags":{"type":"array","items":{"type":"string"}},"negative_facts_count":{"type":["integer","null"],"description":"Methodology v3: the negative facts of a project read under v3 (the project page's lines)"},"negative_facts":{"type":"array","items":{"type":"string"},"description":"Methodology v3: those negative facts, one line each, as the project page words them"},"analysis_status":{"type":["string","null"]},"analysis":{"type":["string","null"],"description":"The analysis state in the page's words"},"not_carbon_credit":{"type":"string"},"registry_status":{"type":["string","null"]},"registry_status_key":{"type":"string"},"vintages":{"type":["string","null"],"description":"The issued vintages' span and the vintage note, as the page shows them"},"listings_count":{"type":"integer"},"analysis_date":{"type":["string","null"]},"updating":{"const":true,"description":"The project is being re-published: no premium figures in this answer"}}}},"recent_alerts":{"type":["array","null"],"description":"The change alerts of the last 30 days for these projects (the e-mail alerts' lines), newest first; null when they could not be read","items":{"type":"object","additionalProperties":false,"required":["id","name","detected_at","changes"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"detected_at":{"type":"string"},"changes":{"type":"array","items":{"type":"string"}}}}},"quota":{"type":"object","additionalProperties":false,"required":["limit","used_today","left"],"description":"The daily project quota after this call, from the same counter the quota check uses: distinct premium projects opened today (UTC). Projects already opened today, owned or gifted projects and public-only records count 0.","properties":{"limit":{"type":"integer","description":"Distinct premium projects per UTC day"},"used_today":{"type":"integer","description":"Distinct projects opened today that count"},"left":{"type":"integer","description":"limit − used_today (never below 0)"}}},"note":{"type":"string"}}}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or project limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable: retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/check-offer":{"post":{"operationId":"checkOffer","summary":"Check a carbon credit offer (pasted text) against public registry facts: registration, vintage issued and still available, CORSIA/CCP/Article 6 claims vs registry labels, seller vs developer (the same object as the MCP's check_offer). Each call uses one of the day's offer checks, shared with the website's offer checker and the MCP.","description":"20 offer checks per account and UTC day, one counter for the website, the MCP and this request; the call also counts towards the daily request limit. A call without text is refused before it uses a check.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The offer text. Several projects: one lot per line (a project's code, its vintage, quantity and claims)"},"vintage":{"type":"integer","description":"Overrides the text's vintage; used only when the text names one project"},"quantity":{"type":"integer","description":"Overrides the text's quantity (t); used only when the text names one project"},"seller":{"type":"string"}}}}}},"responses":{"200":{"description":"The offer as read, and each project's checks.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["parsed","projects"],"properties":{"parsed":{"type":"object","additionalProperties":false,"required":["codes","vintages","quantity","quantityNote","claims","seller"],"properties":{"codes":{"type":"array","items":{"type":"string"},"description":"The registry codes found in the text"},"vintages":{"type":"array","items":{"type":"integer"}},"vintage":{"type":"integer","description":"The explicit vintage argument, when it applied (one project named)"},"quantity":{"type":["integer","null"]},"quantityNote":{"type":"string"},"claims":{"type":"object","additionalProperties":false,"required":["corsia","ccp","article6","removal"],"properties":{"corsia":{"type":["boolean","null"]},"ccp":{"type":["boolean","null"]},"article6":{"type":["boolean","null"]},"removal":{"type":["boolean","null"]}}},"seller":{"type":"string"},"lots":{"type":"array","description":"Several projects named: each one's own vintage, quantity and claims","items":{"type":"object","additionalProperties":false,"required":["code","attributed","vintages","quantity","quantityNote","claims"],"properties":{"code":{"type":"string"},"attributed":{"type":"boolean"},"vintages":{"type":"array","items":{"type":"integer"}},"quantity":{"type":["integer","null"]},"quantityNote":{"type":"string"},"claims":{"type":"object","additionalProperties":false,"required":["corsia","ccp","article6","removal"],"properties":{"corsia":{"type":["boolean","null"]},"ccp":{"type":["boolean","null"]},"article6":{"type":["boolean","null"]},"removal":{"type":["boolean","null"]}}}}}},"lotNotes":{"type":"array","items":{"type":"string"}}}},"projects":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","result","checks"],"properties":{"code":{"type":"string"},"id":{"type":"string","description":"The CarbonMeld project id the code resolves to"},"result":{"type":"string","enum":["checked","not_found","no_public_record","unavailable"]},"name":{"type":"string"},"vintages_fetched_at":{"type":["string","null"]},"claims_checked_at":{"type":["string","null"]},"retryable":{"const":true,"description":"On unavailable: a retryable non-verdict, never a negative finding"},"checks":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["level","text"],"properties":{"level":{"type":"string","enum":["ok","info","warn","bad"]},"text":{"type":"string"}}}}}}},"note":{"type":"string"}}}}}},"400":{"description":"Invalid body, or no offer text.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, expired or revoked credentials (a WWW-Authenticate header names the sign-in metadata).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account has no active Premium access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Request, burst or daily offer-check limit reached: respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The registries, or every project the offer names, could not be checked right now: retry later. With projects named, the body also carries the object, each project «unavailable» (a retryable non-verdict).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}