GET
/
registries
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "projects_count": 123
    }
  ]
}

Registries API

Access information about carbon registries and their associated projects.

Authorizations

X-API-KEY
string
required

API key for authentication.

Required Fields

The registry object includes the following required fields:

  • id (integer): Unique identifier
  • name (string): Registry name

Optional fields:

  • description (string): Registry description
  • projects_count (integer): Number of associated projects

Endpoint

Get All Registries

name
string

Filter registries by name

page
integer

Page number for pagination

page_size
integer
default:"10"

Number of results per page (max: 100)

Response

count
integer

Total number of registries

next
string

URL for next page of results

previous
string

URL for previous page of results

results
array

Example Request

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

# Get all registries
response = requests.get(
    'https://api.carbonapi.com/registries',
    headers=headers
)

# Filter registries by name
params = {
    'name': 'Verra',
    'page_size': 50
}

response = requests.get(
    'https://api.carbonapi.com/registries',
    headers=headers,
    params=params
)

Example Response

{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Verra",
      "description": "Verra develops and manages standards that help countries, the private sector, and civil society achieve ambitious sustainable development and climate action goals.",
      "projects_count": 1582
    },
    {
      "id": 2,
      "name": "Gold Standard",
      "description": "Gold Standard was established in 2003 by WWF and other international NGOs to ensure projects that reduced carbon emissions featured the highest levels of environmental integrity.",
      "projects_count": 892
    }
  ]
}