Orders

Endpoints for placing orders and retrieving information about orders

Get List of Orders

Gets a list of orders in reverse chronological order up to the provided limit number of orders per call. Pagination is supported by passing the first order id from a previous call into ending_before to retrieve the previous page, or the last order id from a previous call into starting_after to retrieve the next page.

SecurityApiKey
Request
query Parameters
limit
integer or null [ 1 .. 100 ]
Default: 20

Limits the number of orders returned, default is 20, max is 100

starting_after
string or null

If specified, returns orders submitted before (earlier than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

ending_before
string or null

If specified, returns orders submitted after (later than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

header Parameters
X-Subaccount-Id
string

If present, only returns orders belonging to the subaccount with given id.

Responses
200

List of orders

400

Bad Request

401

Request Unauthorized

get/orders
Request samples 
Response samples 
application/json
{}
Create Carbon Credits Order
Places an order for the specified amount of carbon credits (in kilograms), or for the specified total price (in USD cents).
The order will remain in the placed state until it can be matched to available credits,
after which the order will be fulfilled and moved to the fulfilled state.
If specifying total price, we will determine the amount of carbon credits based on the unit price of the portfolio used for the order.
Because the amount must be an integer number of kilograms, the final actual total price might be slightly different than the specified total price.        


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, the new order will be associated with the subaccount with given id.


 
Idempotency-Key
string
If present, a unique identifier that allows you to retry a request multiple times while only performing the action once.
See Idempotency for more info.


 
Request Body schema: application/json
required
Order Parameters


One of:
Details for a generic order request that specifies credits amount (in kg of CO2)


amount_kg
required
number
The amount of credits to purchase, in kg of CO2. Must be a positive integer.
Exactly one of amount_kg or total_price_usd_cents must be provided.


 
metadata
string or null  <= 512 characters 
Optional metadata that can be provided with the order. Not shown on the certificate, and is intended for API clients to attach arbitrary metadata that can be retrieved with the order.


 
description
string or null  <= 512 characters 
Optional public description for the order that will be shown on the certificate


 
object or null
Optional configuration for a callback url to invoke with updates
when the status of an order changes.


 
portfolio_id
string or null
Optional ID of the portfolio to use for fulfilling the order. If not specified, the account's default portfolio will be used.


 
Responses 
201
Order Details


400
Bad Request


401
Request Unauthorized


403
Forbidden - Billing Not Set Up or Requested Portfolio not Available for the User


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


post/orders
Request samples 
application/json
{}
Response samples 
application/json
{
  • "id": "Gre28Fc35bt3",
  • "order_number": "47726-53238-46633-33562-7433",
  • "amount_kg": 100,
  • "metadata": "Customer metadata",
  • "price_usd_cents": 2350
}
Create Carbon Credits Order for Vehicle RideDeprecated
[Deprecated] Use /quotes/ground-transport with passenger_car_van_or_suv as the vehicle_type to calculate ride emissions.
Then pass the result to /orders to place the order.



Places an order for carbon credits for a vehicle ride of the given distance (in kilometers).
The order will remain in the placed state until it can be matched to available credits,
after which the order will be fulfilled and moved to the fulfilled state.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, the new order will be associated with the subaccount with given id.


 
Idempotency-Key
string
If present, a unique identifier that allows you to retry a request multiple times while only performing the action once.
See Idempotency for more info.


 
Request Body schema: application/json
required
Order Parameters


metadata
string or null  <= 512 characters 
Optional metadata that can be provided with the order. Not shown on the certificate, and is intended for API clients to attach arbitrary metadata that can be retrieved with the order.


 
description
string or null  <= 512 characters 
Optional public description for the order that will be shown on the certificate


 
object or null
Optional configuration for a callback url to invoke with updates
when the status of an order changes.


 
portfolio_id
string or null
Optional ID of the portfolio to use for fulfilling the order. If not specified, the account's default portfolio will be used.


 
distance_km
required
number
Distance of ride, in km


 
Responses 
201
Order Details


400
Bad Request


401
Request Unauthorized


403
Forbidden - Billing Not Set Up or Requested Portfolio not Available for the User


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


post/orders/ride
Request samples 
application/json
{}
Response samples 
application/json
{
  • "id": "XYZ",
  • "metadata": "Customer metadata",
  • "amount_kg": 15,
  • "price_usd_cents": 2350,
  • "state": "placed"
}
Get Order By Id
Returns information about an order


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of order to return


 
header Parameters
X-Subaccount-Id
string
If present, will only retrieve the order if it belongs to the subaccount with given id.


 
Responses 
200
Order Details


401
Request Unauthorized


404
Order Not Found


get/orders/{id}
Request samples 
Response samples 
application/json
{
  • "id": "Gre28Fc35bt3",
  • "order_number": "47726-53238-46633-33562-7433",
  • "created_on": "2022-08-01T18:00:00.000000Z",
  • "metadata": "Customer metadata",
  • "description": "On behalf of Jane Smith",
  • "amount_kg": 10.5,
  • "state": "placed",
  • "price_usd_cents": 2350
}
Cancel Order
When cancelling an order that has been fulfilled, a credit for the price of the order
will be applied to the current invoice. This means that it is possible for the credit
for a cancellation to appear on the invoice of the following billing period.
For example, if a billing period ends between when the order was placed and when it
is cancelled, then the credit will be applied to the latter billing period rather
than the one during which the order was placed.


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of order to cancel


 
header Parameters
X-Subaccount-Id
string
If present, will only cancel the order if it belongs to the subaccount with given id.


 
Idempotency-Key
string
If present, a unique identifier that allows you to retry a request multiple times while only performing the action once.
See Idempotency for more info.


 
Responses 
200
Order Details


401
Request Unauthorized


403
Forbidden Due to Order Already Cancelled


404
Order Not Found


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


post/orders/{id}/cancel
Request samples 
Response samples 
application/json
{
  • "id": "Gre28Fc35bt3",
  • "order_number": "47726-53238-46633-33562-7433",
  • "created_on": "2022-08-01T18:00:00.000000Z",
  • "metadata": "Customer metadata",
  • "description": "On behalf of Jane Smith",
  • "amount_kg": 10.5,
  • "state": "cancelled",
  • "price_usd_cents": 2350,
  • "certificate_public_url": null,
  • "certificate_download_public_url": null
}
Create Checkout Session
Creates a Checkout Session that, when completed, will result in an order
for the specified amount of carbon credits (in kilograms). The total price
must be at least $0.50 (the corresponding amount will depend on the per kg
price of the specified portfolio). The Quotes API can be used to check the
price before attempting to create a session.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
required
string
The Subaccount the Checkout Session will create an order for when successfully completed


 
Request Body schema: application/json
required
Checkout Session Parameters


email
required
string
Email of the customer


 
amount_kg
required
number
Amount of carbon credits to be purchased upon checkout completion, in kilograms


 
success_url
required
string
The URL the customer will be redirected to after the payment is completed. The {CHECKOUT_SESSION_ID}
template can be used to include the session id in a query parameter. Make sure to include the template
exactly as {CHECKOUT_SESSION_ID} (i.e. do not replace it with the actual session id).


 
cancel_url
required
string
The URL the customer will be directed to if they decide to cancel payment and return to your website


 
portfolio_id
string or null
Optional id of the portfolio to use for fulfilling the order resulting from the Checkout Session.
If not specified, the subaccount's default portfolio will be used.


 
description
string or null  <= 512 characters 
Optional public description for the order that will be shown on the certificate, as provided when order was placed


 
object or null
Optional configuration for a callback url to invoke with updates
when the status of an order changes.


 
Responses 
201
Checkout Session


400
Bad Request


401
Request Unauthorized


post/orders/checkout-session
Request samples 
application/json
{}
Response samples 
application/json
{}
Get Checkout Session
Returns the Checkout Session with the given id


SecurityApiKey 
Request 
path Parameters
id
required
string
Id of the Checkout Session to retrieve


 
Responses 
200
Checkout Session


401
Request Unauthorized


404
Checkout Session Not Found


get/orders/checkout-session/{id}
Request samples 
Response samples 
application/json
{}
Quotes
Endpoints for obtaining price quotes for orders


Get Quote by Emissions Mass
Get a price quote for offsetting the given amount of carbon emissions.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


amount_kg
required
number
Amount of CO2 emissions, in kg


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes
Request samples 
application/json
{
  • "amount_kg": 8.5
}
Response samples 
application/json
{
  • "amount_kg": 8.5,
  • "price_usd_cents": 10
}
Get Quote for Air Freight Emissions
Get a price quote for offsetting air freight shipment carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


freight_mass_kg
required
number
Mass of freight, in kg


 
distance_km
required
number
Distance of air freight shipment, in km


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/air-freight
Request samples 
application/json
{
  • "freight_mass_kg": 100,
  • "distance_km": 10.5
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Quote for Flight Emissions
Get a price quote for offsetting flight carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


distance_km
required
number
Distance of flight, in km


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/flight
Request samples 
application/json
{
  • "distance_km": 500.5
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Quote for Ground Freight Emissions
Get a price quote for offsetting ground freight shipment carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


freight_mass_kg
required
number
Mass of freight, in kg


 
distance_km
required
number
Distance of ground freight shipment, in km


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/ground-freight
Request samples 
application/json
{
  • "freight_mass_kg": 100,
  • "distance_km": 10.5
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Quote for Ground Transport Emissions
Get a price quote for offsetting ground transportation carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


distance_km
required
number
Distance of ground transportation, in km


 
vehicle_type
required
string
The type of vehicle used. Must be one of passenger_car_van_or_suv, small_bus, school_bus, or coach_bus.


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/ground-transport
Request samples 
application/json
{
  • "distance_km": 500.5,
  • "vehicle_type": "school_bus"
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Quote for Office Space Emissions
Get a price quote for offsetting office space carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


square_footage
required
number
Square footage of the office space, in ft2


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/office-space
Request samples 
application/json
{
  • "square_footage": 1500.25
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Quote for Train Emissions
Get a price quote for offsetting train carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


distance_km
required
number
Distance of train ride, in km


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/train
Request samples 
application/json
{
  • "distance_km": 500.5
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Get Vehicle Ride Credits Price QuoteDeprecated
[Deprecated] Use /orders/ground-transportation and pass passenger_car_van_or_suv as the vehicle_type.



Get a price quote for offsetting car ride carbon emissions.
Will return the amount of CO2e to offset and total price.


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will use pricing appropriate for the subaccount with given id.


 
Request Body schema: application/json
required
Quote Parameters


distance_km
required
number
Distance of ride, in km


 
portfolio_id
string or null
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.


 
Responses 
200
Quote Details


400
Bad Request


401
Request Unauthorized


post/quotes/ride
Request samples 
application/json
{
  • "distance_km": 10.5
}
Response samples 
application/json
{
  • "amount_kg": 15,
  • "price_usd_cents": 2350
}
Climate Impact
Endpoints for retrieving climate impact data and hosted public impact page configuration


Get Climate Impact Data
Returns information about the total climate impact of the carbon credit purchases for this account (or a subaccount).
This is the underlying information that is displayed on the hosted public impact page for the account / subaccount.
You can optionally use the 'from' and/or 'to' query parameters to only show impact for orders in a particular time period.


SecurityApiKey 
Request 
query Parameters
from
string or null
Optionally specifies the start of the time period of orders to include in the impact calculation. 
If omitted, then orders starting from account creation are included.
If present, must be a date in ISO 8601 format.


 
 Example:  from=2023-09-15T13:45:30.1245658Z
to
string or null
Optionally specifies the end of the time period of orders to include in the impact calculation. 
If omitted, then orders up to the present time are included.
If present, must be a date in ISO 8601 format.


 
 Example:  to=2023-09-15T13:45:30.1245658Z
header Parameters
X-Subaccount-Id
string
If present, will only include orders for the subaccount with given id when calculating total impact.


 
Responses 
200
Impact Data


401
Request Unauthorized


get/impact/data
Request samples 
Response samples 
application/json
{
  • "name": "Acme, Inc",
  • "logo_url": "https://customer-assets.cnaught.com/fe0df075-30e2-4e58-9feb-154e72a9205f/company_logo.png",
  • "total_offset_kgs": 100000,
  • "equivalents": {
    },
  • "since_date": "2023-01-01T18:00:00.000000Z",
  • "categories": [
    ]
}
Get Hosted Climate Impact Page Configuration
Returns information about the hosted public climate impact page configuration for the account (or a subaccount)


SecurityApiKey 
Request 
header Parameters
X-Subaccount-Id
string
If present, will return configuration for the hosted impact subaccount.


 
Responses 
200
Impact Hosted Page Configuration


401
Request Unauthorized


get/impact/hosted-page-config
Request samples 
Response samples 
application/json
{}
Subaccounts
Endpoints for creating and retrieving information about subaccounts


Get List of Subaccounts
Gets a list of subaccounts in reverse chronological order up to the provided limit number of subaccounts per call.
Pagination is supported by passing the first subaccount id from a previous call into ending_before to retrieve
the previous page, or the last subaccount id from a previous call into starting_after to retrieve the next page.


SecurityApiKey 
Request 
query Parameters
limit
integer or null  [ 1 .. 100 ] 
 Default:  20
Limits the number of subaccounts returned, default is 20, max is 100


 
starting_after
string or null
If specified, returns subaccounts created before (earlier than) the subaccount with this id, exclusive (subaccount with this id is not included). Only one of starting_after and ending_before can be specified.


 
ending_before
string or null
If specified, returns subaccounts created after (later than) the order with this id, exclusive (subaccount with this id is not included). Only one of starting_after and ending_before can be specified.


 
Responses 
200
List of Subaccounts


400
Bad Request


401
Request Unauthorized


get/subaccounts
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
Create Subaccount
Creates a new Subaccount.


SecurityApiKey 
Request 
header Parameters
Idempotency-Key
string
If present, a unique identifier that allows you to retry a request multiple times while only performing the action once.
See Idempotency for more info.


 
Request Body schema: application/json
required
Subaccount Parameters


name
required
string  <= 512 characters 
Name for the subaccount


 
email
string or null
Optional email associated with the subaccount


 
default_portfolio_id
string or null
Optional ID of the default portfolio to use for fulfilling orders placed for this subaccount. If not specified,
the parent account's default portfolio will be the default portfolio for the subaccount.


 
logo_url
string or null
Optional URL for a logo to use for this subaccount. The URL must be public. 
The logo will be downloaded to CNaught's hosting when creating the account. 
If not specified, the subaccount will not have a logo.


 
Responses 
201
Subaccount Details


400
Invalid default portfolio ID


401
Request Unauthorized


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


post/subaccounts
Request samples 
application/json
{
  • "name": "Marketing Department",
  • "email": "jane.doe@example.com",
  • "default_portfolio_id": "mHvNvWbq"
}
Response samples 
application/json
{}
Get Subaccount By Id
Returns information about a subaccount


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of subaccount to return / modify


 
Responses 
200
Subaccount Details


401
Request Unauthorized


404
Subaccount Not Found


get/subaccounts/{id}
Request samples 
Response samples 
application/json
{}
Update Subaccount
Updates a Subaccount with given id. 
This does not include updating the logo: there are separate endpoints for doing so.
Aside from the logo, all properties should be included in the request body.
Not including the default portfolio id in the update request will have the effect of making the subaccount not
have an explicit default portfolio (making it inherit the default portfolio from the parent user).


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of subaccount to return / modify


 
Request Body schema: application/json
required
Subaccount Update Parameters


name
required
string  <= 512 characters 
Name for the subaccount


 
email
string or null
Optional email associated with the subaccount. If not specified, will remove the email
from the subaccount.


 
default_portfolio_id
string or null
Optional ID of the default portfolio to use for fulfilling orders placed for this subaccount. If not specified,
the parent account's default portfolio will be the default portfolio for the subaccount.


 
Responses 
200
Subaccount Details after update


400
Invalid default portfolio ID


401
Request Unauthorized


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


put/subaccounts/{id}
Request samples 
application/json
{
  • "name": "Operations Department",
  • "email": "jane.doe@example.com",
  • "default_portfolio_id": "eWvNvC12"
}
Response samples 
application/json
{}
Update Subaccount Logo From URL
Updates the logo for a Subaccount with given id by downloading from given URL. 
The URL should point to a valid image in a supported image format, and should include
the content type for the image in the HTTP response when the image is retrieved from the URL.
Supported image types are: PNG (image/png), JPEG (image/jpeg), WEBP (image/webp), and SVG (image/svg+xml).


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of subaccount to modify logo for


 
Request Body schema: application/json
required
Subaccount Update Logo From URL Parameters


logo_url
required
string
URL for a logo to set for this subaccount. The URL must be public. The logo will be downloaded to CNaught's hosting.


 
Responses 
200
Subaccount Details after update


401
Request Unauthorized


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


post/subaccounts/{id}/logo
Request samples 
application/json
{}
Response samples 
application/json
{}
Update Subaccount Logo By Uploading Image Content
Updates the logo for a Subaccount with given id with the image contents sent in the request body.
The request body should be the binary image contents in a supported image format, and the request
should include a Content-Type header specifying the image content type.
Supported image types are: PNG (image/png), JPEG (image/jpeg), WEBP (image/webp), and SVG (image/svg+xml).


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of subaccount to modify logo for


 
header Parameters
Content-Type
required
string
The content type for the image being uploaded. Must be a supported image type (see description for list of valid types)


 Enum: "image/png" "image/jpeg" "image/webp" "image/svg+xml"  
Request Body schema: 
required
Subaccount Logo Image Content


string <binary> 
 
Responses 
200
Subaccount Details after update


401
Request Unauthorized


409
Concurrent Requests with Same Idempotency Key


422
Mismatched Requests with Same Idempotency Key


put/subaccounts/{id}/logo
Request samples 
Response samples 
application/json
{}
Projects
Get Project By Id
Returns information about a project


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of the project to return


 
Responses 
200
Project Details


401
Request Unauthorized


404
Project Not Found


get/projects/{id}
Request samples 
Response samples 
application/json
{
  • "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": [ ]
}
Get Project Category By Id
Returns information about a project category


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of the project category to return


 
Responses 
200
Project Catetgory Details


401
Request Unauthorized


404
Category Not Found


get/project-categories/{id}
Request samples 
Response samples 
application/json
{}
Portfolios
Get List of Portfolios
Gets the list of portfolios the user is able to use for purchasing credits. This list is not paginated - the full list of portfolios is returned.
The portfolio objects in the list do not include details about the project categories comprising the portfolio - those can be retrieved
for each portfolio using the Get Portfolio By Id API endpoint.


SecurityApiKey 
Responses 
200
List of Portfolios


401
Request Unauthorized


get/portfolios
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
Get Portfolio By Id
Returns information about a portfolio, including the project categories that comprise the portfolio.


SecurityApiKey 
Request 
path Parameters
id
required
string
ID of the portfolio to return


 
Responses 
200
Portfolio Details


401
Request Unauthorized


404
Portfolio Not Found


get/portfolios/{id}
Request samples 
Response samples 
application/json
{
  • "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",
  • "category_allocations": [
    ]
}