Projects
Projects
list projects
This endpoint returns a paginated list of projects. The projects returned are the ones that are public and have a verified organization.
The amount of items to return
10
The page to return
0
API version
2023-06-16
GET /projects HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"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": true
},
"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": true
}
]
}
]
}
Returns a paginated list of all public projects on ICR.
Callable by any access token regardless of permissions.
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'
list internal projects
This endpoint returns a paginated list of projects as seen in app - may be non-reviewed data.
The amount of items to return
10
The page to return
0
API version
2023-06-16
GET /projects/internal HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"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": true
},
"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": true
}
]
}
]
}
Returns a paginated list of all projects on ICR.
Callable by any access token with permissions "examiner:read".
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
This endpoint returns the given project as seen in app - may be non-reviewed data.
API version
2023-06-16
GET /projects/internal/{projectId} HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"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": true
},
"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": true
}
],
"events": [
{
"id": "text",
"type": "status_change",
"createdAt": "2025-07-03T01:50:57.516Z",
"projectStatus": "draft",
"previousProjectStatus": "draft"
}
]
}
}
Returns the project as seen on ICR.
Callable by any access token with permissions "examiner:read".
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
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.
A credit serialization to find the project by.
ICR-ISL-354-78040-14-R-0-2021
A credit id to find the project by.
exPost-2-0x51298f2f1142ecb129a2db5e6afd24f34f2e53f1
API version
2023-06-16
GET /projects/find/project HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"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": true
},
"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": true
}
]
}
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 -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'
specific project
This endpoint returns a paginated list of projects. The projects returned are the ones that are public and have a verified organization.
API version
2023-06-16
GET /projects/{id} HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"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": true
},
"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": true
}
]
}
]
}
This endpoint returns the project given the projectId.
Callable by any access token regardless of permissions.
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'
Last updated