Projects

Who can use these endpoints

You can use any access token to access these endpoints.

Projects

list projects

Get projects

This endpoint returns a paginated list of projects. The projects returned are the ones that are public and have a verified organization.

GEThttps://api.carbonregistry.com/projects

Query parameters

Header parameters

Response

200

Body

application/json

pagination*ApiPaginationDto (object)

projects*array of ApiProjectDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/projects?limit=0&page=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2,
    "prevPage": 0
  },
  "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
        }
      ]
    }
  ]
}

Returns a paginated list of all public projects on ICR.

Callable by any access token regardless of permissions.

cURL

curl -X 'GET' \
  'https://api.carbonregistry.com/projects?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Typescript

list internal projects

Get internal projects - as seen in app

This endpoint returns a paginated list of projects as seen in app - may be non-reviewed data.

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

Query parameters

Header parameters

Response

200

Body

application/json

pagination*ApiPaginationDto (object)

projects*array of ApiProjectDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/projects/internal?limit=0&page=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2,
    "prevPage": 0
  },
  "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
        }
      ]
    }
  ]
}

Returns a paginated list of all projects on ICR.

Callable by any access token with permissions "examiner:read".

cURL

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/internal?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Get internal project

Get internal project - as seen in app

This endpoint returns the given project as seen in app - may be non-reviewed data.

GEThttps://api.carbonregistry.com/projects/internal/{projectId}

Path parameters

projectId*string

Header parameters

Response

200

Body

application/json

project*DetailedApiProjectDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/projects/internal/{projectId}', {
    method: 'GET',
    headers: {},
});
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
      }
    ],
    "events": [
      {
        "id": "text",
        "type": "status_change",
        "createdAt": "2024-11-07T02:37:03.673Z",
        "projectStatus": "draft",
        "previousProjectStatus": "draft"
      }
    ]
  }
}

Returns the project as seen on ICR.

Callable by any access token with permissions "examiner:read".

cURL

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

get project based on credit serialization / creditId

Find a project

This endpoint returns a project if it matches the search params. One can search either by setting the serialization of the project's credit or the creditId. The project is returned in the same format as the /projects endpoint.

GEThttps://api.carbonregistry.com/projects/find/project

Query parameters

Header parameters

Response

200

Body

application/json

citystring

The city of the project

Example: "New York"

sectorall of

The sector of the project

num*number

Project number. This is a unique identifier for the project

Example: "713"

id*string

The ID of the project

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

otherBenefitsarray of ApiOtherBenefitDto (object)

Other benefits of the project

fullName*string

The full name of the project

Example: "Project 1"

thumbnailstring

The url of the thumbnail of the project

Example: "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU"

description*string

The description of the project

Example: "This is a project"

shortDescription*string

The short description of the project

Example: "This is a project"

proponents*array of ApiProponentDto (object)

The proponents of the project

publicUrl*string

The URL of the project

Example: "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e"

registry*string

The registry of the project

Example: "ICR"

status*enum

The status of the project

Example: "validated"

draftproject_conceptunder_developmentunder_validationvalidatedclosedretracted

countryCodestring

The ISO 3166-1 alpha-2 country code of the project

Example: "US"

statestring

The state of the project

Example: "New York"

startDate*string (date-time)

The start date of the project

Example: "2023-08-01T00:00:00.000Z"

creditingPeriodStartDate*string (date-time)

The crediting period start date of the project

Example: "2023-08-01T00:00:00.000Z"

methodology*all of

The methodology of the project

type*all of

The type of the project

estimatedAnnualMitigations*array of string

The estimated annual mitigations of the project in tCO2

locationall of

The location of the project

kmlFileall of

The location of the project as a kml file

validators*array of ApiProponentDto (object)

The validators of the project

documentation*array of ApiDocumentDto (object)

The documentation of the project

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/projects/find/project?serialization=text&creditId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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
    }
  ]
}

If you have a creditId or a serialization for a credit you can use this endpoint to get the project that issued the credits.

Callable by any access token regardless of permissions.

cURL

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/find/project?serialization=ICR-ISL-354-78040-14-R-0-2021&creditId=exPost-2-0x51298f2f1142ecb129a2db5e6afd24f34f2e53f1' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Typescript

specific project

Get projects

This endpoint returns a paginated list of projects. The projects returned are the ones that are public and have a verified organization.

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

Path parameters

id*string

Header parameters

Response

200

Body

application/json

pagination*ApiPaginationDto (object)

projects*array of ApiProjectDto (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2,
    "prevPage": 0
  },
  "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
        }
      ]
    }
  ]
}

This endpoint returns the project given the projectId.

Callable by any access token regardless of permissions.

cURL

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

Typescript