Get Climate Impact Data

Returns information about the total climate impact of the carbon credit purchases for this account (or a subaccount). This is the underlying information that is displayed on the hosted public impact page for the account / subaccount. You can optionally use the 'from' and/or 'to' query parameters to only show impact for orders in a particular time period.

GET/impact/data

Authorizations#

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your CNaught API key.

Headers#

X-Subaccount-Id

string

If present, will only include orders for the subaccount with given id when calculating total impact.

Query Parameters#

from

string | null

Optionally specifies the start of the time period of orders to include in the impact calculation. If omitted, then orders starting from account creation are included. If present, must be a date in ISO 8601 format.

string | null

Optionally specifies the end of the time period of orders to include in the impact calculation. If omitted, then orders up to the present time are included. If present, must be a date in ISO 8601 format.

Response#

200

Impact Data

Show response attributes

name

string | null

The name for the account or subaccount whose impact data is being retrieved

logo_url

string | null

URL for the logo of the account or subaccount whose impact data is being retrieved

total_offset_kgs

number

Amount (in kg of CO₂e) of total credits retired for this account or subaccount

equivalents

object

Equivalent quantities to illustrate the climate impact of the total credits retired

Show child attributes

since_date

string

If an explicit "from" date was specified for the impact data request, then this is the requested "from" date. Otherwise, this is the date on which the account / subaccount began using CNaught to take climate action.

to_date

string | null

If an explicit "to" date was specified for the impact data request, then this is the requested "to" date. Otherwise, this is null.

category

ImpactCategory

Details of the category

Show child attributes

offset_kgs

number

Amount (in kg of CO₂e) of credits retired for this category

projects

ImpactProjectUsage[]

The projects that contributed to the impact for this category, and details about their contribution to the category.

Show child attributes

project

Project

Details of the project

Show child attributes

string

Identifier that can be used to retrieve the project details

name

string

Name of the project

summary

string | null

A short summary of the project

description

string | null

A longer description of the project

type

string

Type of project, eg Afforrestation, Renewable Energy, etc

activity_types

string[]

List of activity types for the project

developer

string | null

The name of the company or organization sponsoring the project

registry_name

string | null

The name of the registry on which the project's credits are registered

registry_id

string | null

The id of the project within the registry

registry_url

string | null

The full url to the project's documentation on the registry website

location_name

string | null

Location of the project

location_latitude

number | null

Latitude for the location of the project

location_longitude

number | null

Longitude for the location of the project

primary_image_url

string | null

URL for the primary image of the project

un_sdg_goals

number[]

list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals

methodology

string | null

The methodology used for the project

verifier

string | null

The verifier of the project

permanence

string | null

Information about the permanence of the carbon removal

lifetime

object

The lifetime of the project

Show child attributes

impact_type

string | null

The type of impact the project has (avoided emissions, removal, or mix of both)

due_diligence

string | null

Information about the due diligence performed on the project

beyond_carbon

string | null

Information about benefits beyond carbon reduction

risk_of_reversal

string | null

Information about the risk of carbon reversal

third_party_labels

string[] | null

List of third-party labels or certifications

notable_buyers

object[] | null

List of notable buyers of credits from this project

Show child attributes

due_diligence_figure

object | null

Figure illustrating due diligence information

Show child attributes

news_articles

object[] | null

List of news articles related to the project

Show child attributes

offset_kgs

number

Amount (in kg of CO₂e) of credits retired for this project

vintages

string

Comma-separated list of vintages of this projects that were used to fulfil orders that contributed to the impact

Get Checkout Session

Get Hosted Climate Impact Page Configuration

Get Climate Impact Data

curl --request GET \
  --url https://api.cnaught.com/v1/impact/data \
  --header 'Authorization: Bearer <token>'

{
  "name": "Acme, Inc",
  "logo_url": "https://customer-assets.cnaught.com/fe0df075-30e2-4e58-9feb-154e72a9205f/company_logo.png",
  "total_offset_kgs": 100000,
  "equivalents": {
    "cars_off_the_road": 10,
    "trees_planted": 30,
    "homes_annual_energy usages": 4,
    "flights_lax_to_nyc": 12
  },
  "since_date": "2023-01-01T18:00:00.000000Z",
  "categories": [
    {
      "category": {
        "name": "Emissions Reductions",
        "description": "This category covers a wide range of projects that aim to reduce and avoid emissions versus business as usual."
      },
      "offset_kgs": 100000,
      "projects": [
        {
          "project": {
            "id": "tbCjWP",
            "name": "Fuzhou Hongmiaoling Landfill Gas to Electricity Project",
            "summary": "This project collects landfill gas to generate 2.5MW of electricity at a landfill in southeastern China, avoiding the emission of methane (a potent greenhouse gas) into the atmosphere and using the methane to generate power and displace dirtier coal-fired power in the electric grid.",
            "description": "This project supports collection of landfill gas and generation of 2.5MW of electricity at a landfill in Fuzhou City in Fujian Province in southeastern China. The landfill received waste from 1995 until 2008, and—like most landfills—throws off methane as some of that waste decomposes. Credits are generated from two pieces of the project: (1) avoiding the emissions of methane (a potent greenhouse gas) into the atmosphere and (2) using the power generated from the methane (natural gas) to displace dirtier coal-fired power coming from the electric grid. The project clearly required carbon revenues to achieve these two goals and therefore generates high-quality carbon offsets.",
            "developer": "Fujian Tianyi Renewable Energy Technology & Utilization Co., Ltd.",
            "location_latitude": 26.0833,
            "location_longitude": 119.3,
            "location_name": "Fujian Province, China",
            "primary_image_url": "https://assets.cnaught.com/63a4ad4c853f90fd4c455107/6410c8c65c4300d2a1f433b4_Fuzhou%20LFG.jpeg",
            "registry_id": "253",
            "registry_name": "Verra",
            "registry_url": "https://registry.verra.org/app/projectDetail/VCS/253",
            "type": "Landfill Gas",
            "un_sdg_goals": []
          },
          "offset_kgs": 100000,
          "vintages": "2023"
        }
      ]
    }
  ]
}