For the complete documentation index, see llms.txt. This page is also available as Markdown.

Carbon Credit

API of Carbon Credit projects: registering a project, updating one, listing your projects, viewing a project in full, and looking up the methodologies available for linking to a project.

Authorization. Every call carries the hash parameter with your API key.

Answers. The endpoints answer with the {message, success, data, operations_count} envelope; a refused call answers HTTP 400 with success: false.

Registry and Methodology. A project is linked to a methodology of the Methodology | Protocol section. Two ways: methodology_id, or methodology_registry, name_of_methodology and d_mrv_types together — all three are required in that case. An existing methodology with that name and version is linked; otherwise it is created. methodology_registry alone is refused here.

methodology_id comes from D-MRV Methodologies or Get Methodologies List; nothing else about the methodology is needed then. When a new methodology is created, the registry name is stamped on the new record so it appears as a Registry option afterwards. An existing methodology is linked by methodology_id only — a registry name is accepted to create a new methodology, never to select an existing one. Update Project follows the same rule.

A registry or methodology that cannot be resolved, or one your account may not use, refuses the request: the project is not stored, and the reason arrives in data.errors.d_mrv_id.

Blocks of rows. A block is one field, an array of objects. A block the request carries replaces the stored block whole; a block the request does not mention is left as it is; an empty array clears it. Contact blocks take up to 20 rows; link blocks, the Data Room rows and the allocation take up to 100. A company named in the allocation that does not exist yet is created.

Documents. Documents travel as rows of data_room (and, on Carbon Credit, reference_files / environmental_product_documents); links travel in the link blocks.

Endpoints

Endpoint
What it does

Registers a carbon credit project, and links or creates its Registry and Methodology.

Changes any field of a project, including its contact and document blocks.

Lists your projects as a summary.

Returns one project in full.

Lists the methodologies offered for linking — name, version, id and registry — the same set the Carbon Credit form offers.

Last updated