@import url("https://fonts.googleapis.com/css?family=Noto+Sans:300,400,600,700|Playfair+Display:500,600,700,800&display=swap");

html {
    font-family: 'Noto Sans', sans-serif;
}

h1, h2, h3, h4 {
    font-family: 'Playfair Display', serif;
}

CNaught API

API Reference

SDKs

Get Started

Pricing

Sign In

These examples demonstrate how to build carbon credit user experiences with the CNaught APIs.

Examples

CNaught makes it easy to help your customers compensate for their carbon footprint.

Introduction

This short tutorial will teach you the basics of making requests to the CNaught APIs.

Quickstart

This page documents all notable changes to this project.

Changelog

Overview

Our SDKs make it easier and faster to integrate carbon credits into your application.

Gets a list of orders in reverse chronological order up to the provided `limit` number of orders per call.
Pagination is supported by passing the first order `id` from a previous call into `ending_before` to retrieve the
previous page, or the last order `id` from a previous call into `starting_after` to retrieve the next page.


Get List of Orders

Places an order for the specified amount of carbon credits (in kilograms), or for the specified total price (in USD cents).
The order will remain in the `placed` state until it can be matched to available credits,
after which the order will be fulfilled and moved to the `fulfilled` state.
If specifying total price, we will determine the amount of carbon credits based on the unit price of the portfolio used for the order.
Because the amount must be an integer number of kilograms, the final actual total price might be slightly different than the specified total price.        


Create Carbon Credits Order

[Deprecated] Use `/quotes/ground-transport` with `passenger_car_van_or_suv` as the `vehicle_type` to calculate ride emissions.
Then pass the result to `/orders` to place the order.
 
Places an order for carbon credits for a vehicle ride of the given distance (in kilometers).
The order will remain in the `placed` state until it can be matched to available credits,
after which the order will be fulfilled and moved to the `fulfilled` state.

Create Carbon Credits Order for Vehicle Ride

Get Order By Id

When cancelling an order that has been fulfilled, a credit for the price of the order
will be applied to the current invoice. This means that it is possible for the credit
for a cancellation to appear on the invoice of the following billing period.
For example, if a billing period ends between when the order was placed and when it
is cancelled, then the credit will be applied to the latter billing period rather
than the one during which the order was placed.


Cancel Order

Get a price quote for offsetting the given amount of carbon emissions.


Get Quote by Emissions Mass

Get a price quote for offsetting air freight shipment carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Air Freight Emissions

Get a price quote for offsetting flight carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Flight Emissions

Get a price quote for offsetting ground freight shipment carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Ground Freight Emissions

Get a price quote for offsetting ground transportation carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Ground Transport Emissions

Get a price quote for offsetting office space carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Office Space Emissions

Get a price quote for offsetting train carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Quote for Train Emissions

[Deprecated] Use `/orders/ground-transportation` and pass `passenger_car_van_or_suv` as the `vehicle_type`.
 
Get a price quote for offsetting car ride carbon emissions.
Will return the amount of CO2e to offset and total price.

Get Vehicle Ride Credits Price Quote

Gets a list of subaccounts in reverse chronological order up to the provided `limit` number of subaccounts per call.
Pagination is supported by passing the first subaccount `id` from a previous call into `ending_before` to retrieve
the previous page, or the last subaccount `id` from a previous call into `starting_after` to retrieve the next page.


Get List of Subaccounts

Create Subaccount

Get Subaccount By Id

Updates a Subaccount with given id. 
This does not include updating the logo: there are separate endpoints for doing so.
Aside from the logo, all properties should be included in the request body.
Not including the default portfolio id in the update request will have the effect of making the subaccount not
have an explicit default portfolio (making it inherit the default portfolio from the parent user).


Update Subaccount

Updates the logo for a Subaccount with given id with the image contents sent in the request body.
The request body should be the binary image contents in a supported image format, and the request
should include a Content-Type header specifying the image content type.
Supported image types are: PNG (image/png), JPEG (image/jpeg), WEBP (image/webp), and SVG (image/svg+xml).


Update Subaccount Logo By Uploading Image Content

Updates the logo for a Subaccount with given id by downloading from given URL. 
The URL should point to a valid image in a supported image format, and should include
the content type for the image in the HTTP response when the image is retrieved from the URL.
Supported image types are: PNG (image/png), JPEG (image/jpeg), WEBP (image/webp), and SVG (image/svg+xml).


Update Subaccount Logo From URL

Removes the logo for a Subaccount with given id.


Remove Logo From Subaccount

Creates a Checkout Session that, when completed, will result in an order
for the specified amount of carbon credits (in kilograms). The total price
must be at least $0.50 (the corresponding amount will depend on the per kg
price of the specified portfolio). The Quotes API can be used to check the
price before attempting to create a session.


Create Checkout Session

Returns the Checkout Session with the given id

Get Checkout Session

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 Climate Impact Data

Returns information about the hosted public climate impact page configuration for the account (or a subaccount)

Get Hosted Climate Impact Page Configuration

Get Project By Id

Returns information about a project category

Get Project Category By Id

Gets the list of portfolios the user is able to use for purchasing credits. This list is not paginated - the full list of portfolios is returned.
The portfolio objects in the list do not include details about the project categories comprising the portfolio - those can be retrieved
for each portfolio using the [Get Portfolio By Id](/api/reference/#operation/GetPortfolioById) API endpoint.


Get List of Portfolios

Returns information about a portfolio, including the project categories that comprise the portfolio.

Documentation

Resources

Examples

Event Travel Offsetting App