Home Projects Credits Transactions Insights

Credits

PreviousWarehouse NextDocuments

Last updated 4 months ago

Credit data

Get credit data for a specific project

Given the id of a project this endpoint returns the summary of credit data for all vintages for the project. Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/carbonCredits/projects/{PROJECT_ID}' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Get credit data for ICR Buffer Account

This endpoint returns the credit inventory for the ICR buffer account. Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/carbonCredits/icr/inventory/buffer' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Get credit data for ICR Adjustment Account

This endpoint returns the credit inventory for the ICR adjustment account. Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/carbonCredits/icr/inventory/adjustment' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Get credit data for ICR Organization Account

This endpoint returns the credit inventory for the ICR organization account. Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/carbonCredits/icr/inventory/organization' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Project vintages

Returns a summary of the current state of credits for the given project

get

/carbonCredits/projects/{id}

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/carbonCredits/projects/{id}'

200

{
  "vintages": [
    {
      "vintage": "2023",
      "events": [
        {
          "id": "text",
          "vintage": "text",
          "createdAt": "2025-02-21T18:04:14.197Z",
          "amount": 1,
          "monitoringPeriodStart": "2025-02-21T18:04:14.197Z",
          "monitoringPeriodEnd": "2025-02-21T18:04:14.197Z",
          "type": "issuance",
          "creditType": "carbon",
          "files": [
            {
              "fileName": "text",
              "id": "text",
              "size": 1024,
              "url": "text",
              "type": "monitoringReport"
            }
          ],
          "verificationBody": {
            "id": "text",
            "directoryUrl": "text",
            "fullName": "text"
          }
        }
      ],
      "summary": {
        "exPost": 1200,
        "exPostCancelled": 0,
        "exAnte": 15,
        "exAnteCancelled": 0,
        "retired": 13.5,
        "validated": 3500
      }
    }
  ],
  "summary": {
    "exPost": 1200,
    "exPostCancelled": 0,
    "exAnte": 15,
    "exAnteCancelled": 0,
    "retired": 13.5,
    "validated": 3500
  },
  "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"
  }
}

ICR Buffer Inventory

Returns the inventory of ICR Buffer Account

get

/carbonCredits/icr/inventory/buffer

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/carbonCredits/icr/inventory/buffer'

200

{
  "credits": [
    {
      "organizationId": "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"
      }
    }
  ],
  "summary": {
    "exPost": 1200,
    "exAnte": 15,
    "retired": 13.5
  },
  "organization": {
    "fullName": "John Doe",
    "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
  }
}

ICR Adjustment Inventory

Returns the inventory of ICR Adjustment account

get

/carbonCredits/icr/inventory/adjustment

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/carbonCredits/icr/inventory/adjustment'

200

{
  "credits": [
    {
      "organizationId": "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"
      }
    }
  ],
  "summary": {
    "exPost": 1200,
    "exAnte": 15,
    "retired": 13.5
  },
  "organization": {
    "fullName": "John Doe",
    "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
  }
}

ICR Adjustment Inventory

Returns the inventory of ICR Organization account

get

/carbonCredits/icr/inventory/organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/carbonCredits/icr/inventory/organization'

200

{
  "credits": [
    {
      "organizationId": "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"
      }
    }
  ],
  "summary": {
    "exPost": 1200,
    "exAnte": 15,
    "retired": 13.5
  },
  "organization": {
    "fullName": "John Doe",
    "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
  }
}