CNaught API home page

Get Started
Pricing
Sign In
Get Started

Portfolios

Get Portfolio By Id

Documentation

API Reference

SDKs

API Documentation

Overview

Orders

GET
Get List of Orders
POST
Create Carbon Credits Order
POST
Create Carbon Credits Order for Vehicle Ride
GET
Get Order By Id
POST
Cancel Order

Quotes

POST
Get Quote by Emissions Mass
POST
Get Quote for Air Freight Emissions
POST
Get Quote for Flight Emissions
POST
Get Quote for Ground Freight Emissions
POST
Get Quote for Ground Transport Emissions
POST
Get Quote for Office Space Emissions
POST
Get Quote for Train Emissions
POST
Get Vehicle Ride Credits Price Quote

Subaccounts

GET
Get List of Subaccounts
POST
Create Subaccount
GET
Get Subaccount By Id
PUT
Update Subaccount
PUT
Update Subaccount Logo By Uploading Image Content
POST
Update Subaccount Logo From URL
DEL
Remove Logo From Subaccount

Checkout Sessions

POST
Create Checkout Session
GET
Get Checkout Session

Climate Impact

GET
Get Climate Impact Data
GET
Get Hosted Climate Impact Page Configuration

Projects

GET
Get Project By Id
GET
Get Project Category By Id

Portfolios

GET
Get List of Portfolios
GET
Get Portfolio By Id

Portfolios

Get Portfolio By Id

Returns information about a portfolio, including the project categories that comprise the portfolio.

GET

portfolios

{id}

Authorization

string

Bearer

Authorization

Required

string

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

string

Required

string

ID of the portfolio to return

Add Example Value

Authorizations

Authorization

string

headerrequired

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

Path Parameters

string

required

ID of the portfolio to return

Response

200 - application/json

Details about a portfolio, including the allocations of the portfolio to project categories.

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

projects

object[]

The list of project category allocations in the portfolio.

projects.category

object

Details of the project category

projects.category.id

string

Identifier that can be used to retrieve the project category details.

projects.category.name

string

Name of the project category

projects.category.description

string

Description of the project category

projects.category.primary_image_url

string | null

URL of the primary image for the project category

projects.category.projects

object[]

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.

projects.category.projects.id

string

Identifier that can be used to retrieve the project details

projects.category.projects.name

string

Name of the project

projects.category.projects.summary

string | null

A short summary of the project

projects.category.projects.description

string | null

A longer description of the project

projects.category.projects.type

string

Type of project, eg Afforrestation, Renewable Energy, etc

projects.category.projects.developer

string | null

The name of the company or organization sponsoring the project

projects.category.projects.registry_name

string | null

The name of the registry on which the project's credits are registered

projects.category.projects.registry_id

string | null

The id of the project within the registry

projects.category.projects.registry_url

string | null

The full url to the project's documentation on the registry website

projects.category.projects.location_name

string | null

Location of the project

projects.category.projects.location_latitude

number | null

Latitude for the location of the project

projects.category.projects.location_longitude

number | null

Longitude for the location of the project

projects.category.projects.primary_image_url

string | null

URL for the primary image of the project

projects.category.projects.un_sdg_goals

number[]

list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals

projects.allocated_fraction

number

Fraction of the portfolio (from 0 to 1) allocated to the project category

Get List of Portfolios

x github linkedin website