Endpoints available for access tokens

These are endpoints that need no special permissions, only a valid access token. Can be an app access token or some installation access token.

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

Body

pagination*ApiPaginationDto (object)

projects*array of ApiProjectDto (object)

Request

Response

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'

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

Body

citystring

The city of the project

id*string

The ID of the project

otherBenefitsarray of ApiOtherBenefitDto (object)

Other benefits of the project

fullName*string

The full name of the project

thumbnailstring

The url of the thumbnail of the project

description*string

The description of the project

shortDescription*string

The short description of the project

proponents*array of ApiProponentDto (object)

The proponents of the project

publicUrl*string

The URL of the project

registry*string

The registry of the project

status*enum

The status of the project

draftproject_conceptunder_developmentunder_validationvalidatedclosedretracted

countryCodestring

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

statestring

The state of the project

startDate*string (date-time)

The start date of the project

creditingPeriodStartDate*string (date-time)

The crediting period start date of the project

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

location*all of

The location of the project

validators*array of ApiProponentDto (object)

The validators of the project

documentation*array of ApiDocumentDto (object)

The documentation of the project

Request

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

Response

{
  "city": "New York",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "otherBenefits": [
    {
      "title": "SDG 13: Climate Action",
      "checked": true,
      "id": 12,
      "description": "text"
    }
  ],
  "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
  },
  "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": [
    {
      "uri": "http://example.com/document.pdf",
      "type": "proofOfConcept",
      "name": "Document 1"
    }
  ]
}

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?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

Get a project

This endpoint returns a project. The project is returned in the same format as the /projects endpoint.

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

Path parameters

projectId*string

Header parameters

Response

Body

citystring

The city of the project

id*string

The ID of the project

otherBenefitsarray of ApiOtherBenefitDto (object)

Other benefits of the project

fullName*string

The full name of the project

thumbnailstring

The url of the thumbnail of the project

description*string

The description of the project

shortDescription*string

The short description of the project

proponents*array of ApiProponentDto (object)

The proponents of the project

publicUrl*string

The URL of the project

registry*string

The registry of the project

status*enum

The status of the project

draftproject_conceptunder_developmentunder_validationvalidatedclosed

countryCodestring

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

statestring

The state of the project

startDate*string (date-time)

The start date of the project

creditingPeriodStartDate*string (date-time)

The crediting period start date of the project

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

location*all of

The location of the project

validators*array of ApiProponentDto (object)

The validators of the project

documentation*array of ApiDocumentDto (object)

The documentation of the project

Request

Response

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'

Retirements

Get retirement

Callable by any access token regardless of permissions. This endpoint returns the data connected to a particular retirement.

Get retirement

This endpoint returns a json object with the retirement information.

GEThttps://api.carbonregistry.com/retirements

Query parameters

Header parameters

Response

Body

id*string

The ID of the retirement

reasonstring

The reason for the retirement

commentstring

A comment about the retirement

beneficiarystring

The name of the retiree

organizationId*string

The ID of the organization associated with the retirement

serializationstring

The serialization of the carbon credits associated with the retirement

amount*number

The amount of the retirement

project*all of

The project associated with the carbon credits

Request

Response

Get retirement pdf

Given an id of the retirement this is an endpoint that downloads the certificate.

Get retirement pdf

This endpoint returns a specificretirement as a pdf

GEThttps://api.carbonregistry.com/retirements/{retirementId}/pdf

Path parameters

retirementId*string

Header parameters

Response

File content

Body

any

Request

PreviousEndpoints available for ICR App installation and Organization access tokens NextEnvironments

Last updated 19 days ago

{ "city": "New York", "id": "123e4567-e89b-12d3-a456-426614174000", "otherBenefits": [ { "title": "SDG 13: Climate Action", "checked": true, "id": 12, "description": "text" } ], "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 }, "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": [ { "uri": "http://example.com/document.pdf", "type": "proofOfConcept", "name": "Document 1" } ] }

{ "pagination": { "total": 100, "currentPage": 1, "pageCount": 10, "nextPage": 2, "prevPage": 0 }, "projects": [ { "city": "New York", "id": "123e4567-e89b-12d3-a456-426614174000", "otherBenefits": [ { "title": "SDG 13: Climate Action", "checked": true, "id": 12, "description": "text" } ], "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 }, "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": [ { "uri": "http://example.com/document.pdf", "type": "proofOfConcept", "name": "Document 1" } ] } ] }