Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cdr.fyi/llms.txt

Use this file to discover all available pages before exploring further.

​
List Projects

Retrieves a list of CDR projects.

​
HTTP Request

GET https://api.cdr.fyi/v1/projects

​
Query Parameters

ParameterTypeDescription
slugStringFilter projects by their slug
geoCountryStringFilter projects by country
methodStringFilter projects by method of carbon removal

​
Custom Headers

  • x-page: The page number (default is 1)
  • x-limit: Number of items per page (max 100, default is 10)

​
Example Request

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.cdr.fyi/v1/projects"

​
Create or Update a Project

This endpoint creates a new project or updates an existing one by upserting based on the Project ID.

​
HTTP Request

POST https://api.cdr.fyi/v1/projects

​
Request Headers

  • Authorization: Bearer YOUR_ACCESS_TOKEN
  • Content-Type: application/json

​
Request Body Parameters

Field NameTypeRequiredDescription
Project IDStringYesAutomatically assigned unique identifier
NameStringYesName of the project
SlugStringYesSlug for the projects
Supplier IDStringYesIdentifier for the supplier (parent)
External IDStringNoUnique identifier used by marketplace or registry
Marketplace IDsArrayNoIdentifiers for marketplaces listing the project
Geo CityStringNoCity where the project is located
Geo CountryStringYesCountry where the project is located
Geo AddressStringNoTextual address of the project
Geo CoordinatesObjectNo{lat, lon} coordinates of the project
Geo ContinentStringYesContinent where the project is located
URLStringNoURL of the project page on the supplier/registry
TypeStringYesFacility | Land Area
StatusStringYesAnnounced | Operational
DescriptionStringYesDescription of the project
AreaIntegerNoArea in hectares
Estimated Annual CapacityIntegerNoEstimated annual net capacity in tonnes of CO2
MethodStringYesMethod of carbon removal
SubmethodStringYesSubmethod of carbon removal
Registry IDStringNoIdentifier for the registry
Verifier/Validator NamesArray of StringsNoNames of verifier/validator organizations
Proponent NamesArray of StringsNoNames of project proponents
Methodology NamesArray of StringsNoNames of the methodologies used
Accreditation StandardsArray of ObjectsNoAccreditations with name and distinctions
Year CommissionedIntegerNoYear the project was commissioned
Project Start DateDateNoDate when crediting period begins
Estimated Operational LifetimeIntegerNoExpected operational lifetime in years
StagePicklistNo’Pilot’, ‘Demonstration’, ‘Commercial’
Storage DescriptionStringNoDescription of CO2 storage methods
Capacity NotesStringNoNotes on capacities for projects with multiple sites
Initial Annual CapacityIntegerNoInitial removal capacity
Annual Capacity at ScaleIntegerNoPeak removal capacity once fully operational
Permanency LevelStringNoMinimum years CO2 is expected to be sequestered
Example Request 
curl -X GET https://api.cdr.fyi/v1/projects \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json"
Example Response 
{
  "projects": [{
    "Project ID": "proj_001",
    "Name": "Project Alpha",
    "Slug": "project-alpha",
    "Supplier ID": "sup123",
    "Geo Country": "USA",
    "Type": "Land Area",
    "Status": "Operational",
    "Method": "Soil Sequestration",
    "Submethod": "Enhanced Weathering",
    "Description": "A project focused on sustainable land management and carbon capture."
  }]    
}

​
Error Responses

If the request is not successful, you will receive a 400 Bad Request or 401 Unauthorized response along with an error message indicating the issue.