Projects

Retrieve all projects

GEThttps://api.carbonregistry.com/v1/projects

Authorization

bearer

Query parameters

Response

200

Body

application/json

projects*array of ApiProjectDto (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "projects": [
    {
      "city": "New York",
      "sector": {
        "id": "13",
        "title": "Waste handling and disposal"
      },
      "num": "713",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "otherBenefits": [
        {
          "title": "SDG 13: Climate Action",
          "checked": true,
          "id": 12,
          "description": ""
        }
      ],
      "fullName": "Project 1",
      "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
      "description": "This is a project",
      "shortDescription": "This is a project",
      "proponents": [
        {
          "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"
        }
      ],
      "publicUrl": "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
      "registry": "ICR",
      "status": "validated",
      "countryCode": "US",
      "state": "New York",
      "startDate": "2023-08-01T00:00:00.000Z",
      "creditingPeriodStartDate": "2023-08-01T00:00:00.000Z",
      "methodology": {
        "id": "VM0034",
        "title": "Canadian Forest Carbon Offset Methodology"
      },
      "type": {
        "id": "removal",
        "title": "Sequestration / Removal",
        "description": "Sequestration, removal and storage of carbondioxide (CO2) from the earth´s atmosphere."
      },
      "estimatedAnnualMitigations": [
        null
      ],
      "location": {
        "lat": 64.10944640131531,
        "lng": -21.81640625
      },
      "kmlFile": {
        "id": "",
        "uri": "http://example.com/document.pdf",
        "type": "monitoringReport",
        "name": "Document 1",
        "isPublic": false
      },
      "validators": [
        {
          "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"
        }
      ],
      "documentation": [
        {
          "id": "",
          "uri": "http://example.com/document.pdf",
          "type": "monitoringReport",
          "name": "Document 1",
          "isPublic": false
        }
      ]
    }
  ]
}

Retrieve a specific project by Id

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

Authorization

bearer

Path parameters

id*string

Project Id

Response

200

Body

application/json

project*ApiProjectDto (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "project": {
    "city": "New York",
    "sector": {
      "id": "13",
      "title": "Waste handling and disposal"
    },
    "num": "713",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "otherBenefits": [
      {
        "title": "SDG 13: Climate Action",
        "checked": true,
        "id": 12,
        "description": ""
      }
    ],
    "fullName": "Project 1",
    "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "description": "This is a project",
    "shortDescription": "This is a project",
    "proponents": [
      {
        "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"
      }
    ],
    "publicUrl": "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "registry": "ICR",
    "status": "validated",
    "countryCode": "US",
    "state": "New York",
    "startDate": "2023-08-01T00:00:00.000Z",
    "creditingPeriodStartDate": "2023-08-01T00:00:00.000Z",
    "methodology": {
      "id": "VM0034",
      "title": "Canadian Forest Carbon Offset Methodology"
    },
    "type": {
      "id": "removal",
      "title": "Sequestration / Removal",
      "description": "Sequestration, removal and storage of carbondioxide (CO2) from the earth´s atmosphere."
    },
    "estimatedAnnualMitigations": [
      null
    ],
    "location": {
      "lat": 64.10944640131531,
      "lng": -21.81640625
    },
    "kmlFile": {
      "id": "",
      "uri": "http://example.com/document.pdf",
      "type": "monitoringReport",
      "name": "Document 1",
      "isPublic": false
    },
    "validators": [
      {
        "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"
      }
    ],
    "documentation": [
      {
        "id": "",
        "uri": "http://example.com/document.pdf",
        "type": "monitoringReport",
        "name": "Document 1",
        "isPublic": false
      }
    ]
  }
}

Retrieve credits for a specific project

GEThttps://api.carbonregistry.com/v1/projects/{id}/credits

Authorization

bearer

Path parameters

id*string

Project ID

Response

200

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "summary": {
    "exPost": 1200,
    "exPostCancelled": 0,
    "exAnte": 15,
    "exAnteCancelled": 0,
    "retired": 13.5,
    "validated": 3500
  },
  "vintages": [
    {
      "events": [
        {
          "id": "text",
          "vintage": "text",
          "createdAt": "2024-12-30T16:59:32.579Z",
          "amount": 0,
          "type": "issuance",
          "creditType": "carbon",
          "monitoringPeriodStart": "2024-12-30T16:59:32.579Z",
          "monitoringPeriodEnd": "2024-12-30T16:59:32.579Z",
          "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"
  }
}