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

​
Scopes API

Access information about high-level categorization of carbon offset projects.

​
Authorizations

​
X-API-KEY
string
required
API key for authentication.

​
Endpoint

​
Get All Scopes

​
name
string
Filter by scope 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 scopes
​
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 scopes
response = requests.get(
    'https://api.carbonapi.com/scopes',
    headers=headers
)

# Get specific scope
params = {
    'name': 'Forestry',
    'page_size': 50
}

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

​
Example Response

{
  "count": 8,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Forestry and Land Use",
      "description": "Projects related to forest conservation, reforestation, and land management",
      "project_types": [
        {
          "id": 1,
          "name": "REDD+",
          "description": "Reducing emissions from deforestation and forest degradation"
        },
        {
          "id": 2,
          "name": "Afforestation/Reforestation",
          "description": "Establishment of forest on previously unforested land"
        }
      ]
    }
  ]
}