Returns information about a portfolio, including the project categories that comprise the portfolio, as well as price info.
/portfolios/{id}Authorization
string
header
requiredBearer authentication header of the form Bearer <token>, where <token> is your CNaught API key.
id
string
requiredID of the portfolio to return
Portfolio Details
Show response attributes
id
string
Identifier that can be used to retrieve the portfolio
name
string
Name of the portfolio
summary
string
Short description of the portfolio
description
string
Extended description of the portfolio
primary_image_url
string | null
URL for the primary image of the portfolio
checkout_price_per_kg_usd_cents
number
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.
api_price_per_kg_usd_cents
number
Price per kilogram of carbon credits when purchasing through the Order API, in USD cents.
category_allocations
PortfolioCategoryAllocation[]
The list of project category allocations in the portfolio.
Show child attributes
category
Category
Details of the project category
Show child attributes
id
string
Identifier that can be used to retrieve the project category details.
name
string
Name of the project category
description
string
Description of the project category
primary_image_url
string | null
URL of the primary image for the project category
projects
Project[]
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.
Show child attributes
id
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
start_year
integer | null
The start year of the project
end_year
integer | null
The end year of the project
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
name
string
Name of the buyer
logo_url
string
URL to the buyer's logo
logo_alt_text
string | null
Alt text for the buyer's logo
due_diligence_figure
object | null
Figure illustrating due diligence information
Show child attributes
description
string
Description of the due diligence figure
image_url
string
URL to the due diligence figure image
image_alt_text
string | null
Alt text for the due diligence figure image
news_articles
object[] | null
List of news articles related to the project
Show child attributes
title
string
Title of the news article
url
string
URL to the news article
author
string
Author of the news article
published_on
string<date-time>
Publication date of the news article
cnaught_take
string | null
CNaught's perspective on the news article
allocated_fraction
number
Fraction of the portfolio (from 0 to 1) allocated to the project category
Get Portfolio By Id
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
}
]
}