# CNaught API

## Docs

- [Create Checkout Session](https://docs.cnaught.com/api-reference/checkout-sessions/create-checkout-session.md): 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 pr…
- [Get Checkout Session](https://docs.cnaught.com/api-reference/checkout-sessions/get-checkout-session.md): Returns the Checkout Session with the given id
- [Get Climate Impact Data](https://docs.cnaught.com/api-reference/climate-impact/get-climate-impact-data.md): 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…
- [Get Hosted Climate Impact Page Configuration](https://docs.cnaught.com/api-reference/climate-impact/get-hosted-climate-impact-page-configuration.md): Returns information about the hosted public climate impact page configuration for the account (or a subaccount)
- [Overview](https://docs.cnaught.com/api-reference/introduction.md)
- [Cancel Order](https://docs.cnaught.com/api-reference/orders/cancel-order.md): 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…
- [Create Carbon Credits Order](https://docs.cnaught.com/api-reference/orders/create-carbon-credits-order.md): 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 specify…
- [Create Carbon Credits Order for Vehicle Ride](https://docs.cnaught.com/api-reference/orders/create-carbon-credits-order-for-vehicle-ride.md): <b>[Deprecated]</b> 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. <br/><br/> Places an order for carbon credits for a vehicle ride of the given distance (in kilometers). The orde…
- [Get List of Orders](https://docs.cnaught.com/api-reference/orders/get-list-of-orders.md): 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…
- [Get Order By Id](https://docs.cnaught.com/api-reference/orders/get-order-by-id.md): Returns information about an order
- [Get List of Portfolios](https://docs.cnaught.com/api-reference/portfolios/get-list-of-portfolios.md): 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…
- [Get Portfolio By Id](https://docs.cnaught.com/api-reference/portfolios/get-portfolio-by-id.md): Returns information about a portfolio, including the project categories that comprise the portfolio, as well as price info.
- [Get Project By Id](https://docs.cnaught.com/api-reference/projects/get-project-by-id.md): Returns information about a project, including credit issuances by vintage year
- [Get Project Category By Id](https://docs.cnaught.com/api-reference/projects/get-project-category-by-id.md): Returns information about a project category
- [Get Quote by Emissions Mass](https://docs.cnaught.com/api-reference/quotes/get-quote-by-emissions-mass.md): Get a price quote for offsetting the given amount of carbon emissions.
- [Get Quote for Air Freight Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-air-freight-emissions.md): Get a price quote for offsetting air freight shipment carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Quote for Flight Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-flight-emissions.md): Get a price quote for offsetting flight carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Quote for Ground Freight Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-ground-freight-emissions.md): Get a price quote for offsetting ground freight shipment carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Quote for Ground Transport Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-ground-transport-emissions.md): Get a price quote for offsetting ground transportation carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Quote for Office Space Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-office-space-emissions.md): Get a price quote for offsetting office space carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Quote for Train Emissions](https://docs.cnaught.com/api-reference/quotes/get-quote-for-train-emissions.md): Get a price quote for offsetting train carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Get Vehicle Ride Credits Price Quote](https://docs.cnaught.com/api-reference/quotes/get-vehicle-ride-credits-price-quote.md): <b>[Deprecated]</b> Use `/orders/ground-transportation` and pass `passenger_car_van_or_suv` as the `vehicle_type`. <br/><br/> Get a price quote for offsetting car ride carbon emissions. Will return the amount of CO₂e to offset and total price.
- [Create Subaccount](https://docs.cnaught.com/api-reference/subaccounts/create-subaccount.md): Creates a new Subaccount.
- [Delete Subaccount](https://docs.cnaught.com/api-reference/subaccounts/delete-subaccount.md): Deletes the Subaccount with the given id. This operation will fail if the subaccount has orders associated with it.
- [Get List of Subaccounts](https://docs.cnaught.com/api-reference/subaccounts/get-list-of-subaccounts.md): 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…
- [Get Subaccount By Id](https://docs.cnaught.com/api-reference/subaccounts/get-subaccount-by-id.md): Returns information about a subaccount
- [Remove Logo From Subaccount](https://docs.cnaught.com/api-reference/subaccounts/remove-logo-from-subaccount.md): Removes the logo for a Subaccount with given id.
- [Update Subaccount](https://docs.cnaught.com/api-reference/subaccounts/update-subaccount.md): Updates the Subaccount with the 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 su…
- [Update Subaccount Logo By Uploading Image Content](https://docs.cnaught.com/api-reference/subaccounts/update-subaccount-logo-by-uploading-image-content.md): 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 (…
- [Update Subaccount Logo From URL](https://docs.cnaught.com/api-reference/subaccounts/update-subaccount-logo-from-url.md): 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/pn…
- [Changelog](https://docs.cnaught.com/changelog.md): This page documents all notable changes to this project.
- [Examples](https://docs.cnaught.com/examples.md): These examples demonstrate how to build carbon credit user experiences with the CNaught APIs.
- [FAQ](https://docs.cnaught.com/faq.md): You have questions? We have answers
- [Introduction](https://docs.cnaught.com/introduction.md): CNaught makes it easy to help your customers compensate for their carbon footprint.
- [Quickstart](https://docs.cnaught.com/quickstart.md): This short tutorial will teach you the basics of making requests to the CNaught APIs.
- [Overview](https://docs.cnaught.com/sdks/overview.md): Our SDKs make it easier and faster to integrate carbon credits into your application.

## OpenAPI Specs

- [openapi](https://docs.cnaught.com/api-reference/openapi.yaml)