API Documentation
Orders
Quotes
- POSTGet Quote by Emissions Mass
- POSTGet Quote for Air Freight Emissions
- POSTGet Quote for Flight Emissions
- POSTGet Quote for Ground Freight Emissions
- POSTGet Quote for Ground Transport Emissions
- POSTGet Quote for Office Space Emissions
- POSTGet Quote for Train Emissions
- POSTGet Vehicle Ride Credits Price Quote
Subaccounts
Checkout Sessions
Get Portfolio By Id
Returns information about a portfolio, including the project categories that comprise the portfolio, as well as price info.
curl --request GET \
--url https://api.cnaught.com/v1/portfolios/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "oH5hlq",
"name": "CNaught Impact",
"summary": "Science-backed, diversified portfolio to maximize impact, mitigate risk, and foster innovation based on Oxford's principles for carbon offsetting.",
"description": "The Impact Portfolio is a diversified portfolio of high-quality carbon credits designed to maximize impact, mitigate risk, and foster innovation. A portfolio approach to credits is recommended by the World Economic Forum, and the CNaught portfolio embodies the science-based best practices laid out in Oxford’s Principles for Carbon Offsetting. The Impact Portfolio includes the full range of carbon credit types CNaught offers so that you can maximize your ability to support a low-carbon future.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/65249b23e4abea354f4e8672_6412308f4b9aaa3dc170ae16_Manoa.jpeg",
"checkout_price_per_kg_usd_cents": 2,
"api_price_per_kg_usd_cents": 2,
"category_allocations": [
{
"category": {
"id": "9SGM2Q",
"name": "Ofxord Type 1 - Emissions Reductions",
"description": "This category covers a wide range of projects that aim to reduce and avoid emissions versus business as usual. Examples include: renewable energy, destruction of refrigerants that would otherwise be vented to the atmosphere, and capture of methane emitted from landfills.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6cae6722e722451cbd_6410df9a948c591f5861044c_Type%25201-Biogas.jpeg",
"projects": [
{
"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": []
}
]
},
"allocated_fraction": 0.5
},
{
"category": {
"id": "BZMaWS",
"name": "Oxford Type 2 - Conservation",
"description": "This category typically consists of nature-based projects that help retain an existing source of natural carbon storage that would otherwise be at risk — for example, rainforests that would be cut down for development or peat bogs that might be drained for agriculture.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c2e8a473af844e0a1_64076a324187221cae11a574_2%2520817292.jpeg",
"projects": [
{
"id": "32T2Iu",
"name": "Kootznoowoo",
"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": "Anew",
"location_latitude": 55.15311,
"location_longitude": -132.20364,
"location_name": "Prince of Wales Island, Alaska",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6525d0df5b8c0296e164b45f_64e91173760e2a6c30120d12_Kootznoowoozoo%20copy.png",
"registry_id": "499",
"registry_name": "American Carbon Registry",
"registry_url": "https://acr2.apx.com/mymodule/reg/prjView.asp?id1=",
"type": "Afforestation, reforestation, and revegetation",
"un_sdg_goals": [
4,
6,
11,
13,
14,
15
]
}
]
},
"allocated_fraction": 0.5
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the portfolio to return
"oH5hlq"
Response
Details about a portfolio, including the allocations of the portfolio to project categories, as well as price info.
Identifier that can be used to retrieve the portfolio
"Fc35bt3"
Name of the portfolio
"Climate Active"
Short description of the portfolio
"Portfolio of climate active eligible projects"
Extended description of the portfolio
"This is a portfolio that only includes projects eligible for Climate Active designation"
URL for the primary image of the portfolio
"https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg"
Price per kilogram of carbon credits when purchasing through the Checkout Session API or the Web Dashboard, in USD cents. Note that while this can be a decimal number like 1.6, a Checkout Session API or Web Dashboard order price will always be rounded up to an integer number of cents.
2
Price per kilogram of carbon credits when purchasing through the Order API, in USD cents.
2
The list of project category allocations in the portfolio.
Represents an allocation to a project category for a portfolio
Details of the project category
Identifier that can be used to retrieve the project category details.
"Fc35bt3"
Name of the project category
"Oxford Type 1 - Emissions Reductions"
Description of the project category
"This category covers a wide range of projects that aim to reduce and avoid emissions versus business as usual."
URL of the primary image for the project category
"https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg"
The list of projects belonging to the category. This represents the current projects within the category on the CNaught Platform, and can change over time.
Details about a project
Identifier that can be used to retrieve the project details
"Fc35bt3"
Name of the project
"Liling Landfill Gas Project"
A short summary of the project
"Lorem Ipsum"
A longer description of the project
"Lorem Ipsum Shmipsum"
Type of project, eg Afforrestation, Renewable Energy, etc
"REDD"
List of activity types for the project
["Landfill Gas", "Renewable Energy"]
The name of the company or organization sponsoring the project
"Charm Industrial"
The name of the registry on which the project's credits are registered
"Verra"
The id of the project within the registry
824
The full url to the project's documentation on the registry website
"https://registry.verra.org/app/projectDetail/VCS/824"
Location of the project
"Fujian Province, China"
Latitude for the location of the project
26.0833
Longitude for the location of the project
119.3
URL for the primary image of the project
"https://assets.cnaught.com/63a4ad4c853f90fd4c455107/64122d1dcf47f3840933826a_charm-industrial.jpg"
list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals
[1, 4, 6]
The methodology used for the project
"VM0010"
The verifier of the project
"DNV GL"
Information about the permanence of the carbon removal
"100+ years"
The type of impact the project has (avoided emissions, removal, or mix of both)
"Avoided Emissions"
Information about the due diligence performed on the project
"Extensive verification process was conducted..."
Information about benefits beyond carbon reduction
"This project also supports local communities..."
Information about the risk of carbon reversal
"Low risk due to long-term conservation agreements..."
List of third-party labels or certifications
["Gold Standard", "Climate Action Reserve"]
List of notable buyers of credits from this project
Name of the buyer
"Microsoft"
URL to the buyer's logo
"https://assets.cnaught.com/logos/microsoft.png"
Alt text for the buyer's logo
"Microsoft logo"
Figure illustrating due diligence information
Description of the due diligence figure
"This chart shows the verification process..."
URL to the due diligence figure image
"https://assets.cnaught.com/figures/due-diligence.png"
Alt text for the due diligence figure image
"Due diligence verification process diagram"
List of news articles related to the project
Title of the news article
"New Carbon Capture Project Launched"
URL to the news article
"https://example.com/news/carbon-capture"
Author of the news article
"John Smith"
Publication date of the news article
"2023-01-15T00:00:00Z"
CNaught's perspective on the news article
"This article highlights the importance of..."
Fraction of the portfolio (from 0 to 1) allocated to the project category
0.5
curl --request GET \
--url https://api.cnaught.com/v1/portfolios/{id} \
--header 'Authorization: Bearer <token>'
{
"id": "oH5hlq",
"name": "CNaught Impact",
"summary": "Science-backed, diversified portfolio to maximize impact, mitigate risk, and foster innovation based on Oxford's principles for carbon offsetting.",
"description": "The Impact Portfolio is a diversified portfolio of high-quality carbon credits designed to maximize impact, mitigate risk, and foster innovation. A portfolio approach to credits is recommended by the World Economic Forum, and the CNaught portfolio embodies the science-based best practices laid out in Oxford’s Principles for Carbon Offsetting. The Impact Portfolio includes the full range of carbon credit types CNaught offers so that you can maximize your ability to support a low-carbon future.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/65249b23e4abea354f4e8672_6412308f4b9aaa3dc170ae16_Manoa.jpeg",
"checkout_price_per_kg_usd_cents": 2,
"api_price_per_kg_usd_cents": 2,
"category_allocations": [
{
"category": {
"id": "9SGM2Q",
"name": "Ofxord Type 1 - Emissions Reductions",
"description": "This category covers a wide range of projects that aim to reduce and avoid emissions versus business as usual. Examples include: renewable energy, destruction of refrigerants that would otherwise be vented to the atmosphere, and capture of methane emitted from landfills.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6cae6722e722451cbd_6410df9a948c591f5861044c_Type%25201-Biogas.jpeg",
"projects": [
{
"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": []
}
]
},
"allocated_fraction": 0.5
},
{
"category": {
"id": "BZMaWS",
"name": "Oxford Type 2 - Conservation",
"description": "This category typically consists of nature-based projects that help retain an existing source of natural carbon storage that would otherwise be at risk — for example, rainforests that would be cut down for development or peat bogs that might be drained for agriculture.",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c2e8a473af844e0a1_64076a324187221cae11a574_2%2520817292.jpeg",
"projects": [
{
"id": "32T2Iu",
"name": "Kootznoowoo",
"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": "Anew",
"location_latitude": 55.15311,
"location_longitude": -132.20364,
"location_name": "Prince of Wales Island, Alaska",
"primary_image_url": "https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6525d0df5b8c0296e164b45f_64e91173760e2a6c30120d12_Kootznoowoozoo%20copy.png",
"registry_id": "499",
"registry_name": "American Carbon Registry",
"registry_url": "https://acr2.apx.com/mymodule/reg/prjView.asp?id1=",
"type": "Afforestation, reforestation, and revegetation",
"un_sdg_goals": [
4,
6,
11,
13,
14,
15
]
}
]
},
"allocated_fraction": 0.5
}
]
}