Homepage

Registry

Isometric API Docs

Support

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

Credit Batch Id

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

Credit Quantity Kg

CreditBatchQuantity

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

Domain

Name

Organisation

Location

Message

Error Type

ValidationError

CreateTransferRequest

HTTPBearer

Transfer

HTTPValidationError

Introduction

Standards

Authentication

Key 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

List of credit batches for a given retirement.

Retirement Credit Batches

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

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.

Getting started

Public Registry Data

Buyer Account Management

Supplier Account Management

Create Transfer

Authorizations

Headers

Body

Response