> ## Documentation Index > Fetch the complete documentation index at: https://docs.cnaught.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Portfolio By Id > Returns information about a portfolio, including the project categories that comprise the portfolio, as well as price info. ## OpenAPI ````yaml api-reference/openapi.yaml get /portfolios/{id} openapi: 3.1.0 info: title: CNaught Carbon Credits API Documentation contact: email: support@cnaught.com name: CNaught url: https://cnaught.com/ version: v1 description: | Carbon Credits API Documentation termsOfService: https://cnaught.com/terms license: name: MIT url: https://spdx.org/licenses/MIT.html servers: - url: https://api.cnaught.com/v1 description: CNaught API security: - ApiKey: [] tags: - name: Orders description: Endpoints for placing orders and retrieving information about orders - name: Quotes description: Endpoints for obtaining price quotes for orders - name: Climate Impact description: >- Endpoints for retrieving climate impact data and hosted public impact page configuration - name: Subaccounts description: Endpoints for creating and retrieving information about subaccounts paths: /portfolios/{id}: parameters: - name: id in: path description: ID of the portfolio to return required: true schema: type: string examples: - oH5hlq get: tags: - Portfolios summary: Get Portfolio By Id description: >- Returns information about a portfolio, including the project categories that comprise the portfolio, as well as price info. operationId: GetPortfolioById responses: '200': description: Portfolio Details content: application/json: schema: $ref: '#/components/schemas/PortfolioWithCategoryAllocations' examples: Example: value: 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 '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/PortfolioNotFound' components: schemas: PortfolioWithCategoryAllocations: allOf: - $ref: '#/components/schemas/Portfolio' - type: object description: >- Details about a portfolio, including the allocations of the portfolio to project categories, as well as price info. properties: checkout_price_per_kg_usd_cents: type: number description: > 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. examples: - 2 - 1.6 api_price_per_kg_usd_cents: type: number description: > Price per kilogram of carbon credits when purchasing through the Order API, in USD cents. examples: - 2 - 1.6 category_allocations: type: array items: $ref: '#/components/schemas/PortfolioCategoryAllocation' description: The list of project category allocations in the portfolio. Portfolio: type: object description: >- Details about a project portfolio. A portfolio is composed of project categories, with a percentage allocation to each category. properties: id: type: string description: Identifier that can be used to retrieve the portfolio examples: - Fc35bt3 name: type: string description: Name of the portfolio examples: - Climate Active summary: type: string description: Short description of the portfolio examples: - Portfolio of climate active eligible projects description: type: string description: Extended description of the portfolio examples: - >- This is a portfolio that only includes projects eligible for Climate Active designation primary_image_url: type: - string - 'null' description: URL for the primary image of the portfolio examples: - >- https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg PortfolioCategoryAllocation: type: object description: Represents an allocation to a project category for a portfolio properties: category: $ref: '#/components/schemas/CategoryWithProjects' description: Details of the project category allocated_fraction: type: number description: >- Fraction of the portfolio (from 0 to 1) allocated to the project category examples: - 0.5 BaseProblemDetails: type: object description: Problem details object returned on errors properties: title: type: string description: Short, human-readable summary of the problem details: type: string description: Longer, human-readable description of the problem type: type: string description: URI that identifies the problem type status: type: integer description: HTTP status code of the error CategoryWithProjects: allOf: - $ref: '#/components/schemas/Category' - type: object description: >- Details about a category of projects, including the projects within the category properties: projects: type: array items: $ref: '#/components/schemas/Project' description: >- 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. Category: type: object description: >- Details about a project category. Project categories are different classifications of projects - eg by Oxford Type. properties: id: type: string description: >- Identifier that can be used to retrieve the project category details. examples: - Fc35bt3 name: type: string description: Name of the project category examples: - Oxford Type 1 - Emissions Reductions description: type: string description: Description of the project category examples: - >- This category covers a wide range of projects that aim to reduce and avoid emissions versus business as usual. primary_image_url: type: - string - 'null' description: URL of the primary image for the project category examples: - >- https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/6524ae6c0387291e029550f1_64076b4177668a2e4a6a1d31_peter-thomas-TRAYV5rsA9Y-unsplash%25201.jpeg Project: type: object description: Details about a project properties: id: type: string description: Identifier that can be used to retrieve the project details examples: - Fc35bt3 name: type: string description: Name of the project examples: - Liling Landfill Gas Project summary: type: - string - 'null' description: A short summary of the project examples: - Lorem Ipsum description: type: - string - 'null' description: A longer description of the project examples: - Lorem Ipsum Shmipsum type: type: string description: Type of project, eg Afforrestation, Renewable Energy, etc examples: - REDD activity_types: type: array description: List of activity types for the project items: type: string examples: - - Landfill Gas - Renewable Energy developer: type: - string - 'null' description: The name of the company or organization sponsoring the project examples: - Charm Industrial registry_name: type: - string - 'null' description: >- The name of the registry on which the project's credits are registered examples: - Verra registry_id: type: - string - 'null' description: The id of the project within the registry examples: - 824 registry_url: type: - string - 'null' description: The full url to the project's documentation on the registry website examples: - https://registry.verra.org/app/projectDetail/VCS/824 location_name: type: - string - 'null' description: Location of the project examples: - Fujian Province, China location_latitude: type: - number - 'null' description: Latitude for the location of the project examples: - 26.0833 location_longitude: type: - number - 'null' description: Longitude for the location of the project examples: - 119.3 primary_image_url: type: - string - 'null' description: URL for the primary image of the project examples: - >- https://assets.cnaught.com/63a4ad4c853f90fd4c455107/64122d1dcf47f3840933826a_charm-industrial.jpg un_sdg_goals: type: array description: >- list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals items: type: number examples: - - 1 - 4 - 6 methodology: type: - string - 'null' description: The methodology used for the project examples: - VM0010 verifier: type: - string - 'null' description: The verifier of the project examples: - DNV GL permanence: type: - string - 'null' description: Information about the permanence of the carbon removal examples: - 100+ years lifetime: type: object description: The lifetime of the project properties: start_year: type: - integer - 'null' description: The start year of the project examples: - 2020 end_year: type: - integer - 'null' description: The end year of the project examples: - 2040 impact_type: type: - string - 'null' description: >- The type of impact the project has (avoided emissions, removal, or mix of both) examples: - Avoided Emissions due_diligence: type: - string - 'null' description: Information about the due diligence performed on the project examples: - Extensive verification process was conducted... beyond_carbon: type: - string - 'null' description: Information about benefits beyond carbon reduction examples: - This project also supports local communities... risk_of_reversal: type: - string - 'null' description: Information about the risk of carbon reversal examples: - Low risk due to long-term conservation agreements... third_party_labels: type: - array - 'null' description: List of third-party labels or certifications items: type: string examples: - - Gold Standard - Climate Action Reserve notable_buyers: type: - array - 'null' description: List of notable buyers of credits from this project items: type: object properties: name: type: string description: Name of the buyer examples: - Microsoft logo_url: type: string description: URL to the buyer's logo examples: - https://assets.cnaught.com/logos/microsoft.png logo_alt_text: type: - string - 'null' description: Alt text for the buyer's logo examples: - Microsoft logo due_diligence_figure: type: - object - 'null' description: Figure illustrating due diligence information properties: description: type: string description: Description of the due diligence figure examples: - This chart shows the verification process... image_url: type: string description: URL to the due diligence figure image examples: - https://assets.cnaught.com/figures/due-diligence.png image_alt_text: type: - string - 'null' description: Alt text for the due diligence figure image examples: - Due diligence verification process diagram news_articles: type: - array - 'null' description: List of news articles related to the project items: type: object properties: title: type: string description: Title of the news article examples: - New Carbon Capture Project Launched url: type: string description: URL to the news article examples: - https://example.com/news/carbon-capture author: type: string description: Author of the news article examples: - John Smith published_on: type: string format: date-time description: Publication date of the news article examples: - '2023-01-15T00:00:00Z' cnaught_take: type: - string - 'null' description: CNaught's perspective on the news article examples: - This article highlights the importance of... responses: Unauthorized: description: Request Unauthorized content: application/problem+json: schema: properties: title: type: string description: Short, human-readable summary of the problem type status: type: integer description: HTTP status code of the error example: title: Authorization has been denied for this request status: 401 PortfolioNotFound: description: Portfolio Not Found content: application/problem+json: schema: $ref: '#/components/schemas/BaseProblemDetails' example: type: https://api.cnaught.com/v1/errors/not-found title: Could not find portfolio status: 404 securitySchemes: ApiKey: type: http scheme: bearer ````