Skip to main content

Methodologies

Methodologies in the Registry API represent the documented methodologies for certifying carbon removal.

Each methodology is identified by a unique code (e.g., C03000000 for Biochar) that is referenced throughout the Registry API. The same methodology might have multiple versions available, which each have a unique methodology code.

Data schema​

A methodology object contains the following information:

  • name: The name of the methodology.
  • code: The unique code of the methodology.
  • edition: The edition or version of the methodology.
  • url: The URL to the methodology document.

Listing Methodologies​

To retrieve a list of methodologies, you can use the /registry/methodologies endpoint with a GET request. This endpoint supports pagination parameters:

  • limit: The maximum number of items to return (default: 100, max: 100)
  • offset: The number of items to skip (default: 0)

Example Request​

Basic example:​

List methodologies
curl -X 'GET' "/registry/methodologies" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Example with pagination:​

List methodologies
curl -X 'GET' "/registry/methodologies?limit=10&offset=0" \
  -H "Accept: application/json" \
  -H "Authorization: Basic $BASIC"

Response Structure​

The response includes a pagination object with information about the total number of items, the current offset, and the limit applied. The data array contains the list of methodology objects.

{
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  },
  "data": [
    {
      "name": "Biochar",
      "code": "C03000000",
      "edition": "2022",
      "url": "https://.../Biochar Methodology.pdf"
    },
    {
      "name": "Wooden Building Elements",
      "code": "C01000000",
      "edition": "Edition 2022 V2",
      "url": "https://.../Wooden Building Elements.pdf"
    }
    // Additional methodologies...
  ]
}

Next Steps​

Now that you understand how to retrieve information about methodologies, you can proceed to learn about Documents in the Registry API.