Homepage

Registry

Isometric API Docs

Support

List of credit batches for a given retirement.

Retirement Credit Batches

Counterfactuals Kg

Emissions Kg

Gross Carbon Removed Kg

Losses Kg

Net Carbon Removed Kg

CarbonRemovalData

Carbon removal data for this credit batch

Country Of Issue

Issuance Id

Issued At

If this credit batch has status `SPLIT`, it will have two child batches representing the two halves of this split.

Left Child Id

If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.

Parent Id

Project Id

Removal Id

The location of the facility where this carbon removal took place, if available

Retired At

Retirement Id

Right Child Id

Sequestered On

Serial Number

Supplier Id

CreditBatch

CreditBatchStatus

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

Credit Kgs

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

Credits

CreditQuantity

Country Code

Country Name

Location

Domain

Name

Organisation

Message

Error Type

ValidationError

HTTPBearer

ListResource[CreditBatch]

HTTPValidationError

Introduction

Standards

Authentication

Key Registry Concepts

Issuance

A paginated list of all issuances in Isometric's registry.

Returned list of issuances will be sorted by most recently issued first.

Issuances

List of credit batches for a given issuance.

Credit batches are divided between those allocated to the buffer pool and those allocated to the supplier. Note these are the original batches in the issuance, so some credit batches might be in status SPLIT if they had to be split for a delivery/transfer/retirement.

Issuance Credit Batches

List of issuances for a given supplier.

Issuances are sorted by most recently created first.

Issuances by Supplier

Delivery

A paginated list of all deliveries on Isometric's registry.

Returned list of projects will be sorted by most recently delivered first.

Deliveries

List of credit batches for a given delivery.

Note these are the original batches in the delivery, so some credit batches might be in status SPLIT if they had to be split for a transfer/retirement.

Delivery Credit Batches

List of deliveries for a given supplier.

Deliveries are sorted by most recently delivered first.

Deliveries by Supplier

Retirement

A paginated list of all retirements on Isometric's registry.

Returned list of retirements will be sorted by most recently delivered first.

Retirements

Transfer

List of credit batches in a given transfer.

Transfer Credit Batches

The organisation currently authenticated.

Use this endpoint to get your organisation_id.

Supplier

Suppliers

Project

A paginated list of all projects on Isometric's registry.

Returned list of projects will be sorted alphabetically by project name.

Projects

A paginated list of all project documents for the given project.

Returned list of documents will be sorted alphabetically by document name.

Project Documents

List of projects for a given supplier.

Projects are sorted by most recently created first.

Projects by Supplier

Current Organisation

Information about active and retired credits owned by the given organisation.

Includes total balances as well as balances split by projects and suppliers.

Organisation Credit Balance

A paginated list of all credit batches currently owned or retired on behalf of the organisation, sorted by issuance date. By default it excludes batches with the status 'split'.

Note that when combining filters, the result will be the intersection of them. For example, when filtering by `supplier_id` and `issued_after`, the result will only include credit batches from the specified supplier that have been issued after the specified date.

Organisation Credit Batches

Order

A paginated list of all orders placed by the organisation, sorted by descending placement date.

Organisation Orders

List of deliveries for a given order.

Deliveries are sorted by most recently delivered first.

Deliveries by Order

A paginated list of Organisations which the currently authenticated organisation can retire credits on the behalf of, using the `POST /retirements` endpoint.

Beneficiaries

Create a new beneficiary for your organisation to retire on behalf of.

Create Beneficiary

Retire credits from specific batches, in whole or with splits. All credit batches must originate from the same supplier and be owned by the current organisation.

Create Retirement

Retire oldest available credits from a given supplier. If vintage is specified, this will retire the oldest credits from that vintage only.

Create Retirement From Oldest Credits

A paginated list of Organisations which the currently authenticated organisation can transfer active credits to, using the `POST /transfers` endpoint.

Transferees

Transfer credits from specific batches, in whole or with splits. All credit batches must originate from the same supplier and be owned by the current organisation.

Create Transfer

The supplier currently authenticated.

Use this endpoint to get your supplier_id and organisation_id.

Current Supplier

List of orders for a given supplier.

Orders are sorted by most recently placed first.

Supplier Orders

Create Delivery

Key MRV Concepts

Creating your first removal

Get Sources

Get Source

Returns a short-lived signed URL for a source's private URL. This query will fail if
the source does not have a private URL or if the authenticated user does not have
access to it. That's why you need to first check the urlInfo field on the source
object, to ensure that you can safely use this query.

Source Private Url

Recreates a presigned upload URL, which must be used to upload the documentation
associated with this source. If the document is already uploaded, this endpoint will
response with a 409 error.

Post Signed Upload Url

Creates a source in the Isometric system. The client is provided with a presigned
upload URL which must be used to upload the document associated with this source.
Source documents are private, but other fields will be visible publicly once
credits are issued for an associated removal, moving it to the public registry.

Post Source

Patches metadata associated with a source in the Isometric system.

Patch Source

Deletes a source in the Isometric system. This is irreversible and the source cannot be recovered.

Delete Source

Get Datapoints

Returns a single datapoint in the Isometric system

Get Datapoint

Creates a datapoint in the Isometric system

Post Datapoint

Updates a datapoint in the Isometric system. Associated components and removals will be recalculated, if they are not in an immutable state.

Patch Datapoint

Delete a datapoint resource. Will fail if the datapoint is in use by a component.

Delete Datapoint

Lists component blueprints in the Isometric system

Component Blueprints

Get Components

Get a single component in the Isometric system

Get Component

Creates a component in the Isometric system

Post Component

Creates a component in the Isometric system. Associated removals will be recalculated, if they are not in an immutable state.

Patch Component

Delete a component resource. Will fail if the component is in use by a removal.

Delete Component

Get Removals

Get Removal

Post Removal

Updates a removal in the Isometric system. The removal will be recalculated, if it is are not in an immutable state.

Patch Removal

This endpoint deletes a removal - this is irreversible and the removal cannot be recovered.

It will return an error if the removal is not in DRAFT status.

Public Registry Data

Buyer Account Management

Supplier Account Management

Retirement Credit Batches

Authorizations

Headers

Path Parameters

Response