GET
/
portfolios
/
{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
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the portfolio to return

Example:

"oH5hlq"

Response

200
application/json
Portfolio Details

Details about a portfolio, including the allocations of the portfolio to project categories, as well as price info.

id
string

Identifier that can be used to retrieve the portfolio

Example:

"Fc35bt3"

name
string

Name of the portfolio

Example:

"Climate Active"

summary
string

Short description of the portfolio

Example:

"Portfolio of climate active eligible projects"

description
string

Extended description of the portfolio

Example:

"This is a portfolio that only includes projects eligible for Climate Active designation"

primary_image_url
string | null

URL for the primary image of the portfolio

Example:

"https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg"

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.

Example:

2

api_price_per_kg_usd_cents
number

Price per kilogram of carbon credits when purchasing through the Order API, in USD cents.

Example:

2

category_allocations
object[]

The list of project category allocations in the portfolio.

Represents an allocation to a project category for a portfolio