Credits

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.

Project vintages

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

GEThttps://api.carbonregistry.com/carbonCredits/projects/{id}

Path parameters

id*string

Response

Body

summary*all of

Summary of project's credit data

vintages*array of ProjectCreditVintageData (object)

The credit data per vintage

project*all of

The project of the reservation

Request

const response = await fetch('https://api.carbonregistry.com/carbonCredits/projects/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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.

ICR Buffer Inventory

Returns the inventory of ICR Buffer Account

GEThttps://api.carbonregistry.com/carbonCredits/icr/inventory/buffer

Response

Body

summary*all of

Summary of project's credit data

organization*all of

The organization

credits*array of ApiInventoryCreditDto (object)

The credits in this organization inventory

Request

const response = await fetch('https://api.carbonregistry.com/carbonCredits/icr/inventory/buffer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  },
  "credits": [
    {
      "organizationId": "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"
    }
  ]
}

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.

ICR Adjustment Inventory

Returns the inventory of ICR Adjustment account

GEThttps://api.carbonregistry.com/carbonCredits/icr/inventory/adjustment

Response

Body

summary*all of

Summary of project's credit data

organization*all of

The organization

credits*array of ApiInventoryCreditDto (object)

The credits in this organization inventory

Request

const response = await fetch('https://api.carbonregistry.com/carbonCredits/icr/inventory/adjustment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  },
  "credits": [
    {
      "organizationId": "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"
    }
  ]
}

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.

ICR Adjustment Inventory

Returns the inventory of ICR Organization account

GEThttps://api.carbonregistry.com/carbonCredits/icr/inventory/organization

Response

Body

summary*all of

Summary of project's credit data

organization*all of

The organization

credits*array of ApiInventoryCreditDto (object)

The credits in this organization inventory

Request

const response = await fetch('https://api.carbonregistry.com/carbonCredits/icr/inventory/organization', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  },
  "credits": [
    {
      "organizationId": "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"
    }
  ]
}

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'

PreviousWarehouse NextDocuments

Last updated 29 days ago

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