// CarbonMeld MCP server + REST API — TypeScript types for Code Mode clients. // Generated by scripts/build_mcp_types.mjs from workers/premium/index.js (the MCP_TOOLS schemas and the OpenAPI // document). Do not edit by hand — run the script again. // // Code Mode (e.g. Cloudflare's Code Mode / Agents SDK): the server's tools as a typed API. Every input and output // below matches the schema the server declares (inputSchema / outputSchema); a successful tools/call returns the // output both as JSON text and as structuredContent. Server: https://carbonmeld.com/api/v1/mcp — sign in with a // CarbonMeld account (OAuth) or send a Premium API key as a Bearer token. Guide: https://carbonmeld.com/premium/mcp/ // ── MCP tools ──────────────────────────────────────────────────────────────── /** Search CarbonMeld's indexed carbon credit projects by words, standard, country, methodology, sector, scoring sector, developer, analysis status, minimum rating or claim, in the list's order or sorted by rating or name. Returns the total number of matches and one page of them (limit, offset; next_offset when more remain): id, name, registry code, standard, country with its ISO code, methodology, sector, scoring sector, developer, CarbonMeld rating with its analysis status, date and methodology version (a rating kept while the project is re-assessed is flagged provisional), claim tags and the project page's URL. sector is the project's type as listed; scoring_sector is the sector it was rated under (the rules applied), the one get_ranking's sector boards use. An invalid filter is an error, never «no results». */ export interface SearchProjectsInput { /** Words that must all appear in the project's name, registry code, country, methodology or sector (e.g. «cookstove», «VCS-1477») */ "query"?: string; /** Country: an ISO 3166-1 alpha-2 code (e.g. KE) or a country name (e.g. Kenya) */ "country"?: string; /** Methodology catalogue code, e.g. VM0048, ACM0002, AMS-II.G */ "methodology"?: string; /** Project type, as the list describes it */ "sector"?: "arr" | "biochar" | "biogas" | "biomass" | "blue_carbon" | "cookstoves" | "dac" | "industrial" | "industrial_gases" | "methane" | "other" | "redd" | "renewable_energy" | "soil_carbon" | "water"; /** The sector the project was rated under (the rules applied): the grouping of get_ranking's sector boards */ "scoring_sector"?: "arr" | "biochar" | "biogas" | "biomass" | "blue_carbon" | "cookstoves" | "dac" | "industrial" | "industrial_gases" | "methane" | "other" | "redd" | "renewable_energy" | "soil_carbon" | "water"; /** Standard code, e.g. VCS, GS, CDM, ACR, CAR, PUR */ "registry"?: string; /** Minimum CarbonMeld rating 0-10 */ "min_score"?: number; "claim"?: "corsia" | "corsia_first" | "ccp" | "ccp_meth" | "removal" | "article6"; /** Project developer: its name as CarbonMeld lists it (e.g. «South Pole Ltd») or its CarbonMeld slug; an ambiguous name is an error listing the candidates */ "developer"?: string; /** rated = projects with a published CarbonMeld rating; ranked = the rated ones a leaderboard ranks (registry status past pipeline / validation); the others are analysis statuses */ "status"?: "rated" | "ranked" | "scored" | "rescore_pending" | "pending" | "not_registered" | "stale"; /** default = the list's own order; rating_desc / rating_asc put projects without a rating last */ "sort"?: "default" | "rating_desc" | "rating_asc" | "name"; "limit"?: number; /** Skip this many matches (paging: use next_offset) */ "offset"?: number; } export type SearchProjectsOutput = { /** Every match (results is one page of them) */ "total": number; "offset": number; "limit": number; /** Pass as offset for the next page; absent when no more remain */ "next_offset"?: number; /** The resolved developer, when the developer filter was used */ "developer"?: { "slug": string; "name": string; }; "results": Array<{ "id": string; "name"?: string; "registry_code"?: string; "standard"?: string; "country"?: string; /** ISO 3166-1 alpha-2 */ "country_code": string; /** The project's own crediting methodology */ "methodology": string; "sector": string; /** The sector the project was rated under (the leaderboards' grouping) */ "scoring_sector": string; /** The developer's CarbonMeld slug */ "developer": string; /** CarbonMeld's published 0–10 rating, or null when the project has none (the page's score gate) */ "rating": number | null; /** scored, rescore_pending, pending, not_registered, stale, archived */ "analysis_status": string | null; /** The analysis' day (YYYY-MM-DD) when a rating is published */ "analysis_date": string | null; /** The version of CarbonMeld's rating method (e.g. v2.2) — not the project's own crediting methodology */ "methodology_version": string | null; /** Present (true) only when the rating is kept while the project is re-assessed (rescore_pending) */ "provisional"?: true; /** With provisional: why the project is re-assessed (inputs, methodology), or null */ "reassessment_reason"?: string | null; /** The wording of a provisional or not-a-carbon-credit rating, of a state with no number, or of a rating whose type has a public grade on one dimension only */ "rating_note"?: string; /** What the record is, when it is not a carbon credit */ "not_carbon_credit"?: string; /** Methodology v3: rated, too_early (too early to rate), not_yet (not yet assessable), type_not_graded (no public grade of this type of project applies yet: analysed, no number), withheld (no rating shown at present: rating_note says why), v22 (a version 2.2 score kept) */ "rating_state"?: "rated" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | "v22"; /** Methodology v3: the rating's band (6.5 or more / 5.0–6.4 / 3.5–4.9 / under 3.5) */ "rating_band"?: "high" | "moderate" | "low" | "very_low"; /** Methodology v3: how much of the evidence was read — shown beside the rating, never in it (also on a type_not_graded record: its documents were read) */ "evidence_coverage"?: "high" | "medium" | "low"; /** The registry status key (registered, pipeline, rejected, …) */ "registry_status": string; /** The registries' own labels */ "claims": Array<"corsia" | "corsia_first" | "ccp" | "ccp_meth" | "removal" | "article6">; /** The project page's URL */ "url": string; }>; /** «No match.», an offset-past-the-end note, or how many matches a rating filter left out because no public grade of their type of project applies, when applicable */ "note"?: string; } /** CarbonMeld record of one project: rating and analysis (methodology v3: the document-based rating, or a v2.2 score labelled v2.2; its negative facts; red flags only for a page that keeps a v2.2 score, as data from that v2.2 analysis — a page read under v3 shows none, and its answer gives none), registry status, vintages issued/retired, claims block (CORSIA, ICVCM CCP, Article 6, removal), developer, buyers, documents (each with its document page when it has one), with the project page's URL and what the page says beyond the record (page: its notices as printed — archived, re-assessment, registry status, analysis version, monitoring period, CDM closure —, «How this analysis was made», similar projects, the PDF report's address). Choose sections to get only some parts, and lang for the translated texts. Each project not yet opened today counts 1 of the account's daily project quota (every project answer's quota block gives its limit, used_today and left), so search first (search_projects is free) and open only what the user needs. The answer carries the quota left (quota). */ export interface GetProjectInput { /** CarbonMeld project id (slug) or registry code */ "id": string; /** Language of the translated texts (translations.); default en, which gives no translations */ "lang"?: "en" | "zh" | "ja"; /** Only these parts besides the identity, rating, status and dates that always come; default: every part */ "sections"?: Array<"summary" | "score" | "red_flags" | "documents" | "vintages" | "claims" | "buyers" | "market" | "methodology_history" | "page">; } export type GetProjectOutput = { "id"?: string; "registry_code"?: string; "project_name"?: string; /** The project page's URL */ "url"?: string; /** The Premium record's project description is non-empty and longer than the public one by more than 20 characters (the export of 5 Nov 2026 on; absent in older exports) */ "premium_description_more"?: boolean; "carbonmeld_rating": { /** CarbonMeld's published 0–10 rating, or null when the project has none (the page's score gate) */ "rating": number | null; /** scored, rescore_pending, pending, not_registered, stale, archived */ "analysis_status": string | null; /** The analysis' day (YYYY-MM-DD) when a rating is published */ "analysis_date": string | null; /** The version of CarbonMeld's rating method (e.g. v2.2) — not the project's own crediting methodology */ "methodology_version": string | null; /** Present (true) only when the rating is kept while the project is re-assessed (rescore_pending) */ "provisional"?: true; /** With provisional: why the project is re-assessed (inputs, methodology), or null */ "reassessment_reason"?: string | null; /** The wording of a provisional or not-a-carbon-credit rating, of a state with no number, or of a rating whose type has a public grade on one dimension only */ "rating_note"?: string; /** What the record is, when it is not a carbon credit */ "not_carbon_credit"?: string; /** Methodology v3: rated, too_early (too early to rate), not_yet (not yet assessable), type_not_graded (no public grade of this type of project applies yet: analysed, no number), withheld (no rating shown at present: rating_note says why), v22 (a version 2.2 score kept) */ "rating_state"?: "rated" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | "v22"; /** Methodology v3: the rating's band (6.5 or more / 5.0–6.4 / 3.5–4.9 / under 3.5) */ "rating_band"?: "high" | "moderate" | "low" | "very_low"; /** Methodology v3: how much of the evidence was read — shown beside the rating, never in it (also on a type_not_graded record: its documents were read) */ "evidence_coverage"?: "high" | "medium" | "low"; }; /** Methodology v3: the document-based rating's record as the project page reads it (the number, when there is one, is carbonmeld_rating's). Every code below comes with the page's own words. */ "doc_rating"?: { "method"?: "v3"; /** Methodology v3: rated, too_early (too early to rate), not_yet (not yet assessable), type_not_graded (no public grade of this type of project applies yet: analysed, no number), withheld (no rating shown at present: rating_note says why), v22 (a version 2.2 score kept) */ "state"?: "rated" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | "v22"; /** Why a page has no number (too_early / not_yet / withheld; null otherwise): early_or_inactive: «The project is at an early stage, or inactive: no credits have been issued, and the registry lists no validation or verification report.» · issued_no_report_read: «Credits have been issued, but no validation or verification report has been read yet.» · later_stage: «The project is past its early stage, but no validation or verification report is listed or has been read.» · no_registry_status: «No validation or verification report has been read, and the registry gives no status for the project.» · vv_file_stored_not_read: «A validation or verification report is stored but has not been read yet.» · vv_listed_not_stored: «The registry lists a validation or verification report that is not held here yet.» · hold (withheld): «The latest analysis of this project is held for review. While it is held, the page shows no rating.» · hold_active (withheld): «The latest analysis of this project is held for review. While it is held, the page shows no rating.» · audit_changed (withheld): «The project was analysed again after the rating rules were last applied to it. The page shows no rating until they are applied to the new analysis.» · v22_changed (withheld): «The project was analysed again after the rating rules were last applied to it. The page shows no rating until they are applied to the new analysis.» · off_shape (withheld): «The rating of this page did not pass CarbonMeld's checks before publication, so the page shows none.» · engine (withheld): «The rating of this page did not pass CarbonMeld's checks before publication, so the page shows none.» */ "reason"?: string | null; /** true: «Credits issued under this methodology cannot receive the CCP label (ICVCM, 15 Nov 2024).» */ "ccp_label_line"?: boolean; /** Each dimension's starting point and its public source */ "start"?: Array<{ "dim"?: "A" | "Q" | "P" | "C"; /** The source of the starting point: ccqi: «CCQI's score for this type of project» · icvcm: «the ICVCM's decision on this methodology» · eu_class: «the EU class of permanent carbon removals» · neutral: «neutral (5.0) — no public grade of this type of project applies» (on a type_not_graded page, neutral: «no public grade of this type of project applies») (on a rated page, on P with params.programme_not_graded true, neutral: «neutral (5.0) — CCQI does not grade this programme's approach to permanence») (with params.basis registry_label, any source but neutral: «the registry's CCP label on this project's credits») (eu_class with params.class_basis own_judgement: «our own judgement — the EU's class of permanent carbon removals does not name this type of project») */ "source"?: string; /** On a ccqi start: type_grade true «(CCQI does not list this methodology under this programme: the grade CCQI gives this type of project under the programme)» · graded_version (a string) «(CCQI grades version {version} of this methodology)» ({version}: params.graded_version) · by_programme true «(CCQI grades permanence by programme: this is its grade of the project's programme)» · programme_not_graded true «(CCQI does not grade this programme for this type of project: the CDM grade is used)» · borrowed true (older rows): as type_grade on A and Q, as by_programme on P · on an icvcm start without params.basis registry_label: conditions_shown true «(approved with conditions, and the documents read show every condition met)» · any other flag that is true, except cdm_criterion_1_2, graded_no_number, conditional_with_label and conditions_shown: «(a note on this source is not available on this page yet)» */ "params"?: { /** «(CCQI does not list this methodology under this programme: the grade CCQI gives this type of project under the programme)» */ "type_grade"?: boolean; /** «(CCQI grades version {version} of this methodology)» */ "graded_version"?: string; /** «(CCQI grades permanence by programme: this is its grade of the project's programme)» */ "by_programme"?: boolean; /** «(CCQI does not grade this programme for this type of project: the CDM grade is used)» */ "programme_not_graded"?: boolean; /** «(approved with conditions, and the documents read show every condition met)» */ "conditions_shown"?: boolean; [key: string]: unknown; }; [key: string]: unknown; }>; /** What was not counted, as the page words it */ "not_assessed"?: Array<{ /** a_route_not_matched: «Additionality: CCQI does not list this methodology under this programme, and its grades for this type of project there differ by methodology» · a_types_differ: «Additionality: the activity spans several of CCQI's types of project, and their grades differ» · additionality_test_not_stated: «The additionality test: not among the facts read» · baseline_type_not_read: «The baseline type: not among the facts read» · baseline_type_not_stated: «The baseline type: the documents read do not state it» · baseline_type_read_no_rule: «The baseline type: read, but no rule of the rating uses it» · buffer_not_stated: «The buffer share: the documents read do not state it» · buffer_stated_not_settled: «The buffer share: stated in a document read, but not settled by this analysis» · ccqi_no_type: «{dims}: CCQI's tool has no type of project for this activity» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · ccqi_programme_not_graded: «{dims}: CCQI does not grade this programme for this type of project, and the page's methodology is the programme's own, so no CDM grade stands in» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · ccqi_type_not_shown: «{dims}: the facts read do not show which of CCQI's types of project this activity is, so no CCQI grade applies» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · commitment_group_document_not_matched (by params.reason): group_entry «The commitment period: this entry holds the group's shared documents and is not a project itself; the durations in them belong to the member projects»; several_durations «The commitment period: the group's shared document lists several durations, and this project's own row is not matched»; table_not_read «The commitment period: the duration table of the group's shared document could not be read, so this project's own row is not matched» · commitment_own_row_no_change: «The commitment period: this project's own row of the group's shared document gives a length from 60 to 99 years, where the rule changes nothing» · earlier_qualified_opinion: «An earlier verification opinion was qualified: only the latest opinion read counts» · end_use_not_tracked: «The tracking of the end use of the biochar: not among the facts read» · fact_not_asked: «{fact}: not asked in this analysis» ({fact}: params.fact — baseline_type «The baseline type», buffer_pct «The buffer share», fnrb «The fNRB value», fnrb_source «The source of the fNRB value», fuel_consumption_method «The fuel-consumption method», leakage_pct «The leakage deduction») · fact_not_determined: «{fact}: asked, but not determined from the documents read» ({fact}: params.fact — baseline_type «The baseline type», buffer_pct «The buffer share», fnrb «The fNRB value», fnrb_source «The source of the fNRB value», fuel_consumption_method «The fuel-consumption method», leakage_pct «The leakage deduction») · feedstock_not_addressed: «The sustainability of the feedstock: not among the facts read» · fnrb_mofuss_year_not_stated: «The fNRB value: it comes from MoFuSS, but the documents read do not state the year of the assessment, so the exemption for a MoFuSS assessment of 2024 or later does not apply and the value is compared with the official national value» · fnrb_not_stated: «The fNRB value: the documents read do not state it» · fnrb_source_not_stated: «The source of the fNRB value: the documents read do not state it» · fuel_method_read_no_rule: «The fuel-consumption method: read, but no rule of the rating uses it» · icvcm_not_applied (by params.reason): activity_not_covered «The ICVCM's decision: it covers other activities, not this project's activity»; activity_not_determinable «The ICVCM's decision: it covers one activity of this protocol only, and the documents read do not show this project's activity»; component_decision «The ICVCM's decision: it covers a component of this project, not its main methodology, so it does not grade the project»; conditions_not_shown «The ICVCM's decision: the ICVCM approved this methodology under conditions, and the documents read do not show them met»; mixed_components «The ICVCM's decision: the project combines methodologies with different ICVCM decisions»; not_decided «The ICVCM's decision: the ICVCM has not decided on this methodology»; programme_not_assessed «The ICVCM's decision: the ICVCM decided on this methodology only for other programmes, not for this project's programme»; under_assessment «The ICVCM's decision: the ICVCM is still assessing this methodology»; version_not_determinable «The ICVCM's decision: it depends on the methodology's version, and the documents read do not show which version applies»; version_not_on_the_list «The ICVCM's decision: this methodology version is not on the ICVCM's assessment list»; withdrawn_from_assessment «The ICVCM's decision: this version was withdrawn from the ICVCM's assessment by its programme, so the ICVCM has made no decision on it» · leakage_amount_computed_share: «The leakage deduction: stated as an amount, {amount_t} t CO2e ({share_pct}% of the reductions before leakage, computed from the same row of the document)» ({amount_t}: params.amount_t) ({share_pct}: params.share_pct) · leakage_not_addressed: «Leakage: not among the facts read» · leakage_not_stated: «The leakage deduction: the documents read do not state it» · leakage_secondary_effects: «The leakage deduction: this protocol calls it secondary effects» · no_usage_monitoring: «The usage rate of the devices: not among the facts read» · opinion_shown_not_scored: «The verification opinion read as {kinds}: shown, not counted, because this programme's own definition of it has not been sourced» ({kinds}: params.kinds — adverse «adverse», qualified «qualified») · permanence_claim_not_stated: «How long the carbon stays stored: not among the facts read» · q_methodology_not_listed: «Quantification: CCQI does not grade this methodology under this programme, so no public grade applies» · q_no_methodology_read: «Quantification: the documents read do not name the project's main methodology, so no CCQI grade of it applies» · q_types_differ: «Quantification: CCQI's grade of the methodology differs between the types of project the activity spans» · q_version_not_stated: «Quantification: the documents read name the methodology without its version, so CCQI's grade of a given version cannot be applied» · q_version_separated: «Quantification: CCQI grades version {version} of this methodology, and an ICVCM decision's version range separates this project's version from it» ({version}: params.version) · reversal_stated_not_scored: «A reversal or loss stated in the documents read: shown, not counted» · vintage_no_issuance_records: «The vintage: the registry records we hold show no issuance» · vintage_on_sale_safeguards_verifier: «The oldest vintage still on sale, the content of the safeguards and the verifier's quality: not among the facts read» · vintage_only_pending_units: «The vintage: no Woodland Carbon Units are issued yet, only Pending Issuance Units» · any other code: «An item that the rating does not count (its description is not available on this page yet)» */ "code"?: string; "params"?: { /** The page line of a code with a reason (see code) */ "reason"?: string; /** opinion_shown_not_scored's {kinds}: adverse «adverse», qualified «qualified» */ "kinds"?: Array; [key: string]: unknown; }; [key: string]: unknown; }>; /** The negative facts, as the page words them: registry_status (params.status): suspended «Registry status: suspended», rejected «Registry status: rejected», issuance_denied «Registry status: issuance denied», withdrawn «Registry status: withdrawn or not delivered», on_hold «Registry status: On Hold» · registry_review_open: «The registry opened a review of this project» · corrective_action_open: «The latest verification report read leaves a corrective action request open» · opinion (params.kind): adverse «The verification opinion read: adverse», qualified «The latest verification opinion read: qualified» · registry_remedy (params.kinds): «The registry's record shows:» + excess_status «credits issued in excess», credit_cancellation «credits cancelled», over_issuance «an over-issuance», replacement «credits replaced», project_cancellation «the project cancelled», rejection «a rejection», issuance_condition «a condition on further issuance» · document_fact (params.rule, the fact's values): A-LEGAL «The documents read state that the law requires the activity.», A-TEST-NOT-STATED «The documents read state no additionality test.», Q-LEAKAGE-NOT-ADDRESSED «The documents read do not address leakage.», Q-NO-USAGE-MONITORING «The documents read report no usage rate of the devices.», P-END-USE-NOT-TRACKED «The documents read state that nobody tracks the end use of the biochar.», P-STORAGE-TIME-NOT-STATED «The documents read do not state how long the carbon stays stored.», C-FEEDSTOCK-NOT-ADDRESSED «The documents read state that the project does not address the feedstock's sustainability.», Q-FNRB-OLD-DEFAULT «The fNRB value used ({fnrb}%) is an older CDM default value.», Q-FNRB-ABOVE «The fNRB value used ({fnrb}%) is more than 30% above the official value.», Q-FNRB-ABOVE-2X «The fNRB value used ({fnrb}%) is more than twice the official value.», P-BUFFER-LOW «The buffer share ({buffer}%) is under the programme's minimum ({minimum}%).», Q-LEAKAGE-ZERO «The documents state a leakage deduction of zero, under one of Verra's four older REDD+ methodologies (VM0006, VM0007, VM0009, VM0015). A published study of these projects found that taking no leakage deduction is likely to over-credit.» · any other code: «A negative fact that the rating counts (its description is not available on this page yet)» */ "negative"?: Array; /** A v22 page's missing facts: buffer_not_in_sheet «the buffer share (it is not among the facts read)» · fnrb_source_not_asked «the source of the fNRB value (it was not asked when this page was analysed)» · leakage_not_in_sheet «the leakage deduction (it is not among the facts read)» */ "missing"?: Array; [key: string]: unknown; } | null; /** Echoed when the sections argument was used */ "sections"?: Array<"summary" | "score" | "red_flags" | "documents" | "vintages" | "claims" | "buyers" | "market" | "methodology_history" | "page">; /** Only the language asked for (translations.); absent for en */ "translations"?: { [key: string]: unknown; }; /** The project's positions in the leaderboards; empty while they cannot be read or the project is ranked nowhere (a ranks failure never fails the record) */ "ranks"?: Array<{ [key: string]: unknown; }>; /** Present only where the registry's years in vintages are years of ISSUANCE, not vintages (the year the reductions or removals took place): CDM and BCarbon. Absent: the years are the registry's vintages. */ "vintage_basis"?: "issuance_year"; /** CDM only: each issuance of the project, from the UNEP CDM pipeline's copy of the registry's issuance list — its monitoring period, the day it was issued and its units; summed by the year of issue_date they give back vintages. A period that cannot be right is left out (period_start / period_end absent). */ "issuances"?: Array<{ /** The first day of the monitoring period (YYYY-MM-DD) */ "period_start"?: string; /** The last day of the monitoring period (YYYY-MM-DD) */ "period_end"?: string; /** The day the registry issued the credits (YYYY-MM-DD) */ "issue_date"?: string; /** Credits issued (CERs) */ "units": number; }>; /** A Gold Standard programme of activities only (absent on every other page): its VPAs, the units the registry issues its credits to. own_issuance false: the programme holds no credit records of its own and its page shows this box IN PLACE OF a vintage table (its credits are its VPAs'); true: it also holds credits of its own (both shown); null: not yet read under this rule (the page shows its vintage table, no box) */ "programme_units"?: { /** The day these figures were computed (YYYY-MM-DD) */ "as_of"?: string; /** The VPAs CarbonMeld holds a record of */ "units"?: Array<{ "code"?: string; /** The VPA's page id (get_project accepts it) */ "slug"?: string; "name"?: string; /** false: archived, no page to open */ "has_page"?: boolean; /** Credits the registry issued to this VPA */ "issued"?: number; "retired"?: number; /** Its monitoring reports we hold */ "mr_count"?: number; /** Its verification reports we hold */ "vr_count"?: number; /** Its reports we hold with no known date (then newest_report is null: its newest is not known) */ "undated"?: number; /** null when it has no report, or when one of its reports has no known date */ "newest_report"?: { "type"?: string; "date"?: string; /** Where the date comes from: facts (read in the report), triage, registry_list */ "date_source"?: string; } | null; [key: string]: unknown; }>; /** Records naming the programme (archived included) */ "units_total"?: number; /** Of them, those with a page */ "units_listed"?: number; /** Credits issued to the VPAs we hold (the sum of their own issuance) */ "issued_by_units"?: number; "retired_by_units"?: number; /** VPAs the registry lists that CarbonMeld holds no record of; null while the programme has not been read for them yet */ "untracked"?: { "units"?: number; "issued"?: number; "retired"?: number; } | null; "reports"?: { "mr"?: number; "vr"?: number; /** The newest report's date; null when none, or when a VPA's report has no known date */ "newest"?: string | null; /** Reports with no known date */ "undated"?: number; /** Where newest's date comes from: facts or triage (a report's own date — it wins a tie on the same day), registry_list (the day the registry's document list shows the report uploaded; the site says «listed»), null when newest is null */ "newest_source"?: string | null; }; /** true / false / null — see this field's description */ "own_issuance"?: boolean | null; [key: string]: unknown; }; /** What the project page says beyond the record, in the language asked for (GET /api/v1/projects//page): notices (the page's banners and notes as it prints them: archived, reassessment, registry_status, analysis_version, monitoring_period, standard_stated, cdm), basis («How this analysis was made»: standard, methodology, their rules, the method's version, the analysis' day, the documents it had), similar and same_project (the page's links), report (the PDF report's address; it opens for a signed-in Premium account on the site). Absent while it cannot be read (it never fails the record); each document with a page of its own carries page_url. */ "page"?: { [key: string]: unknown; }; /** 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. */ "quota"?: { /** Distinct premium projects per UTC day */ "limit": number; /** Distinct projects opened today that count */ "used_today": number; /** limit − used_today (never below 0) */ "left": number; }; [key: string]: unknown; } /** CarbonMeld records of several projects in one call (for Code Mode clients fetching a set): the same record as get_project for each id, in the ids' order, with a per-id error (unknown id, quota reached, project being updated, temporary error) where one id fails. Choose sections and lang as in get_project. Each project not yet opened today counts 1 of the account's daily project quota (every project answer's quota block gives its limit, used_today and left), so search first (search_projects is free) and open only what the user needs. The answer carries the quota left (quota). Ids past the invocation's request limit come back with retryable: true, unopened and free of quota: ask again for those ids. */ export interface GetProjectsInput { /** 1 to 10 CarbonMeld project ids (slugs) or registry codes */ "ids": Array; /** Language of the translated texts (translations.); default en, which gives no translations */ "lang"?: "en" | "zh" | "ja"; /** Only these parts besides the identity, rating, status and dates that always come; default: every part */ "sections"?: Array<"summary" | "score" | "red_flags" | "documents" | "vintages" | "claims" | "buyers" | "market" | "methodology_history" | "page">; } export type GetProjectsOutput = { /** The ids asked for */ "total": number; /** The records returned */ "found": number; /** 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. */ "quota"?: { /** Distinct premium projects per UTC day */ "limit": number; /** Distinct projects opened today that count */ "used_today": number; /** limit − used_today (never below 0) */ "left": number; }; /** One entry per id, in the ids' order */ "results": Array<{ /** The id as asked */ "id": string; "ok": true; /** The project's record as GET /api/v1/projects/ serves it (the public record merged with the Premium details), plus url, carbonmeld_rating and ranks; with lang, only that language's translations; with sections, only those parts besides the identity, rating, status and dates that always come. */ "project": { "id"?: string; "registry_code"?: string; "project_name"?: string; /** The project page's URL */ "url"?: string; /** The Premium record's project description is non-empty and longer than the public one by more than 20 characters (the export of 5 Nov 2026 on; absent in older exports) */ "premium_description_more"?: boolean; "carbonmeld_rating": { /** CarbonMeld's published 0–10 rating, or null when the project has none (the page's score gate) */ "rating": number | null; /** scored, rescore_pending, pending, not_registered, stale, archived */ "analysis_status": string | null; /** The analysis' day (YYYY-MM-DD) when a rating is published */ "analysis_date": string | null; /** The version of CarbonMeld's rating method (e.g. v2.2) — not the project's own crediting methodology */ "methodology_version": string | null; /** Present (true) only when the rating is kept while the project is re-assessed (rescore_pending) */ "provisional"?: true; /** With provisional: why the project is re-assessed (inputs, methodology), or null */ "reassessment_reason"?: string | null; /** The wording of a provisional or not-a-carbon-credit rating, of a state with no number, or of a rating whose type has a public grade on one dimension only */ "rating_note"?: string; /** What the record is, when it is not a carbon credit */ "not_carbon_credit"?: string; /** Methodology v3: rated, too_early (too early to rate), not_yet (not yet assessable), type_not_graded (no public grade of this type of project applies yet: analysed, no number), withheld (no rating shown at present: rating_note says why), v22 (a version 2.2 score kept) */ "rating_state"?: "rated" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | "v22"; /** Methodology v3: the rating's band (6.5 or more / 5.0–6.4 / 3.5–4.9 / under 3.5) */ "rating_band"?: "high" | "moderate" | "low" | "very_low"; /** Methodology v3: how much of the evidence was read — shown beside the rating, never in it (also on a type_not_graded record: its documents were read) */ "evidence_coverage"?: "high" | "medium" | "low"; }; /** Methodology v3: the document-based rating's record as the project page reads it (the number, when there is one, is carbonmeld_rating's). Every code below comes with the page's own words. */ "doc_rating"?: { "method"?: "v3"; /** Methodology v3: rated, too_early (too early to rate), not_yet (not yet assessable), type_not_graded (no public grade of this type of project applies yet: analysed, no number), withheld (no rating shown at present: rating_note says why), v22 (a version 2.2 score kept) */ "state"?: "rated" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | "v22"; /** Why a page has no number (too_early / not_yet / withheld; null otherwise): early_or_inactive: «The project is at an early stage, or inactive: no credits have been issued, and the registry lists no validation or verification report.» · issued_no_report_read: «Credits have been issued, but no validation or verification report has been read yet.» · later_stage: «The project is past its early stage, but no validation or verification report is listed or has been read.» · no_registry_status: «No validation or verification report has been read, and the registry gives no status for the project.» · vv_file_stored_not_read: «A validation or verification report is stored but has not been read yet.» · vv_listed_not_stored: «The registry lists a validation or verification report that is not held here yet.» · hold (withheld): «The latest analysis of this project is held for review. While it is held, the page shows no rating.» · hold_active (withheld): «The latest analysis of this project is held for review. While it is held, the page shows no rating.» · audit_changed (withheld): «The project was analysed again after the rating rules were last applied to it. The page shows no rating until they are applied to the new analysis.» · v22_changed (withheld): «The project was analysed again after the rating rules were last applied to it. The page shows no rating until they are applied to the new analysis.» · off_shape (withheld): «The rating of this page did not pass CarbonMeld's checks before publication, so the page shows none.» · engine (withheld): «The rating of this page did not pass CarbonMeld's checks before publication, so the page shows none.» */ "reason"?: string | null; /** true: «Credits issued under this methodology cannot receive the CCP label (ICVCM, 15 Nov 2024).» */ "ccp_label_line"?: boolean; /** Each dimension's starting point and its public source */ "start"?: Array<{ "dim"?: "A" | "Q" | "P" | "C"; /** The source of the starting point: ccqi: «CCQI's score for this type of project» · icvcm: «the ICVCM's decision on this methodology» · eu_class: «the EU class of permanent carbon removals» · neutral: «neutral (5.0) — no public grade of this type of project applies» (on a type_not_graded page, neutral: «no public grade of this type of project applies») (on a rated page, on P with params.programme_not_graded true, neutral: «neutral (5.0) — CCQI does not grade this programme's approach to permanence») (with params.basis registry_label, any source but neutral: «the registry's CCP label on this project's credits») (eu_class with params.class_basis own_judgement: «our own judgement — the EU's class of permanent carbon removals does not name this type of project») */ "source"?: string; /** On a ccqi start: type_grade true «(CCQI does not list this methodology under this programme: the grade CCQI gives this type of project under the programme)» · graded_version (a string) «(CCQI grades version {version} of this methodology)» ({version}: params.graded_version) · by_programme true «(CCQI grades permanence by programme: this is its grade of the project's programme)» · programme_not_graded true «(CCQI does not grade this programme for this type of project: the CDM grade is used)» · borrowed true (older rows): as type_grade on A and Q, as by_programme on P · on an icvcm start without params.basis registry_label: conditions_shown true «(approved with conditions, and the documents read show every condition met)» · any other flag that is true, except cdm_criterion_1_2, graded_no_number, conditional_with_label and conditions_shown: «(a note on this source is not available on this page yet)» */ "params"?: { /** «(CCQI does not list this methodology under this programme: the grade CCQI gives this type of project under the programme)» */ "type_grade"?: boolean; /** «(CCQI grades version {version} of this methodology)» */ "graded_version"?: string; /** «(CCQI grades permanence by programme: this is its grade of the project's programme)» */ "by_programme"?: boolean; /** «(CCQI does not grade this programme for this type of project: the CDM grade is used)» */ "programme_not_graded"?: boolean; /** «(approved with conditions, and the documents read show every condition met)» */ "conditions_shown"?: boolean; [key: string]: unknown; }; [key: string]: unknown; }>; /** What was not counted, as the page words it */ "not_assessed"?: Array<{ /** a_route_not_matched: «Additionality: CCQI does not list this methodology under this programme, and its grades for this type of project there differ by methodology» · a_types_differ: «Additionality: the activity spans several of CCQI's types of project, and their grades differ» · additionality_test_not_stated: «The additionality test: not among the facts read» · baseline_type_not_read: «The baseline type: not among the facts read» · baseline_type_not_stated: «The baseline type: the documents read do not state it» · baseline_type_read_no_rule: «The baseline type: read, but no rule of the rating uses it» · buffer_not_stated: «The buffer share: the documents read do not state it» · buffer_stated_not_settled: «The buffer share: stated in a document read, but not settled by this analysis» · ccqi_no_type: «{dims}: CCQI's tool has no type of project for this activity» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · ccqi_programme_not_graded: «{dims}: CCQI does not grade this programme for this type of project, and the page's methodology is the programme's own, so no CDM grade stands in» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · ccqi_type_not_shown: «{dims}: the facts read do not show which of CCQI's types of project this activity is, so no CCQI grade applies» ({dims}: params.dims — A «Additionality», Q «Quantification», A and Q «Additionality and quantification») · commitment_group_document_not_matched (by params.reason): group_entry «The commitment period: this entry holds the group's shared documents and is not a project itself; the durations in them belong to the member projects»; several_durations «The commitment period: the group's shared document lists several durations, and this project's own row is not matched»; table_not_read «The commitment period: the duration table of the group's shared document could not be read, so this project's own row is not matched» · commitment_own_row_no_change: «The commitment period: this project's own row of the group's shared document gives a length from 60 to 99 years, where the rule changes nothing» · earlier_qualified_opinion: «An earlier verification opinion was qualified: only the latest opinion read counts» · end_use_not_tracked: «The tracking of the end use of the biochar: not among the facts read» · fact_not_asked: «{fact}: not asked in this analysis» ({fact}: params.fact — baseline_type «The baseline type», buffer_pct «The buffer share», fnrb «The fNRB value», fnrb_source «The source of the fNRB value», fuel_consumption_method «The fuel-consumption method», leakage_pct «The leakage deduction») · fact_not_determined: «{fact}: asked, but not determined from the documents read» ({fact}: params.fact — baseline_type «The baseline type», buffer_pct «The buffer share», fnrb «The fNRB value», fnrb_source «The source of the fNRB value», fuel_consumption_method «The fuel-consumption method», leakage_pct «The leakage deduction») · feedstock_not_addressed: «The sustainability of the feedstock: not among the facts read» · fnrb_mofuss_year_not_stated: «The fNRB value: it comes from MoFuSS, but the documents read do not state the year of the assessment, so the exemption for a MoFuSS assessment of 2024 or later does not apply and the value is compared with the official national value» · fnrb_not_stated: «The fNRB value: the documents read do not state it» · fnrb_source_not_stated: «The source of the fNRB value: the documents read do not state it» · fuel_method_read_no_rule: «The fuel-consumption method: read, but no rule of the rating uses it» · icvcm_not_applied (by params.reason): activity_not_covered «The ICVCM's decision: it covers other activities, not this project's activity»; activity_not_determinable «The ICVCM's decision: it covers one activity of this protocol only, and the documents read do not show this project's activity»; component_decision «The ICVCM's decision: it covers a component of this project, not its main methodology, so it does not grade the project»; conditions_not_shown «The ICVCM's decision: the ICVCM approved this methodology under conditions, and the documents read do not show them met»; mixed_components «The ICVCM's decision: the project combines methodologies with different ICVCM decisions»; not_decided «The ICVCM's decision: the ICVCM has not decided on this methodology»; programme_not_assessed «The ICVCM's decision: the ICVCM decided on this methodology only for other programmes, not for this project's programme»; under_assessment «The ICVCM's decision: the ICVCM is still assessing this methodology»; version_not_determinable «The ICVCM's decision: it depends on the methodology's version, and the documents read do not show which version applies»; version_not_on_the_list «The ICVCM's decision: this methodology version is not on the ICVCM's assessment list»; withdrawn_from_assessment «The ICVCM's decision: this version was withdrawn from the ICVCM's assessment by its programme, so the ICVCM has made no decision on it» · leakage_amount_computed_share: «The leakage deduction: stated as an amount, {amount_t} t CO2e ({share_pct}% of the reductions before leakage, computed from the same row of the document)» ({amount_t}: params.amount_t) ({share_pct}: params.share_pct) · leakage_not_addressed: «Leakage: not among the facts read» · leakage_not_stated: «The leakage deduction: the documents read do not state it» · leakage_secondary_effects: «The leakage deduction: this protocol calls it secondary effects» · no_usage_monitoring: «The usage rate of the devices: not among the facts read» · opinion_shown_not_scored: «The verification opinion read as {kinds}: shown, not counted, because this programme's own definition of it has not been sourced» ({kinds}: params.kinds — adverse «adverse», qualified «qualified») · permanence_claim_not_stated: «How long the carbon stays stored: not among the facts read» · q_methodology_not_listed: «Quantification: CCQI does not grade this methodology under this programme, so no public grade applies» · q_no_methodology_read: «Quantification: the documents read do not name the project's main methodology, so no CCQI grade of it applies» · q_types_differ: «Quantification: CCQI's grade of the methodology differs between the types of project the activity spans» · q_version_not_stated: «Quantification: the documents read name the methodology without its version, so CCQI's grade of a given version cannot be applied» · q_version_separated: «Quantification: CCQI grades version {version} of this methodology, and an ICVCM decision's version range separates this project's version from it» ({version}: params.version) · reversal_stated_not_scored: «A reversal or loss stated in the documents read: shown, not counted» · vintage_no_issuance_records: «The vintage: the registry records we hold show no issuance» · vintage_on_sale_safeguards_verifier: «The oldest vintage still on sale, the content of the safeguards and the verifier's quality: not among the facts read» · vintage_only_pending_units: «The vintage: no Woodland Carbon Units are issued yet, only Pending Issuance Units» · any other code: «An item that the rating does not count (its description is not available on this page yet)» */ "code"?: string; "params"?: { /** The page line of a code with a reason (see code) */ "reason"?: string; /** opinion_shown_not_scored's {kinds}: adverse «adverse», qualified «qualified» */ "kinds"?: Array; [key: string]: unknown; }; [key: string]: unknown; }>; /** The negative facts, as the page words them: registry_status (params.status): suspended «Registry status: suspended», rejected «Registry status: rejected», issuance_denied «Registry status: issuance denied», withdrawn «Registry status: withdrawn or not delivered», on_hold «Registry status: On Hold» · registry_review_open: «The registry opened a review of this project» · corrective_action_open: «The latest verification report read leaves a corrective action request open» · opinion (params.kind): adverse «The verification opinion read: adverse», qualified «The latest verification opinion read: qualified» · registry_remedy (params.kinds): «The registry's record shows:» + excess_status «credits issued in excess», credit_cancellation «credits cancelled», over_issuance «an over-issuance», replacement «credits replaced», project_cancellation «the project cancelled», rejection «a rejection», issuance_condition «a condition on further issuance» · document_fact (params.rule, the fact's values): A-LEGAL «The documents read state that the law requires the activity.», A-TEST-NOT-STATED «The documents read state no additionality test.», Q-LEAKAGE-NOT-ADDRESSED «The documents read do not address leakage.», Q-NO-USAGE-MONITORING «The documents read report no usage rate of the devices.», P-END-USE-NOT-TRACKED «The documents read state that nobody tracks the end use of the biochar.», P-STORAGE-TIME-NOT-STATED «The documents read do not state how long the carbon stays stored.», C-FEEDSTOCK-NOT-ADDRESSED «The documents read state that the project does not address the feedstock's sustainability.», Q-FNRB-OLD-DEFAULT «The fNRB value used ({fnrb}%) is an older CDM default value.», Q-FNRB-ABOVE «The fNRB value used ({fnrb}%) is more than 30% above the official value.», Q-FNRB-ABOVE-2X «The fNRB value used ({fnrb}%) is more than twice the official value.», P-BUFFER-LOW «The buffer share ({buffer}%) is under the programme's minimum ({minimum}%).», Q-LEAKAGE-ZERO «The documents state a leakage deduction of zero, under one of Verra's four older REDD+ methodologies (VM0006, VM0007, VM0009, VM0015). A published study of these projects found that taking no leakage deduction is likely to over-credit.» · any other code: «A negative fact that the rating counts (its description is not available on this page yet)» */ "negative"?: Array; /** A v22 page's missing facts: buffer_not_in_sheet «the buffer share (it is not among the facts read)» · fnrb_source_not_asked «the source of the fNRB value (it was not asked when this page was analysed)» · leakage_not_in_sheet «the leakage deduction (it is not among the facts read)» */ "missing"?: Array; [key: string]: unknown; } | null; /** Echoed when the sections argument was used */ "sections"?: Array<"summary" | "score" | "red_flags" | "documents" | "vintages" | "claims" | "buyers" | "market" | "methodology_history" | "page">; /** Only the language asked for (translations.); absent for en */ "translations"?: { [key: string]: unknown; }; /** The project's positions in the leaderboards; empty while they cannot be read or the project is ranked nowhere (a ranks failure never fails the record) */ "ranks"?: Array<{ [key: string]: unknown; }>; /** Present only where the registry's years in vintages are years of ISSUANCE, not vintages (the year the reductions or removals took place): CDM and BCarbon. Absent: the years are the registry's vintages. */ "vintage_basis"?: "issuance_year"; /** CDM only: each issuance of the project, from the UNEP CDM pipeline's copy of the registry's issuance list — its monitoring period, the day it was issued and its units; summed by the year of issue_date they give back vintages. A period that cannot be right is left out (period_start / period_end absent). */ "issuances"?: Array<{ /** The first day of the monitoring period (YYYY-MM-DD) */ "period_start"?: string; /** The last day of the monitoring period (YYYY-MM-DD) */ "period_end"?: string; /** The day the registry issued the credits (YYYY-MM-DD) */ "issue_date"?: string; /** Credits issued (CERs) */ "units": number; }>; /** A Gold Standard programme of activities only (absent on every other page): its VPAs, the units the registry issues its credits to. own_issuance false: the programme holds no credit records of its own and its page shows this box IN PLACE OF a vintage table (its credits are its VPAs'); true: it also holds credits of its own (both shown); null: not yet read under this rule (the page shows its vintage table, no box) */ "programme_units"?: { /** The day these figures were computed (YYYY-MM-DD) */ "as_of"?: string; /** The VPAs CarbonMeld holds a record of */ "units"?: Array<{ "code"?: string; /** The VPA's page id (get_project accepts it) */ "slug"?: string; "name"?: string; /** false: archived, no page to open */ "has_page"?: boolean; /** Credits the registry issued to this VPA */ "issued"?: number; "retired"?: number; /** Its monitoring reports we hold */ "mr_count"?: number; /** Its verification reports we hold */ "vr_count"?: number; /** Its reports we hold with no known date (then newest_report is null: its newest is not known) */ "undated"?: number; /** null when it has no report, or when one of its reports has no known date */ "newest_report"?: { "type"?: string; "date"?: string; /** Where the date comes from: facts (read in the report), triage, registry_list */ "date_source"?: string; } | null; [key: string]: unknown; }>; /** Records naming the programme (archived included) */ "units_total"?: number; /** Of them, those with a page */ "units_listed"?: number; /** Credits issued to the VPAs we hold (the sum of their own issuance) */ "issued_by_units"?: number; "retired_by_units"?: number; /** VPAs the registry lists that CarbonMeld holds no record of; null while the programme has not been read for them yet */ "untracked"?: { "units"?: number; "issued"?: number; "retired"?: number; } | null; "reports"?: { "mr"?: number; "vr"?: number; /** The newest report's date; null when none, or when a VPA's report has no known date */ "newest"?: string | null; /** Reports with no known date */ "undated"?: number; /** Where newest's date comes from: facts or triage (a report's own date — it wins a tie on the same day), registry_list (the day the registry's document list shows the report uploaded; the site says «listed»), null when newest is null */ "newest_source"?: string | null; }; /** true / false / null — see this field's description */ "own_issuance"?: boolean | null; [key: string]: unknown; }; /** What the project page says beyond the record, in the language asked for (GET /api/v1/projects//page): notices (the page's banners and notes as it prints them: archived, reassessment, registry_status, analysis_version, monitoring_period, standard_stated, cdm), basis («How this analysis was made»: standard, methodology, their rules, the method's version, the analysis' day, the documents it had), similar and same_project (the page's links), report (the PDF report's address; it opens for a signed-in Premium account on the site). Absent while it cannot be read (it never fails the record); each document with a page of its own carries page_url. */ "page"?: { [key: string]: unknown; }; /** 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. */ "quota"?: { /** Distinct premium projects per UTC day */ "limit": number; /** Distinct projects opened today that count */ "used_today": number; /** limit − used_today (never below 0) */ "left": number; }; [key: string]: unknown; }; } | { /** The id as asked */ "id": string; "ok": false; /** false on the daily project limit (retrying today will not help); true only when the id was NOT opened for the invocation's request limit — ask again for these ids (no quota was used) */ "retryable"?: boolean; /** Why this id gave no record (unknown id, daily project quota reached, the project being updated, the invocation's request limit, a temporary error) */ "error": string; }>; } /** 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. */ export interface CheckOfferInput { /** The offer text. Several projects: one lot per line (a project's code, its vintage, quantity and claims) */ "text": string; /** Overrides the text's vintage; used only when the text names one project */ "vintage"?: number; /** Overrides the text's quantity (t); used only when the text names one project */ "quantity"?: number; "seller"?: string; } export type CheckOfferOutput = { "parsed": { /** The registry codes found in the text */ "codes": Array; "vintages": Array; /** The explicit vintage argument, when it applied (one project named) */ "vintage"?: number; "quantity": number | null; "quantityNote": string; "claims": { "corsia": boolean | null; "ccp": boolean | null; "article6": boolean | null; "removal": boolean | null; }; "seller": string; /** Several projects named: each one's own vintage, quantity and claims */ "lots"?: Array<{ "code": string; "attributed": boolean; "vintages": Array; "quantity": number | null; "quantityNote": string; "claims": { "corsia": boolean | null; "ccp": boolean | null; "article6": boolean | null; "removal": boolean | null; }; }>; "lotNotes"?: Array; }; "projects": Array<{ "code": string; /** The CarbonMeld project id the code resolves to */ "id"?: string; "result": "checked" | "not_found" | "no_public_record" | "unavailable"; "name"?: string; "vintages_fetched_at"?: string | null; "claims_checked_at"?: string | null; /** On unavailable: a retryable non-verdict, never a negative finding */ "retryable"?: true; "checks": Array<{ "level": "ok" | "info" | "warn" | "bad"; "text": string; }>; }>; "note"?: string; } /** CORSIA registry labels by registry and phase, as CarbonMeld's page shows them: the snapshot's date, the totals (First Phase, available, Second Phase only, pilot only, pending), each registry's row (projects carrying a label, from the registries' own labels, by phase; the CCP-labelled First Phase ones; the average CarbonMeld rating of its First Phase projects, confirmed or recomputed on the current ratings, with its rated count) and the highest-rated First Phase projects, each rated from its current record, with the page's URL. Balances are unretired units of every vintage of those projects, not CORSIA-eligible units: a project-level label does not make every unit eligible. */ export interface CorsiaSupplyInput { /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; } export type CorsiaSupplyOutput = { "model": "corsia"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "updated_at"?: string; "totals"?: { [key: string]: unknown; }; "registries"?: unknown[]; "first_phase_top"?: number; "first_phase_projects"?: unknown[]; [key: string]: unknown; } /** An organisation named as beneficiary of carbon credit retirements (public registry retirement records), as its CarbonMeld page shows it: tonnes, retirements, projects and the months of the first and last retirement, the shares of its retired tonnes by project group (high / low rated, unrated, red flag, CCP, removal, CORSIA), its projects with the tonnes retired from each and each project's CarbonMeld rating from the project's current record (provisional while re-assessed) or its analysis state, and its latest retirements, with the page's URL. A retirement beneficiary is not necessarily the purchaser. Many projects come in pages (limit, offset; next_offset). An ambiguous name is an error listing the candidates. */ export interface GetBuyerInput { /** Company name or CarbonMeld buyer slug */ "name": string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; /** Project entries per page (default 25) */ "limit"?: number; /** Skip this many of its project entries (paging: use next_offset) */ "offset"?: number; } export type GetBuyerOutput = { "model": "buyer"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "slug"?: string; "name"?: string; "merged_from"?: unknown; "event"?: boolean; "tonnes"?: number; "retirements"?: number; "projects_count"?: number; /** The oldest and the newest UTC day (YYYY-MM-DD) its retirement records were read from the registries, as the page's «Retirement records as read from the registries on …» line gives them; null when a record has no read day (the page then shows no line) */ "records_read"?: { "first": string; "last": string; } | null; "quality"?: unknown[]; "projects"?: { [key: string]: unknown; }; "recent"?: unknown[]; [key: string]: unknown; } /** One methodology as its CarbonMeld page shows it, with the page's URL. The identity card gives the official title, the issuer, the current version, the status and the ICVCM CCP approvals. Each fact has its source and the day of the check. rules_v3 gives how methodology v3 reads projects of this type, as the page's rules box shows it, by section: same (the v2.2 rules that stay the same in v3, with their ids and text), changed (each changed rule as the v3 rule it became: v3_id, name, what, case, and replaces, the v2.2 ids) and v22_rules_url (the v2.2 rules as they were). A rule that v3 dropped is not in it. The answer also gives the version history, with what changed and the transitions, and the public videos. Its projects: a ranking of its v3-rated projects, with their count and average, when 5 or more are rated; else a list. */ export interface GetMethodologyInput { /** Methodology catalogue code, e.g. VM0048, ACM0002, AMS-II.G (case and spaces ignored) */ "code": string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; } export type GetMethodologyOutput = { "model": "methodology"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "code"?: string; "slug"?: string; "name"?: { [key: string]: unknown; }; "kind"?: string; "checked_on"?: string; "identity"?: { [key: string]: unknown; }; /** Null with methodology v3: the page shows rules_v3. */ "rules"?: { [key: string]: unknown; } | null; "history"?: { [key: string]: unknown; }; "videos"?: unknown[]; "projects"?: { [key: string]: unknown; }; "registries"?: unknown[]; /** How methodology v3 reads these projects, as the page's rules box shows it, by section: same (the v2.2 rules that stay the same in v3, with id and text), changed (v3_id, name, what, case, replaces) and v22_rules_url. A rule that v3 dropped is not listed. Null when the page has no rules box. */ "rules_v3"?: { [key: string]: unknown; } | null; [key: string]: unknown; } /** CarbonMeld's leaderboards as the site shows them. With a dimension only: its boards (sector, country, standard or methodology), each with the number of rated and listed projects, the average and the top rating. With a value too: that board — the projects ranked by CarbonMeld rating (at least 5 rated: the top 50, with the count and the average) or, for a methodology or a standard below that, the list of its projects — with the page's URL. Sector boards group projects by the sector they were rated under (scoring_sector in search_projects); a board ranks the rated projects whose registry status is past pipeline / validation (status ranked in search_projects). */ export interface GetRankingInput { "dimension": "sector" | "country" | "standard" | "methodology"; /** The board: a sector key (cookstoves), a country (Kenya, KE), a standard (VCS) or a methodology code (VM0048) */ "value"?: string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; } export type GetRankingOutput = { "model": "rankings"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "dimension"?: "sector" | "country" | "standard" | "methodology"; "ranking_threshold"?: number; "board_url"?: string; "boards"?: Array<{ [key: string]: unknown; }>; [key: string]: unknown; } | { "model": "ranking"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "dimension"?: "sector" | "country" | "standard" | "methodology"; "slug"?: string; "ranking_threshold"?: number; "kind"?: string; "label"?: string; "value"?: string; "ranked"?: number; "average_rating"?: number | null; "shown"?: number; "rows"?: Array<{ [key: string]: unknown; }>; [key: string]: unknown; } /** One carbon crediting standard (programme) as its CarbonMeld page shows it, with the page's URL. The identity card gives the name, the issuer, the official site and the ICVCM and CORSIA status. Each fact has its source and the day of the check. rules_v3 gives how methodology v3 reads projects of this standard, as the page's rules box shows it, by section: same (the v2.2 programme rules that stay the same in v3, with their ids and text), changed (each changed rule as the v3 rule it became: v3_id, name, what, case, and replaces, the v2.2 ids) and v22_rules_url (the v2.2 rules as they were). A rule that v3 dropped is not in it. The answer also gives the methodologies the standard issues and the ones its projects use. Its projects: a ranking of its v3-rated projects, with their count and average, when 5 or more are rated; else a list. A record that is no carbon crediting programme (I-REC, ISO 14064-2) says so. */ export interface GetStandardInput { /** Standard code, e.g. VCS, GS, CDM, ACR, CAR, PUR (case ignored) */ "code": string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; } export type GetStandardOutput = { "model": "standard"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "code"?: string; "value"?: string; "slug"?: string; "name"?: { [key: string]: unknown; }; "kind"?: string; "checked_on"?: string; "identity"?: { [key: string]: unknown; }; /** Null with methodology v3: the page shows rules_v3. */ "rules"?: { [key: string]: unknown; } | null; "history"?: { [key: string]: unknown; }; "videos"?: unknown[]; "projects"?: { [key: string]: unknown; }; "registries"?: unknown[]; /** How methodology v3 reads these projects, as the page's rules box shows it, by section: same (the v2.2 rules that stay the same in v3, with id and text), changed (v3_id, name, what, case, replaces) and v22_rules_url. A rule that v3 dropped is not listed. Null when the page has no rules box. */ "rules_v3"?: { [key: string]: unknown; } | null; [key: string]: unknown; } /** One project developer (an organisation) as its CarbonMeld page shows it: its name as the registries or the projects' documents give it, its numbers of projects, of projects with a methodology v3 rating and of projects with a registry status of rejected, withdrawn, terminated, suspended or issuance denied, its standards and countries, and its projects in the page's order (methodology v3 ratings first, best first; then v2.2 scores, best first; then the rest; ties by name) — each with registry code, country, registry status, its rating as the lists show it (a methodology v3 rating with its band, a v2.2 score labelled v2.2, or «Too early to rate» / «Not yet assessable» / «No public grade applies yet» / «Rating not shown»; marked provisional while re-assessed) or analysis state, and the project page's URL — with the developer page's URL. There is no company-level rating: each project is rated on its own evidence. Many projects come in pages (limit, offset; next_offset). An ambiguous name is an error listing the candidates. */ export interface GetDeveloperInput { /** The developer's name as CarbonMeld lists it (e.g. «South Pole») or its CarbonMeld slug */ "name": string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; /** Projects per page (default 25) */ "limit"?: number; /** Skip this many of its projects (paging: use next_offset) */ "offset"?: number; } export type GetDeveloperOutput = { "model": "developer"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "slug"?: string; "name"?: string; "source"?: string; "projects_count"?: number; "rated_count"?: number; "flagged_count"?: number; "standards"?: Array; "countries"?: Array; /** The page of projects (total, offset, shown, next_offset, rows) */ "projects"?: { [key: string]: unknown; }; [key: string]: unknown; } /** The ICVCM CCP tracker as CarbonMeld's page shows it: the Integrity Council's public methodology assessment-status table (its address and the day CarbonMeld fetched it), the number of assessments per status, and each assessment by category — programme, methodology and versions, status, Board Observations — with the number of THAT programme's projects CarbonMeld tracks under the same methodology code (every version of the methodology, so not a count of CCP-labelled credits; null when the programme or the code is not matched) and the methodology's leaderboard when one exists. A CCP label applies to credits issued under the approved methodology versions. Filters narrow the rows (never the counts per status): status, program (a programme's name or a standard code such as VCS, GS), methodology (a code such as ACM0002 or words of its name). */ export interface CcpTrackerInput { /** One ICVCM status */ "status"?: "approved" | "does_not_meet" | "remedial_action" | "unlikely_to_meet" | "withdrawn" | "under_assessment"; /** A crediting programme: part of its name (Gold Standard) or a standard code (GS, VCS) */ "program"?: string; /** A methodology code (ACM0002, AMS-I.E, VM0048) or words of its name */ "methodology"?: string; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; } export type CcpTrackerOutput = { "model": "ccp_tracker"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "source_url"?: string; "fetched_at"?: string; "rows_total"?: number; "approved_count"?: number; "statuses"?: Array<{ [key: string]: unknown; }>; "programs"?: { [key: string]: unknown; }; "filter"?: { [key: string]: unknown; } | null; "rows_matched"?: number; "categories"?: Array<{ [key: string]: unknown; }>; [key: string]: unknown; } /** The signed-in account's own portfolio (My portfolio on the site), as its page shows it: the projects the account saved for change alerts, each with its CarbonMeld rating as the lists show it (a methodology v3 rating with its band, a v2.2 score labelled v2.2, or «Too early to rate» / «Not yet assessable» / «No public grade applies yet» / «Rating not shown»; marked provisional while re-assessed), the analysis state, the registry status, the vintages, the number of listings and the analysis date. A project read under methodology v3 (rated, too early to rate, not yet assessable, or no public grade applies yet) gives its negative facts; a project that keeps its v2.2 score gives its red flags, labelled v2.2. The dimension values come only when every rated project is on the same methodology version. The answer also gives the average of the v3 ratings, two separate counts (the negative facts of the projects read under methodology v3 and the red flags of the v2.2-scored projects), the portfolio changes left this week, and the change alerts found for these projects in the last 30 days. Read only: it saves and removes nothing (that is done on the site). It takes no arguments and uses none of the daily project quota (saved projects are exempt; get_project on them is exempt too). */ export interface MyPortfolioInput extends Record {} export type MyPortfolioOutput = { "model": "portfolio"; "model_version": number; /** The portfolio page */ "url": string; /** The projects saved */ "projects_count": number; /** The most an account can save */ "max": number; /** The average CarbonMeld rating of the rated projects (one decimal); null when none is rated or a record could not be loaded */ "average_rating": number | null; /** Methodology v3: whose dimension values the rows give (v3's, Premium; or v2.2's); null when the projects mix versions */ "dimensions_version"?: "v3" | "v2.2" | null; /** Why no dimension values are given: the projects are rated under different methodology versions */ "dimensions_note"?: string; /** 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 */ "red_flags_total": number | null; /** 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 */ "negative_facts_total"?: number | null; /** Projects whose record could not be loaded now (their row says why) */ "unavailable_count": number; /** Portfolio changes (add or remove, on the site) left this ISO week */ "weekly_changes": { "left": number; "per_week": number; }; /** The saved projects, oldest first, as the portfolio page's rows */ "projects": Array<{ "id": string; "registry_code": string; "name": string | null; "url": string; "added_at": string | null; /** false: the record could not be loaded now (error says why); retry later */ "loaded": boolean; "error"?: string; /** The published CarbonMeld rating 0-10, or null (the page's score gate) */ "rating": number | null; /** The last published rating, kept while the project is re-assessed */ "provisional"?: true; "rating_note"?: string; /** CarbonMeld's method version of a provisional rating */ "methodology_version"?: string; /** 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 */ "dimension_scores": { "integrity"?: number | null; "transparency"?: number | null; "claim_safety"?: number | null; "documentation"?: number | null; "additionality"?: number | null; "quantification"?: number | null; "permanence"?: number | null; } | null; /** 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_state"?: "rated" | "v22" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | null; /** Methodology v3: the band of a v3 rating */ "rating_band"?: "high" | "moderate" | "low" | "very_low"; /** 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_count": number | null; "red_flags"?: Array; /** Methodology v3: the negative facts of a project read under v3 (the project page's lines) */ "negative_facts_count"?: number | null; /** Methodology v3: those negative facts, one line each, as the project page words them */ "negative_facts"?: Array; "analysis_status": string | null; /** The analysis state in the page's words */ "analysis": string | null; "not_carbon_credit"?: string; "registry_status": string | null; "registry_status_key"?: string; /** The issued vintages' span and the vintage note, as the page shows them */ "vintages": string | null; "listings_count": number; "analysis_date": string | null; /** The project is being re-published: no premium figures in this answer */ "updating"?: true; }>; /** 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 */ "recent_alerts": Array<{ "id": string; "name": string; "detected_at": string; "changes": Array; }> | null; /** 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. */ "quota"?: { /** Distinct premium projects per UTC day */ "limit": number; /** Distinct projects opened today that count */ "used_today": number; /** limit − used_today (never below 0) */ "left": number; }; "note"?: string; } /** The last 30 days of official rule-setter notices and registry label changes that CarbonMeld recorded: the notices (ICVCM, Verra, Gold Standard, SBTi and others: publisher, title, link, day) and the registry labels added to or removed from projects (project, standard, label, change, day, the project page's URL), with the count of projects per kind of label change over the whole window (the labels feed is a display window; the counts are complete). view picks a part (all, notices, labels); the labels — and the notices on view=notices — come in pages (limit, offset, next_offset). The snapshot's day is updated_at. */ export interface WhatChangedInput { /** all (default), notices or labels */ "view"?: "all" | "notices" | "labels"; /** Language of the project links (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; /** Rows per page (default 50) */ "limit"?: number; /** Skip this many rows (paging: use next_offset) */ "offset"?: number; } export type WhatChangedOutput = { "model": "claims_changes"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; "view"?: "all" | "notices" | "labels"; /** The snapshot's day */ "updated_at"?: string; /** The window the export covers (30 days) */ "window_days"?: number; "notices_total"?: number; "labels_total"?: number; /** Per kind of label change: how many projects and the latest day (the whole window) */ "label_changes"?: Array<{ [key: string]: unknown; }>; /** The official notices (total, offset, shown, next_offset, rows); null on view=labels */ "notices"?: { [key: string]: unknown; } | null; /** The label changes (total, offset, shown, next_offset, rows); null on view=notices */ "labels"?: { [key: string]: unknown; } | null; [key: string]: unknown; } /** CarbonMeld's rating method as its page /methodology/ shows it (the page's own text). The method is methodology v3, the document-based rating. Without arguments, the answer gives the page's sections (id, title, URL, the number of rule ids in each), the method's version, the four dimensions with their weights, overall (the rules on the rating itself) and the address of the archived v2.2 rules. With section (an id such as how-the-number-is-made, evidence-coverage, bands, start-rules, icvcm-decisions, no-number or stays-v2-2, or words of its title), it gives the section's text as the page shows it, the rule ids in it and one row for each rule card. With rule (an id such as A-START, Q-FNRB-ABOVE or C-VINTAGE-10, or the key of a card; case ignored), it gives the rule's card: its name, what it does, each effect, since when it applies, its source and the source's own words, and its address on the page. Each effect has a dimension, a kind (starting point, floor, cap, addition, deduction, or shown, not counted) and a figure. The start of ids (Q-FNRB) lists those rules. An id of methodology v2.2 (CM-…) gives that rule as v2.2 had it, with its address on the v2.2 page and its place in v3: the same, changed (with the v3 rule it became) or dropped. in_force is true only for a rule that is the same in v3. With dimension (additionality, quantification, permanence, claim_safety, or overall), it gives the rules that act on it, in pages (limit, offset; next_offset). Methodology v3 has no criteria. Ask one of section, rule or dimension at a time. */ export interface GetMethodInput { /** A section of /methodology/: its id (how-the-number-is-made, bands, start-rules, no-number) or words of its title */ "section"?: string; /** 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 */ "rule"?: string; /** Methodology v2.2 only: methodology v3 has no criteria (ask a dimension) */ "criterion"?: string; /** A dimension of the rating; overall = the rules on the rating itself */ "dimension"?: "additionality" | "quantification" | "permanence" | "claim_safety" | "overall"; /** Language of the page (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; /** Rules per page for a dimension or the start of ids (default 25) */ "limit"?: number; /** Skip this many rules (paging: use next_offset) */ "offset"?: number; } export type GetMethodOutput = { "model": "method"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; /** index (no argument), section, rule, or rules (a dimension or the start of ids) */ "kind"?: "index" | "section" | "rule" | "rules"; /** The version of CarbonMeld's rating method the page describes (3) */ "method_version"?: string | null; /** The day the page's rules last changed (YYYY-MM-DD) */ "rules_last_change"?: string | null; /** index: the page's blocks and sections, in its order */ "sections"?: Array<{ [key: string]: unknown; }>; /** index: empty — the page's Versions section says the versions in words */ "version_log"?: Array<{ [key: string]: unknown; }>; /** index: the four dimensions with their weights, and overall (no weight) */ "dimensions"?: Array<{ [key: string]: unknown; }>; /** index: empty — methodology v3 has no criteria */ "criteria"?: Array<{ [key: string]: unknown; }>; "rule_counts"?: { [key: string]: unknown; }; /** section: its text as the page shows it, its rule ids and one row for each rule card */ "section"?: { [key: string]: unknown; }; /** rule: the rule's card as the page shows it (in_force true, methodology_version v3), or a v2.2 rule (methodology_version v2.2, its address on the v2.2 page, its place in v3; in_force true only when it is the same in v3) */ "rule"?: { [key: string]: unknown; }; "criterion"?: { [key: string]: unknown; }; "dimension"?: { [key: string]: unknown; }; /** rules: the start of ids asked */ "prefix"?: string; /** dimension: the page's rule cards and gate rows its dimension filter shows */ "page_entries"?: Array<{ [key: string]: unknown; }>; "total"?: number; /** rules: how many of them /methodology/ shows */ "on_page"?: number; "offset"?: number; "shown"?: number; /** Pass as offset for the next rules; absent when no more remain */ "next_offset"?: number; "rules"?: Array<{ [key: string]: unknown; }>; /** The archived v2.2 rules: their version and the page's address */ "archived"?: { [key: string]: unknown; }; [key: string]: unknown; } /** Search CarbonMeld's articles in English, Chinese or Japanese, as the site's article index lists them: by words (each must appear in the title, the summary or a tag), by tag (the articles of the site's page for that tag) and by date (from, to). Returns the total number of matches and one page of them, newest first or oldest first (limit, offset; next_offset): each article's title, date, summary, tags, category and URL. No match is an empty list, not an error. */ export interface SearchArticlesInput { /** Words that must all appear in the article's title, summary or tags (e.g. «CORSIA», «cookstove») */ "query"?: string; /** A tag, as the site names it or as its page's slug (e.g. «carbon removal», «carbon-removal») */ "tag"?: string; /** First day, YYYY-MM-DD (included) */ "from"?: string; /** Last day, YYYY-MM-DD (included) */ "to"?: string; /** newest (default) or oldest first */ "sort"?: "newest" | "oldest"; /** Language of the articles (en, zh, ja); default en */ "lang"?: "en" | "zh" | "ja"; /** Articles per page (default 10) */ "limit"?: number; /** Skip this many matches (paging: use next_offset) */ "offset"?: number; } export type SearchArticlesOutput = { "model": "articles"; "model_version"?: number; "lang"?: "en" | "zh" | "ja"; /** The page's URL */ "url"?: string; /** Every article of the language */ "articles_in_language"?: number; /** The question as read: words, tag (its page), from, to, sort */ "filter"?: { [key: string]: unknown; }; /** Every match (results is one page of them) */ "total"?: number; "offset"?: number; "shown"?: number; /** Pass as offset for the next page; absent when no more remain */ "next_offset"?: number; "results"?: Array<{ "title": string; /** YYYY-MM-DD */ "date": string; "summary": string; "tags": Array; "category": string | null; /** The article's URL */ "url": string; }>; [key: string]: unknown; } /** The MCP tools as a typed API (Code Mode): call them as `carbonmeld.search_projects({...})`. */ export interface CarbonMeldMcp { search_projects(input: SearchProjectsInput): Promise; get_project(input: GetProjectInput): Promise; get_projects(input: GetProjectsInput): Promise; check_offer(input: CheckOfferInput): Promise; corsia_supply(input: CorsiaSupplyInput): Promise; get_buyer(input: GetBuyerInput): Promise; get_methodology(input: GetMethodologyInput): Promise; get_ranking(input: GetRankingInput): Promise; get_standard(input: GetStandardInput): Promise; get_developer(input: GetDeveloperInput): Promise; ccp_tracker(input: CcpTrackerInput): Promise; my_portfolio(input: MyPortfolioInput): Promise; what_changed(input: WhatChangedInput): Promise; get_method(input: GetMethodInput): Promise; search_articles(input: SearchArticlesInput): Promise; } // ── REST API v1 (OpenAPI 3.1: https://carbonmeld.com/api/v1/openapi.json) ────────────────────────────── export type Error = { "error": string; } export type Quota = { /** Distinct premium projects per UTC day. */ "limit": number; /** Distinct projects opened today that count. */ "used_today": number; /** limit − used_today (never below 0). */ "left": number; } export type Project = { "quota"?: Quota; [key: string]: unknown; } export type ProjectList = { "updated_at"?: string; "total"?: number; "limit"?: number; "offset"?: number; "projects"?: Array; } export type GetStatsResponse = { [key: string]: unknown; } export interface ListProjectsParams { /** Standard code, e.g. VCS (case-insensitive). An unknown value → 400 with the valid ones. */ "registry"?: string; /** Minimum rating; when given, unscored projects are left out. */ "min_score"?: number; /** Words that must all appear in the project's name, registry code, country, methodology or sector. */ "q"?: string; /** ISO 3166-1 alpha-2 code (e.g. KE) or a country name (e.g. Kenya). An unknown value → 400. */ "country"?: string; /** Methodology catalogue code (e.g. VM0048), case and spaces ignored. An unknown value → 400. */ "methodology"?: string; /** Project type. An unknown value → 400. */ "sector"?: "arr" | "biochar" | "biogas" | "biomass" | "blue_carbon" | "cookstoves" | "dac" | "industrial" | "industrial_gases" | "methane" | "other" | "redd" | "renewable_energy" | "soil_carbon" | "water"; "limit"?: number; "offset"?: number; } export type ListProjectsResponse = ProjectList export interface GetProjectParams { "id": string; } export type GetProjectResponse = Project export type GetProjectsBatchBody = { /** 1 to 10 registry codes, slugs or aliases */ "ids": Array; } export type GetProjectsBatchResponse = { "total": number; "found": number; "quota"?: Quota; "results": Array<{ "id": string; "status": number; "project"?: Project; "error"?: string; }>; } export interface GetMethodologyParams { /** Catalogue code, e.g. VM0048, AMS-II.G */ "code": string; "lang"?: "en" | "zh" | "ja"; } export type GetMethodologyResponse = { [key: string]: unknown; } export interface ListRankingsParams { "dimension": "sector" | "country" | "standard" | "methodology"; "lang"?: "en" | "zh" | "ja"; } export type ListRankingsResponse = { [key: string]: unknown; } export interface GetRankingParams { "dimension": "sector" | "country" | "standard" | "methodology"; "value": string; "lang"?: "en" | "zh" | "ja"; } export type GetRankingResponse = { [key: string]: unknown; } export interface GetStandardParams { /** Standard code, e.g. VCS, GS */ "code": string; "lang"?: "en" | "zh" | "ja"; } export type GetStandardResponse = { [key: string]: unknown; } export interface GetDeveloperParams { /** The developer's slug, as in https://carbonmeld.com/developers// */ "slug": string; "lang"?: "en" | "zh" | "ja"; /** Skip this many of its projects (the page's order) */ "offset"?: number; /** At most this many projects (default: all of them) */ "limit"?: number; } export type GetDeveloperResponse = { [key: string]: unknown; } export interface GetCcpTrackerParams { "lang"?: "en" | "zh" | "ja"; "status"?: "approved" | "does_not_meet" | "remedial_action" | "unlikely_to_meet" | "withdrawn" | "under_assessment"; /** A programme's name (part of it) or a standard code, e.g. VCS, GS */ "program"?: string; /** A methodology code (ACM0002, AMS-I.E) or words of its name */ "methodology"?: string; } export type GetCcpTrackerResponse = { [key: string]: unknown; } export interface GetBuyerParams { /** The buyer's slug, as in https://carbonmeld.com/buyers// */ "slug": string; "lang"?: "en" | "zh" | "ja"; /** Skip this many of its project entries */ "offset"?: number; /** At most this many project entries (default: all of them) */ "limit"?: number; } export type GetBuyerResponse = { [key: string]: unknown; } export interface GetCorsiaParams { "lang"?: "en" | "zh" | "ja"; } export type GetCorsiaResponse = { [key: string]: unknown; } export interface GetClaimsChangesParams { "view"?: "all" | "notices" | "labels"; /** Language of the project links */ "lang"?: "en" | "zh" | "ja"; /** Skip this many rows */ "offset"?: number; /** At most this many rows (default: 50) */ "limit"?: number; } export type GetClaimsChangesResponse = { [key: string]: unknown; } export interface GetProjectRanksParams { "id": string; "lang"?: "en" | "zh" | "ja"; } export type GetProjectRanksResponse = { [key: string]: unknown; } export interface GetProjectPageParams { "id": string; "lang"?: "en" | "zh" | "ja"; } export type GetProjectPageResponse = { [key: string]: unknown; } export type McpBody = { "jsonrpc": "2.0"; "id"?: unknown; "method": string; "params"?: { [key: string]: unknown; }; } export type McpResponse = { [key: string]: unknown; } export interface GetMethodParams { "lang"?: "en" | "zh" | "ja"; /** A section of /methodology/: its id (how-the-number-is-made, bands, start-rules, no-number) or words of its title */ "section"?: string; /** 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 */ "rule"?: string; /** Methodology v2.2 only: methodology v3 has no criteria (ask a dimension) */ "criterion"?: string; "dimension"?: "additionality" | "quantification" | "permanence" | "claim_safety" | "overall"; /** Skip this many rules (criterion, dimension, start of ids) */ "offset"?: number; "limit"?: number; } export type GetMethodResponse = { [key: string]: unknown; } export interface SearchArticlesParams { "lang"?: "en" | "zh" | "ja"; /** Words that must all appear in the title, the summary or a tag */ "query"?: string; /** A tag or its page's slug */ "tag"?: string; /** First day (included) */ "from"?: string; /** Last day (included) */ "to"?: string; "sort"?: "newest" | "oldest"; "offset"?: number; "limit"?: number; } export type SearchArticlesResponse = { [key: string]: unknown; } export type GetPortfolioResponse = { "model": "portfolio"; "model_version": number; /** The portfolio page */ "url": string; /** The projects saved */ "projects_count": number; /** The most an account can save */ "max": number; /** The average CarbonMeld rating of the rated projects (one decimal); null when none is rated or a record could not be loaded */ "average_rating": number | null; /** Methodology v3: whose dimension values the rows give (v3's, Premium; or v2.2's); null when the projects mix versions */ "dimensions_version"?: "v3" | "v2.2" | null; /** Why no dimension values are given: the projects are rated under different methodology versions */ "dimensions_note"?: string; /** 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 */ "red_flags_total": number | null; /** 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 */ "negative_facts_total"?: number | null; /** Projects whose record could not be loaded now (their row says why) */ "unavailable_count": number; /** Portfolio changes (add or remove, on the site) left this ISO week */ "weekly_changes": { "left": number; "per_week": number; }; /** The saved projects, oldest first, as the portfolio page's rows */ "projects": Array<{ "id": string; "registry_code": string; "name": string | null; "url": string; "added_at": string | null; /** false: the record could not be loaded now (error says why); retry later */ "loaded": boolean; "error"?: string; /** The published CarbonMeld rating 0-10, or null (the page's score gate) */ "rating": number | null; /** The last published rating, kept while the project is re-assessed */ "provisional"?: true; "rating_note"?: string; /** CarbonMeld's method version of a provisional rating */ "methodology_version"?: string; /** 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 */ "dimension_scores": { "integrity"?: number | null; "transparency"?: number | null; "claim_safety"?: number | null; "documentation"?: number | null; "additionality"?: number | null; "quantification"?: number | null; "permanence"?: number | null; } | null; /** 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_state"?: "rated" | "v22" | "too_early" | "not_yet" | "type_not_graded" | "withheld" | null; /** Methodology v3: the band of a v3 rating */ "rating_band"?: "high" | "moderate" | "low" | "very_low"; /** 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_count": number | null; "red_flags"?: Array; /** Methodology v3: the negative facts of a project read under v3 (the project page's lines) */ "negative_facts_count"?: number | null; /** Methodology v3: those negative facts, one line each, as the project page words them */ "negative_facts"?: Array; "analysis_status": string | null; /** The analysis state in the page's words */ "analysis": string | null; "not_carbon_credit"?: string; "registry_status": string | null; "registry_status_key"?: string; /** The issued vintages' span and the vintage note, as the page shows them */ "vintages": string | null; "listings_count": number; "analysis_date": string | null; /** The project is being re-published: no premium figures in this answer */ "updating"?: true; }>; /** 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 */ "recent_alerts": Array<{ "id": string; "name": string; "detected_at": string; "changes": Array; }> | null; /** 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. */ "quota"?: { /** Distinct premium projects per UTC day */ "limit": number; /** Distinct projects opened today that count */ "used_today": number; /** limit − used_today (never below 0) */ "left": number; }; "note"?: string; } export type CheckOfferBody = { /** The offer text. Several projects: one lot per line (a project's code, its vintage, quantity and claims) */ "text": string; /** Overrides the text's vintage; used only when the text names one project */ "vintage"?: number; /** Overrides the text's quantity (t); used only when the text names one project */ "quantity"?: number; "seller"?: string; } export type CheckOfferResponse = { "parsed": { /** The registry codes found in the text */ "codes": Array; "vintages": Array; /** The explicit vintage argument, when it applied (one project named) */ "vintage"?: number; "quantity": number | null; "quantityNote": string; "claims": { "corsia": boolean | null; "ccp": boolean | null; "article6": boolean | null; "removal": boolean | null; }; "seller": string; /** Several projects named: each one's own vintage, quantity and claims */ "lots"?: Array<{ "code": string; "attributed": boolean; "vintages": Array; "quantity": number | null; "quantityNote": string; "claims": { "corsia": boolean | null; "ccp": boolean | null; "article6": boolean | null; "removal": boolean | null; }; }>; "lotNotes"?: Array; }; "projects": Array<{ "code": string; /** The CarbonMeld project id the code resolves to */ "id"?: string; "result": "checked" | "not_found" | "no_public_record" | "unavailable"; "name"?: string; "vintages_fetched_at"?: string | null; "claims_checked_at"?: string | null; /** On unavailable: a retryable non-verdict, never a negative finding */ "retryable"?: true; "checks": Array<{ "level": "ok" | "info" | "warn" | "bad"; "text": string; }>; }>; "note"?: string; } /** The REST API (https://carbonmeld.com/api/v1) as typed calls — Bearer key or OAuth access token. */ export interface CarbonMeldRest { getStats(): Promise; listProjects(params?: ListProjectsParams): Promise; getProject(params: GetProjectParams): Promise; getProjectsBatch(body: GetProjectsBatchBody): Promise; getMethodology(params: GetMethodologyParams): Promise; listRankings(params: ListRankingsParams): Promise; getRanking(params: GetRankingParams): Promise; getStandard(params: GetStandardParams): Promise; getDeveloper(params: GetDeveloperParams): Promise; getCcpTracker(params?: GetCcpTrackerParams): Promise; getBuyer(params: GetBuyerParams): Promise; getCorsia(params?: GetCorsiaParams): Promise; getClaimsChanges(params?: GetClaimsChangesParams): Promise; getProjectRanks(params: GetProjectRanksParams): Promise; getProjectPage(params: GetProjectPageParams): Promise; mcp(body: McpBody): Promise; getMethod(params?: GetMethodParams): Promise; searchArticles(params?: SearchArticlesParams): Promise; getPortfolio(): Promise; checkOffer(body: CheckOfferBody): Promise; }