Credit actions

All available credit actions.

Get inventory for an entity

GEThttps://api.carbonregistry.com/v1/{id}/inventory

Authorization

bearer

Path parameters

id*string

Entity ID

Response

200

Body

application/json

credits*array of ApiInventoryCreditDto (object)

entity*BaseEntityDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/{id}/inventory', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "credits": [
    {
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "exPost-2-0x1234567890abcdef",
      "tokenId": "abcdef",
      "tokenAddress": "0x1234567890abcdef",
      "project": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "fullName": "Project 1",
        "url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
        "num": "713"
      },
      "serialization": "ICR-ISL-354-78040-14-R-0-2021",
      "vintage": "2020",
      "supply": 1000,
      "unit": "tonne",
      "amount": 100,
      "type": "exAnte"
    }
  ],
  "entity": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Transfer credits

For transferring credits this is THE endpoint to use. You can transfer credits from an organization, user or subaccount.

POSThttps://api.carbonregistry.com/v1/transfer

Authorization

bearer

Body

application/json

to*all of

  The receiver's information. 
  
  If the entity Id is supplied (user / org / subaccount) then the credits are sent to the corresponding account for that id. 
  
  If you want to deliver the credits to some address on Polygon you can use the publicKey address and leave the id undefined. 
  
  Finally if you are unsure if the receiver of the credits own's a carbonregistry.com account you can pass in the receiver's email, the credits will be sent to an escrow account that stores the credits until the owner of the email signs in and claims the credits.

fromId*string

The entity that holds the credits - if not a subaccountId the default subaccount will be used.

Example: "123e4567-e89b-12d3-a456-426614174000"

credits*array of TransferCredit (object)

The credits to transfer

commentstring

An optional transaction comment

Example: "Transfer 2024"

receiptEmailsarray of EmailDto (object)

An optional list of emails to send the transaction receipt to

Response

200

Body

application/json

transactionId*string

The transaction id

Example: "123e4567-e89b-12d3-a456-426614174000"

success*boolean

Whether the transaction was successful or not

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/transfer', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to": {},
      "fromId": "123e4567-e89b-12d3-a456-426614174000",
      "credits": [
        {
          "id": "exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
          "amount": "0.7"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "success": true
}

Retire credits

For retiring credits this is THE endpoint to use. You can retire credits from an organization, user or subaccount.

POSThttps://api.carbonregistry.com/v1/retire

Authorization

bearer

Body

application/json

toall of

The receiver information

fromId*string

The entity that holds the credits

Example: "123e4567-e89b-12d3-a456-426614174000"

reason*string

The reason for retirement. This reason comes from a specified picklist.

Example: "Corsia"

beneficiaryName*string

The beneficiary for the retirement

Example: "Beff Jezos"

comment*string

A retirement comment

Example: "Retiring for flights 24'"

credit*all of

The credits to transfer

receiptEmailsarray of EmailDto (object)

An optional list of emails to send the transaction receipt to

Response

200

Body

application/json

success*boolean

Whether the transaction was successful or not

Example: "123e4567-e89b-12d3-a456-426614174000"

transactionId*string

The id of the possibly pending transaction

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/v1/retire', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromId": "123e4567-e89b-12d3-a456-426614174000",
      "reason": "Corsia",
      "beneficiaryName": "Beff Jezos",
      "comment": "Retiring for flights 24'",
      "credit": {
        "id": "exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
        "amount": "0.7"
      }
    }),
});
const data = await response.json();

Response

200

{
  "success": "123e4567-e89b-12d3-a456-426614174000",
  "transactionId": true
}

reason: Must be one of the following predefined options:

• Compliance

• Corsia

• Voluntary purposes

• Overall mitigations of global emissions

• Corporate emission compensation

• Other

• Article 6.2

• Testing