Quick Start

Get your API keys

API access will be launched soon for the public. To get notified when API keys become available, please join the waitlist by clicking on the "Waitlist" button in the API Access section of the CarbonMarketsHQ website.

Your API requests are authenticated using API keys. Any request that doesn't include a valid API key will be rejected.

Make your first request

Here's a sample GraphQL query to fetch all Verra projects with a "Registered" status.

Request Body

query {
  projects(
    limit: 5
    offset: 0
    projectFilter: { 
      current_registry: ["Verra"], 
      project_status: ["Registered"] 
    }
  ) {
      projectId
      currentRegistry
      projectDescription
      projectLink
      projectDeveloper
      sector
      projectType
      projectStatus
      methodology
      projectName
  }
}

{
    "data": {
        "projects": [
            {
                "projectId": "2649",
                "currentRegistry": "Verra",
                "projectDescription": "This project facilitates the decarbonisation of housing stock in the United Kingdom. Emission reductions are generated by reductions in fossil fuel and grid-connected electricity consumption in dwellings that are decarbonised compared to baseline consumption. The aggregated emissions from fossil fuel consumption of dwellings in the United Kingdom make up a significant component of greenhouse gas emissions; they also pose a significant opportunity to reduce real emissions._x000D_\n_x000D_\nThis project is defined as a grouped project where the project proponent acts as a central administrator towards the objective of expediting the pace of housing decarbonisation. The project targets a range of individual dwellings all located in the United Kingdom. _x000D_\n_x000D_\nThe project proponent collects, monitors, and aggregates data necessary to demonstrate additionality, quantify the resulting emission reductions and to originate voluntary carbon credits in conformance with the VM0008 Methodology.  The project proponent is responsible for overseeing validation and registration of the project with the Verra Registry and managing the verification and sale of the resulting emission reduction credits. _x000D_\n_x000D_\nThe main project objectives are:_x000D_\n_x000D_\n•\tTo gradually group together individual dwellings located in the United Kingdom inside a cluster, that will achieve together a significant reduction in real emissions during the project crediting period; _x000D_\n_x000D_\n•\tTo stimulate and reward dwelling owners for their efforts to reduce greenhouse gas emissions such as insulating, air sealing and improving the central heating system in existing dwellings and facilitating dwelling owners’ access to the internationally recognised voluntary carbon credits market; and_x000D_\n_x000D_\n•\tTo overcome the inherent challenges of aggregating small scale decarbonisation activities, simplify third party auditing and control (monitoring) as well as undertaking centralised data collection activities paramount to the quantification of emission reductions.",
                "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2649",
                "projectDeveloper": "Arctica Partners",
                "sector": "Energy demand",
                "projectType": "Energy Demand",
                "projectStatus": "Registered",
                "methodology": "VM0008",
                "projectName": "HOUSING DECARBONISATION IN THE UNITED KINGDOM"
            },
            {
                "projectId": "2649",
                "currentRegistry": "Verra",
                "projectDescription": "This project facilitates the decarbonisation of housing stock in the United Kingdom. Emission reductions are generated by reductions in fossil fuel and grid-connected electricity consumption in dwellings that are decarbonised compared to baseline consumption. The aggregated emissions from fossil fuel consumption of dwellings in the United Kingdom make up a significant component of greenhouse gas emissions; they also pose a significant opportunity to reduce real emissions.\n\nThis project is defined as a grouped project where the project proponent acts as a central administrator towards the objective of expediting the pace of housing decarbonisation. The project targets a range of individual dwellings all located in the United Kingdom. \n\nThe project proponent collects, monitors, and aggregates data necessary to demonstrate additionality, quantify the resulting emission reductions and to originate voluntary carbon credits in conformance with the VM0008 Methodology.  The project proponent is responsible for overseeing validation and registration of the project with the Verra Registry and managing the verification and sale of the resulting emission reduction credits. \n\nThe main project objectives are:\n\n•\tTo gradually group together individual dwellings located in the United Kingdom inside a cluster, that will achieve together a significant reduction in real emissions during the project crediting period; \n\n•\tTo stimulate and reward dwelling owners for their efforts to reduce greenhouse gas emissions such as insulating, air sealing and improving the central heating system in existing dwellings and facilitating dwelling owners’ access to the internationally recognised voluntary carbon credits market; and\n\n•\tTo overcome the inherent challenges of aggregating small scale decarbonisation activities, simplify third party auditing and control (monitoring) as well as undertaking centralised data collection activities paramount to the quantification of emission reductions.",
                "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2649",
                "projectDeveloper": "Arctica Partners",
                "sector": "Energy demand",
                "projectType": "Energy Demand",
                "projectStatus": "Registered",
                "methodology": null,
                "projectName": "HOUSING DECARBONISATION IN THE UNITED KINGDOM"
            },
            {
                "projectId": "2402",
                "currentRegistry": "Verra",
                "projectDescription": "The Linshu Biogas Recovery and Power Generation Project is located in Linshu Town, Shandong Province, China._x000D_\nThe proposed project activity will install a series of wastewater treatment equipment, biogas recovery and purification equipment, biogas generator and waste heat boiler to utilize the biogas to generate electricity and heat. The electricity and heat generated will be used for the production of Jinyimeng Group to replace those from NCPG and coal boilers.",
                "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2402",
                "projectDeveloper": "VPOWER New Energy Technology (LinYi) LTD",
                "sector": "Waste handling and disposal",
                "projectType": "Waste Handling and Disposal",
                "projectStatus": "Registered",
                "methodology": "ACM0014",
                "projectName": "Linshu Biogas Recovery and Power Generation Project"
            },
            {
                "projectId": "2999",
                "currentRegistry": "Verra",
                "projectDescription": "The proposed grouped project activity seeks to reduce greenhouse gases emissions by disseminating fuel- efficient cookstoves in Nepal. The proposed grouped project activity seeks to increase access of households and communities to improved cookstoves by disseminating high thermal efficiency and low greenhouse gas emitting cooking stoves known as Improved Cook Stoves (ICS) to the rural and semi-urban households of Nepal. Their old low efficiency and high greenhouse gas emitting stoves would be replaced. The implementation of the project activity, will result in the reduction of firewood consumption & consequent emissions from combustion leading to climate change mitigation in a sustainable manner. Overall objectives are reduction of greenhouse gases, conservation of forests and woodlands as well as improved health conditions of ICS users due to improved indoor air quality along with drudgery reduction in everyday cooking.",
                "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2999",
                "projectDeveloper": "Not specified",
                "sector": "Energy demand",
                "projectType": "Energy Demand",
                "projectStatus": "Registered",
                "methodology": "VMR0006",
                "projectName": "Cleaner cooking access in lower Himalayan region"
            },
            {
                "projectId": "1529",
                "currentRegistry": "Verra",
                "projectDescription": "The Inner Mongolia Chao’er Forest Industry IFM Project (hereafter referred to as “the project”) is located in Hulun Buir City, Inner Mongolia Autonomous Region, P.R.China. It is implemented by Chao’er Forest Industry Co. Ltd of China Inner Mongolia Forest Industry Group (hereafter “Project owner”) to protect the once logging forest. _x000D_\nThe proposed project is implemented in three forest farms under the jurisdiction of the Project owner, namely Dacongshan Forest Farm, Quansheng Forest Farm, and Taerqi Forest Farm. The project has 40,027.50ha commercial forest, whose ages ranging from sapling, middle age to mature forest. Before the implementation of the project, the forest within the project area was designed and planted as commercial forest, and logged annually according to the timber production plan approved by local forestry authority . In order to protect the forest ecosystem, improve the ecological environment, increase carbon sinks, reduce GHG emission reductions and slow down climate change, the project proponent decided to implement this improved forest management project activities from December 2017 to December 2077. And from the Project Start Date, PP has stopped the commercial logging in the project area and only allowed tending and managing. _x000D_\nThis project aims to protect 40,027.50ha commercial forest from logging. The Forest Conservation Project activities will be focused on forest resource supervision and monitoring. In order to supervise and monitor any disturbances that may affect the whole forest, a ranger team has been established to monitor the state of the forest with regard to diseases, illegal logging, hunting, fires etc. This ecosystem will then continue to provide its services to all the communities and entities that depend on it._x000D_\nThe project is expected to generate approximately 8,372,662 tCO2e with buffer deduction during the 30 years’ crediting period, with the annual emission reductions of 279,089 tCO2e.",
                "projectLink": "https://registry.verra.org/app/projectDetail/VCS/1529",
                "projectDeveloper": "Chao’er Forest Bureau of Inner Mongolia Autonomous Region",
                "sector": "Agriculture; forestry and fishing",
                "projectType": "Agriculture Forestry and Other Land Use",
                "projectStatus": "Registered",
                "methodology": "VM0010",
                "projectName": "Inner Mongolia Chao’er Improved Forest Management Project"
            }
        ]
    }
}

This is how you can call the API in your code, or via curl:

curl -X POST https://api.carbonmarketshq.com/v2/graphql \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{ 
       "query": "query Projects { projects( limit: 5 offset: 0 searchQuery: { searchString: \\"verra\\" } projectFilter: { projectStatus: [\"Registered\"] } ) { projectId currentRegistry projectDescription projectLink projectDeveloper sector projectType projectStatus methodology projectName } }"
     }'

const axios = require('axios');

const url = "https://api.carbonmarketshq.com/v2/graphql";
const headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_KEY"
};
const query = `
query Projects { 
  projects( 
    limit: 5 
    offset: 0 
    searchQuery: { searchString: "verra" } 
    projectFilter: { projectStatus: ["Registered"] } 
  ) { 
    projectId 
    currentRegistry 
    projectDescription 
    projectLink 
    projectDeveloper 
    sector 
    projectType 
    projectStatus 
    methodology 
    projectName 
  } 
}
`;

axios.post(url, { query }, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

import requests

url = "https://api.carbonmarketshq.com/v2/graphql"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}
query = """
query Projects { 
  projects( 
    limit: 5 
    offset: 0 
    searchQuery: { searchString: \\"verra\\" } 
    projectFilter: { projectStatus: ["Registered"] } 
  ) { 
    projectId 
    currentRegistry 
    projectDescription 
    projectLink 
    projectDeveloper 
    sector 
    projectType 
    projectStatus 
    methodology 
    projectName 
  } 
}
"""
response = requests.post(url, headers=headers, json={"query": query})
print(response.json())

PreviousWelcome NextGraphQL API

Last updated 1 year ago

{ "data": { "projects": [ { "projectId": "2649", "currentRegistry": "Verra", "projectDescription": "This project facilitates the decarbonisation of housing stock in the United Kingdom. Emission reductions are generated by reductions in fossil fuel and grid-connected electricity consumption in dwellings that are decarbonised compared to baseline consumption. The aggregated emissions from fossil fuel consumption of dwellings in the United Kingdom make up a significant component of greenhouse gas emissions; they also pose a significant opportunity to reduce real emissions._x000D_\n_x000D_\nThis project is defined as a grouped project where the project proponent acts as a central administrator towards the objective of expediting the pace of housing decarbonisation. The project targets a range of individual dwellings all located in the United Kingdom. _x000D_\n_x000D_\nThe project proponent collects, monitors, and aggregates data necessary to demonstrate additionality, quantify the resulting emission reductions and to originate voluntary carbon credits in conformance with the VM0008 Methodology. The project proponent is responsible for overseeing validation and registration of the project with the Verra Registry and managing the verification and sale of the resulting emission reduction credits. _x000D_\n_x000D_\nThe main project objectives are:_x000D_\n_x000D_\n•\tTo gradually group together individual dwellings located in the United Kingdom inside a cluster, that will achieve together a significant reduction in real emissions during the project crediting period; _x000D_\n_x000D_\n•\tTo stimulate and reward dwelling owners for their efforts to reduce greenhouse gas emissions such as insulating, air sealing and improving the central heating system in existing dwellings and facilitating dwelling owners’ access to the internationally recognised voluntary carbon credits market; and_x000D_\n_x000D_\n•\tTo overcome the inherent challenges of aggregating small scale decarbonisation activities, simplify third party auditing and control (monitoring) as well as undertaking centralised data collection activities paramount to the quantification of emission reductions.", "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2649", "projectDeveloper": "Arctica Partners", "sector": "Energy demand", "projectType": "Energy Demand", "projectStatus": "Registered", "methodology": "VM0008", "projectName": "HOUSING DECARBONISATION IN THE UNITED KINGDOM" }, { "projectId": "2649", "currentRegistry": "Verra", "projectDescription": "This project facilitates the decarbonisation of housing stock in the United Kingdom. Emission reductions are generated by reductions in fossil fuel and grid-connected electricity consumption in dwellings that are decarbonised compared to baseline consumption. The aggregated emissions from fossil fuel consumption of dwellings in the United Kingdom make up a significant component of greenhouse gas emissions; they also pose a significant opportunity to reduce real emissions.\n\nThis project is defined as a grouped project where the project proponent acts as a central administrator towards the objective of expediting the pace of housing decarbonisation. The project targets a range of individual dwellings all located in the United Kingdom. \n\nThe project proponent collects, monitors, and aggregates data necessary to demonstrate additionality, quantify the resulting emission reductions and to originate voluntary carbon credits in conformance with the VM0008 Methodology. The project proponent is responsible for overseeing validation and registration of the project with the Verra Registry and managing the verification and sale of the resulting emission reduction credits. \n\nThe main project objectives are:\n\n•\tTo gradually group together individual dwellings located in the United Kingdom inside a cluster, that will achieve together a significant reduction in real emissions during the project crediting period; \n\n•\tTo stimulate and reward dwelling owners for their efforts to reduce greenhouse gas emissions such as insulating, air sealing and improving the central heating system in existing dwellings and facilitating dwelling owners’ access to the internationally recognised voluntary carbon credits market; and\n\n•\tTo overcome the inherent challenges of aggregating small scale decarbonisation activities, simplify third party auditing and control (monitoring) as well as undertaking centralised data collection activities paramount to the quantification of emission reductions.", "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2649", "projectDeveloper": "Arctica Partners", "sector": "Energy demand", "projectType": "Energy Demand", "projectStatus": "Registered", "methodology": null, "projectName": "HOUSING DECARBONISATION IN THE UNITED KINGDOM" }, { "projectId": "2402", "currentRegistry": "Verra", "projectDescription": "The Linshu Biogas Recovery and Power Generation Project is located in Linshu Town, Shandong Province, China._x000D_\nThe proposed project activity will install a series of wastewater treatment equipment, biogas recovery and purification equipment, biogas generator and waste heat boiler to utilize the biogas to generate electricity and heat. The electricity and heat generated will be used for the production of Jinyimeng Group to replace those from NCPG and coal boilers.", "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2402", "projectDeveloper": "VPOWER New Energy Technology (LinYi) LTD", "sector": "Waste handling and disposal", "projectType": "Waste Handling and Disposal", "projectStatus": "Registered", "methodology": "ACM0014", "projectName": "Linshu Biogas Recovery and Power Generation Project" }, { "projectId": "2999", "currentRegistry": "Verra", "projectDescription": "The proposed grouped project activity seeks to reduce greenhouse gases emissions by disseminating fuel- efficient cookstoves in Nepal. The proposed grouped project activity seeks to increase access of households and communities to improved cookstoves by disseminating high thermal efficiency and low greenhouse gas emitting cooking stoves known as Improved Cook Stoves (ICS) to the rural and semi-urban households of Nepal. Their old low efficiency and high greenhouse gas emitting stoves would be replaced. The implementation of the project activity, will result in the reduction of firewood consumption & consequent emissions from combustion leading to climate change mitigation in a sustainable manner. Overall objectives are reduction of greenhouse gases, conservation of forests and woodlands as well as improved health conditions of ICS users due to improved indoor air quality along with drudgery reduction in everyday cooking.", "projectLink": "https://registry.verra.org/app/projectDetail/VCS/2999", "projectDeveloper": "Not specified", "sector": "Energy demand", "projectType": "Energy Demand", "projectStatus": "Registered", "methodology": "VMR0006", "projectName": "Cleaner cooking access in lower Himalayan region" }, { "projectId": "1529", "currentRegistry": "Verra", "projectDescription": "The Inner Mongolia Chao’er Forest Industry IFM Project (hereafter referred to as “the project”) is located in Hulun Buir City, Inner Mongolia Autonomous Region, P.R.China. It is implemented by Chao’er Forest Industry Co. Ltd of China Inner Mongolia Forest Industry Group (hereafter “Project owner”) to protect the once logging forest. _x000D_\nThe proposed project is implemented in three forest farms under the jurisdiction of the Project owner, namely Dacongshan Forest Farm, Quansheng Forest Farm, and Taerqi Forest Farm. The project has 40,027.50ha commercial forest, whose ages ranging from sapling, middle age to mature forest. Before the implementation of the project, the forest within the project area was designed and planted as commercial forest, and logged annually according to the timber production plan approved by local forestry authority . In order to protect the forest ecosystem, improve the ecological environment, increase carbon sinks, reduce GHG emission reductions and slow down climate change, the project proponent decided to implement this improved forest management project activities from December 2017 to December 2077. And from the Project Start Date, PP has stopped the commercial logging in the project area and only allowed tending and managing. _x000D_\nThis project aims to protect 40,027.50ha commercial forest from logging. The Forest Conservation Project activities will be focused on forest resource supervision and monitoring. In order to supervise and monitor any disturbances that may affect the whole forest, a ranger team has been established to monitor the state of the forest with regard to diseases, illegal logging, hunting, fires etc. This ecosystem will then continue to provide its services to all the communities and entities that depend on it._x000D_\nThe project is expected to generate approximately 8,372,662 tCO2e with buffer deduction during the 30 years’ crediting period, with the annual emission reductions of 279,089 tCO2e.", "projectLink": "https://registry.verra.org/app/projectDetail/VCS/1529", "projectDeveloper": "Chao’er Forest Bureau of Inner Mongolia Autonomous Region", "sector": "Agriculture; forestry and fishing", "projectType": "Agriculture Forestry and Other Land Use", "projectStatus": "Registered", "methodology": "VM0010", "projectName": "Inner Mongolia Chao’er Improved Forest Management Project" } ] } }