latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

Projects

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.

get/projects/find/project

Query parameters

serializationstring required

A credit serialization to find the project by.

creditIdstring required

A credit id to find the project by.

Headers

x-icr-api-versionstring

API version

Response

citystring

The city of the project

numnumber required

Project number. This is a unique identifier for the project

idstring required

The ID of the project

fullNamestring required

The full name of the project

thumbnailstring

The url of the thumbnail of the project

descriptionstring required

The description of the project

shortDescriptionstring required

The short description of the project

publicUrlstring required

The URL of the project

registrystring required

The registry of the project

The status of the project

countryCodestring

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

statestring

The state of the project

startDatestring date-time required

The start date of the project

creditingPeriodStartDatestring date-time required

The crediting period start date of the project

estimatedAnnualMitigationsstring[] required

The estimated annual mitigations of the project in tCO2

Example response

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