List bundles
HTTPGET
to /v1/bundles
Query parameters
limitstring
Pattern: ^\d+$
Maximum number of resources to return, between 1 and 100.
afterstring
A cursor for use in pagination.
The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.
recently_disabledstring
When recently_disabled
is set to true, the response will also include bundles which have been disabled in the last 30 days.
Response
has_morebooleanrequired
Whether or not there are more elements available after this set.
If false, this set comprises the end of the array.
Part of a paginated response.
next_cursorstringrequirednullable
The cursor value to be used as the after parameter for fetching the next page of results.
null
if has_more
is false
.
dataarrayrequired
An array of Bundle objects.
Part of a paginated response.
object
Group of projects of similar price and characteristics.
Orders are placed against bundles.
idstringrequired
The bundle's unique identifier
namestringrequired
The bundle's name
unit_pricestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Bundle unit price per tonne CO2
gross_unit_pricestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Bundle unit price per tonne CO2 inclusive of fees
currencystringrequired
Currency code
background_colourstringrequirednullable
A bundle's background colour in hexadecimal format
primary_imagestringrequirednullable
A bundle's image URL
large_imagestringnullable
A bundle's larger image URL
primary_image_hiresstringrequirednullable
A bundle's high resolution image URL
small_thumbnailstringrequirednullable
A bundle's small thumbnail image URL
descriptionstringrequirednullable
The bundle's description
disabledbooleanrequired
Disabled bundles do not accept orders
available_quantitystringrequirednullable
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets available to purchase (in tonnes).
If available_quantity is null, assume there is an unlimited amount of offsets to purchase.
offset_typestringrequirednullable
Offset type classification
emissions_reduction
carbon_removal
approachstringrequirednullable
Bundle approach
traditional
innovative
carbon_permanencestringrequired
The bundle's carbon storage permanence.
long_term
short_term
no_storage
projectsarrayrequired
An array of Project objects that belong to the bundle.
object
idstringrequired
The projects's unique identifier
namestringrequired
The project's name
short_namestringrequired
The project's short name. May coincide with name.
slugstringrequired
Project slug
descriptionstringrequired
Project description
project_typestringrequired
The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture
registry_namestringrequired
The project's Verification Standard Entity name or equivalent organization.
American Carbon Registry
Verra
Puro.earth
Gold Standard
Climate Action Reserve
registry_linkstringrequirednullable
A link to the registry's project details page.
latitudenumber (float)required
Latitude
longitudenumber (float)required
Logitude
country_namestringrequired
The project's country
country_codestringrequired
The project's 3 character country code
regionstringrequirednullable
The project's region
logostringrequirednullable
A project logo image URL
primary_imagestringrequirednullable
A project image URL
thumbnail_imagestringrequirednullable
A project thumbnail image URL
resultsarrayrequirednullable
Project results
string
un_sdgarrayrequirednullable
UN Sustainable Development Goals.
Each number in the array represent one UN Sustainable Development Goal. See https://sdgs.un.org/goals.
number
disabledbooleanrequired
Disabled projects do not get allocated to orders
mediaarrayrequired
A list of images and videos belonging to the project.
object
typestringrequired
The type of the media item
image
video
urlstringrequired
The URL of the media item
attribution_textstringrequirednullable
A short description of where the image or video was sourced
attribution_urlstringrequirednullable
A URL pointing to where the image or video was sourced
crediting_start_datestring (date)requirednullable
Project’s crediting period start date.
crediting_end_datestring (date)requirednullable
Project’s crediting period end date.
registration_datestring (date)requirednullable
Date the project was registered in the registry.
protocolarrayrequirednullable
The standard followed to assure that a carbon offset project delivers on carbon reduction or removal.
string
methodologystringrequirednullable
Detailed application of the broader principles set out in the protocol.
durabilitystringrequirednullable
Expected duration of the carbon storage (carbon removal projects only).
additional_standards_metarrayrequirednullable
Any additional standards the project meets.
string
verifying_bodystringrequirednullable
Independent entity assessing compliance of carbon projects with protocol and methodology.
risk_of_reversalstringrequirednullable
Mitigation plan for the risk of reversal.
risk_of_predicted_emissionsstringrequirednullable
Mitigation plan for the risk of predicted reductions or removals not occurring.
avg_annual_emission_reductionsstringrequirednullable
Pattern: ^[0-9]+(\.[0-9]+)?$
Estimated average annual reductions or removals.
Errors
This API operation can return the following errors:400
api_version_invalid
400
bundle_selection_ratios_invalid
400
bundle_selection_bundle_invalid
400
order_value_invalid
400
bundle_id_invalid
400
id_invalid
400
distance_invalid
400
test_account_name_update_disallowed
400
bundle_selection_ratios_invalid_format
400
address_not_found
Get a bundle
HTTPGET
to /v1/bundles/{id}
Query parameters
idstringrequired
The bundle's unique identifier
Response
Group of projects of similar price and characteristics.
Orders are placed against bundles.
idstringrequired
The bundle's unique identifier
namestringrequired
The bundle's name
unit_pricestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Bundle unit price per tonne CO2
gross_unit_pricestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Bundle unit price per tonne CO2 inclusive of fees
currencystringrequired
Currency code
background_colourstringrequirednullable
A bundle's background colour in hexadecimal format
primary_imagestringrequirednullable
A bundle's image URL
large_imagestringnullable
A bundle's larger image URL
primary_image_hiresstringrequirednullable
A bundle's high resolution image URL
small_thumbnailstringrequirednullable
A bundle's small thumbnail image URL
descriptionstringrequirednullable
The bundle's description
disabledbooleanrequired
Disabled bundles do not accept orders
available_quantitystringrequirednullable
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets available to purchase (in tonnes).
If available_quantity is null, assume there is an unlimited amount of offsets to purchase.
offset_typestringrequirednullable
Offset type classification
emissions_reduction
carbon_removal
approachstringrequirednullable
Bundle approach
traditional
innovative
carbon_permanencestringrequired
The bundle's carbon storage permanence.
long_term
short_term
no_storage
projectsarrayrequired
An array of Project objects that belong to the bundle.
object
idstringrequired
The projects's unique identifier
namestringrequired
The project's name
short_namestringrequired
The project's short name. May coincide with name.
slugstringrequired
Project slug
descriptionstringrequired
Project description
project_typestringrequired
The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture
registry_namestringrequired
The project's Verification Standard Entity name or equivalent organization.
American Carbon Registry
Verra
Puro.earth
Gold Standard
Climate Action Reserve
registry_linkstringrequirednullable
A link to the registry's project details page.
latitudenumber (float)required
Latitude
longitudenumber (float)required
Logitude
country_namestringrequired
The project's country
country_codestringrequired
The project's 3 character country code
regionstringrequirednullable
The project's region
logostringrequirednullable
A project logo image URL
primary_imagestringrequirednullable
A project image URL
thumbnail_imagestringrequirednullable
A project thumbnail image URL
resultsarrayrequirednullable
Project results
string
un_sdgarrayrequirednullable
UN Sustainable Development Goals.
Each number in the array represent one UN Sustainable Development Goal. See https://sdgs.un.org/goals.
number
disabledbooleanrequired
Disabled projects do not get allocated to orders
mediaarrayrequired
A list of images and videos belonging to the project.
object
typestringrequired
The type of the media item
image
video
urlstringrequired
The URL of the media item
attribution_textstringrequirednullable
A short description of where the image or video was sourced
attribution_urlstringrequirednullable
A URL pointing to where the image or video was sourced
crediting_start_datestring (date)requirednullable
Project’s crediting period start date.
crediting_end_datestring (date)requirednullable
Project’s crediting period end date.
registration_datestring (date)requirednullable
Date the project was registered in the registry.
protocolarrayrequirednullable
The standard followed to assure that a carbon offset project delivers on carbon reduction or removal.
string
methodologystringrequirednullable
Detailed application of the broader principles set out in the protocol.
durabilitystringrequirednullable
Expected duration of the carbon storage (carbon removal projects only).
additional_standards_metarrayrequirednullable
Any additional standards the project meets.
string
verifying_bodystringrequirednullable
Independent entity assessing compliance of carbon projects with protocol and methodology.
risk_of_reversalstringrequirednullable
Mitigation plan for the risk of reversal.
risk_of_predicted_emissionsstringrequirednullable
Mitigation plan for the risk of predicted reductions or removals not occurring.
avg_annual_emission_reductionsstringrequirednullable
Pattern: ^[0-9]+(\.[0-9]+)?$
Estimated average annual reductions or removals.
Errors
This API operation can return the following errors:404
429