Credit actions

All available credit actions.

Get inventory for an entity

get

/v1/{id}/inventory

Authorizations

Path parameters

idstringrequired

Entity ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.carbonregistry.com/v1/{id}/inventory' \
  --header 'Authorization: Bearer <token>'

200

200

{
  "entity": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "credits": [
    {
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "exPost-2-0x1234567890abcdef",
      "tokenId": "abcdef",
      "tokenAddress": "0x1234567890abcdef",
      "serialization": "ICR-ISL-354-78040-14-R-0-2021",
      "vintage": "2020",
      "supply": 1000,
      "unit": "tonne",
      "amount": 100,
      "type": "exAnte",
      "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"
      }
    }
  ]
}

Transfer credits

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

post

/v1/transfer

Authorizations

Body

fromIdstringrequired

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

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

commentstring

An optional transaction comment

Example: Transfer 2024

creditsobject[]required

The credits to transfer

receiptEmailsobject[]

An optional list of emails to send the transaction receipt to

Example: ["[e-mail]"]

toall ofrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/v1/transfer' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"fromId":"123e4567-e89b-12d3-a456-426614174000","comment":"Transfer 2024","credits":[{"id":"exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e","amount":"0.7"}],"receiptEmails":["[e-mail]"],"to":{"publicKey":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","email":"[e-mail]","id":"123e4567-e89b-12d3-a456-426614174000"}}'

200

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.

post

/v1/retire

Authorizations

Body

fromIdstringrequired

The entity that holds the credits

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

reasonstringrequired

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

Example: Corsia

beneficiaryNamestringrequired

The beneficiary for the retirement

Example: Beff Jezos

commentstringrequired

A retirement comment

Example: Retiring for flights 24'

receiptEmailsobject[]

An optional list of emails to send the transaction receipt to

toall of

The receiver information

creditall ofrequired

The credits to transfer

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/v1/retire' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"fromId":"123e4567-e89b-12d3-a456-426614174000","reason":"Corsia","beneficiaryName":"Beff Jezos","comment":"Retiring for flights 24'","receiptEmails":[{"email":"[e-mail]"}],"to":{"email":"[e-mail]","id":"123e4567-e89b-12d3-a456-426614174000"},"credit":{"id":"exPost-1-0x742d35Cc6634C0532925a3b844Bc454e4438f44e","amount":"0.7"}}'

200

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