Lune Docs Logo

Multi-leg shipments
Sea shipments
Vessel tracking
Road shipments
Air shipments

Transactions

Dashboard

Logistics analytics

Spend management analytics

Carbon credits

Accounts

Emission calculations

Logistics methodology

Carbon credit orders

Authentication
Pagination

General
Single leg

By transaction details
By document

Company
Electricity
Flight
Passenger transportation
Raw emission factor

Emission factors

Analytics
Sustainability pages

Quotes
Orders
Carbon certificates

Projects
Project bundles
Bundle selections
Bundle portfolios
Payments

Accounts
Client accounts

Webhook

Projects

List projects

HTTP GET to /v1/projects
Query parameters

Pattern: ^\d+$

Maximum number of resources to return, between 1 and 100.

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.

When recently_disabled is set to true, the response will also include projects which have been disabled in the last 30 days.

Response

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.

The cursor value to be used as the after parameter for fetching the next page of results.

null if has_more is false.

An array of Project objects.

Part of a paginated response.

A Project represents the entity which issues carbon credits because of its environmental activity which reduces, avoids, or removes emissions from the atmosphere.

Clients cannot purchase a specific Project's credits by creating an order. A Project's credits are allocated to an order if the order has purchased a project bundle the project belongs to.

The projects's unique identifier

The project's name

The project's short name. May coincide with name.

Project slug

Project description

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

The project's Verification Standard Entity name or equivalent organization.

American Carbon Registry
Verra
Puro.earth
Gold Standard
Climate Action Reserve

A link to the registry's project details page.

Latitude

Logitude

The project's country

The project's 3 character country code

The project's region

A project logo image URL

A project image URL

A project thumbnail image URL

Project results

UN Sustainable Development Goals.

Each number in the array represent one UN Sustainable Development Goal. See https://sdgs.un.org/goals.

Disabled projects do not get allocated to orders

A list of images and videos belonging to the project.

The type of the media item

image
video

The URL of the media item

A short description of where the image or video was sourced

A URL pointing to where the image or video was sourced

Project’s crediting period start date.

Project’s crediting period end date.

Date the project was registered in the registry.

The standard followed to assure that a carbon offset project delivers on carbon reduction or removal.

Detailed application of the broader principles set out in the protocol.

Expected duration of the carbon storage (carbon removal projects only).

Any additional standards the project meets.

Independent entity assessing compliance of carbon projects with protocol and methodology.

Mitigation plan for the risk of reversal.

Mitigation plan for the risk of predicted reductions or removals not occurring.

Pattern: ^[0-9]+(\.[0-9]+)?$

Estimated average annual reductions or removals.

An array of Bundle objects the project is part of.

The bundle's unique identifier

The bundle's name

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2 inclusive of fees

Currency code

A bundle's background colour in hexadecimal format

A bundle's image URL

A bundle's larger image URL

A bundle's high resolution image URL

A bundle's small thumbnail image URL

The bundle's description

Disabled bundles do not accept orders

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 type classification

emissions_reduction
carbon_removal

Bundle approach

traditional
innovative

The bundle's carbon storage permanence.

long_term
short_term
no_storage

The items of the array are ordered exactly as they're meant to be used.

A null value means there's no data or the section is disabled.

MUI icon name

A short piece of text to go with the icon

Datasets available for the project.

For instance Forest loss or Biodiversity.

Dataset's name.

Project specific commentary regarding the dataset.

Project specific thumbnail URL regarding the dataset.

The way the project relates to every of the five Project Quality Assessment categories.

A null value means there's no data or the section is disabled.

A null value means there's no data or the section is disabled.

The order of the array is how the elements are meant to be used.

The order of the array is how the elements are meant to be used.

A null value means there's no data or the section is disabled. Note that availability can be missing data or be disabled separately.

ex_post
ex_ante
pre_purchase

instant
near_term
future

What's available for sale.

A null value means there's no data or the section is disabled.

The array is ordered newest to oldest (per the year property).

This is an opaque string and you may not interpret it in any way.

In tonnes.

Pattern: ^[0-9]+(\.[0-9]+)?$

An amount of money (the fractional part is optional)

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED
AFN
ALL
AMD
ANG

The array order is newest to oldest.

A null value means there's no data or the section is disabled.

The order of the array is oldest to newest (per the year property).

A null value means there's no data or the section is disabled.

The values (except for year, of course) are in tonnes.

Errors
This API operation can return the following errors:
HTTP status codeError code
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 project

HTTP GET to /v1/projects/{id}
Query parameters

The project's unique identifier

Response

A Project represents the entity which issues carbon credits because of its environmental activity which reduces, avoids, or removes emissions from the atmosphere.

Clients cannot purchase a specific Project's credits by creating an order. A Project's credits are allocated to an order if the order has purchased a project bundle the project belongs to.

The projects's unique identifier

The project's name

The project's short name. May coincide with name.

Project slug

Project description

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

The project's Verification Standard Entity name or equivalent organization.

American Carbon Registry
Verra
Puro.earth
Gold Standard
Climate Action Reserve

A link to the registry's project details page.

Latitude

Logitude

The project's country

The project's 3 character country code

The project's region

A project logo image URL

A project image URL

A project thumbnail image URL

Project results

UN Sustainable Development Goals.

Each number in the array represent one UN Sustainable Development Goal. See https://sdgs.un.org/goals.

Disabled projects do not get allocated to orders

A list of images and videos belonging to the project.

The type of the media item

image
video

The URL of the media item

A short description of where the image or video was sourced

A URL pointing to where the image or video was sourced

Project’s crediting period start date.

Project’s crediting period end date.

Date the project was registered in the registry.

The standard followed to assure that a carbon offset project delivers on carbon reduction or removal.

Detailed application of the broader principles set out in the protocol.

Expected duration of the carbon storage (carbon removal projects only).

Any additional standards the project meets.

Independent entity assessing compliance of carbon projects with protocol and methodology.

Mitigation plan for the risk of reversal.

Mitigation plan for the risk of predicted reductions or removals not occurring.

Pattern: ^[0-9]+(\.[0-9]+)?$

Estimated average annual reductions or removals.

An array of Bundle objects the project is part of.

The bundle's unique identifier

The bundle's name

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2 inclusive of fees

Currency code

A bundle's background colour in hexadecimal format

A bundle's image URL

A bundle's larger image URL

A bundle's high resolution image URL

A bundle's small thumbnail image URL

The bundle's description

Disabled bundles do not accept orders

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 type classification

emissions_reduction
carbon_removal

Bundle approach

traditional
innovative

The bundle's carbon storage permanence.

long_term
short_term
no_storage

The items of the array are ordered exactly as they're meant to be used.

A null value means there's no data or the section is disabled.

MUI icon name

A short piece of text to go with the icon

Datasets available for the project.

For instance Forest loss or Biodiversity.

Dataset's name.

Project specific commentary regarding the dataset.

Project specific thumbnail URL regarding the dataset.

The way the project relates to every of the five Project Quality Assessment categories.

A null value means there's no data or the section is disabled.

A null value means there's no data or the section is disabled.

The order of the array is how the elements are meant to be used.

The order of the array is how the elements are meant to be used.

A null value means there's no data or the section is disabled. Note that availability can be missing data or be disabled separately.

ex_post
ex_ante
pre_purchase

instant
near_term
future

What's available for sale.

A null value means there's no data or the section is disabled.

The array is ordered newest to oldest (per the year property).

This is an opaque string and you may not interpret it in any way.

In tonnes.

Pattern: ^[0-9]+(\.[0-9]+)?$

An amount of money (the fractional part is optional)

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED
AFN
ALL
AMD
ANG

The array order is newest to oldest.

A null value means there's no data or the section is disabled.

The order of the array is oldest to newest (per the year property).

A null value means there's no data or the section is disabled.

The values (except for year, of course) are in tonnes.

Errors
This API operation can return the following errors:
HTTP status codeError code
404
429

Get a project's perimeter

HTTP GET to /v1/projects/{id}/perimeter
Query parameters

The project's unique identifier

Response

An object containing detailed geographical coordinates outlining a project's perimeter.

Latitude

Longitude

Errors
This API operation can return the following errors:
HTTP status codeError code
404
429

Get a project by slug

HTTP GET to /v1/projects/by-slug/{slug}
Query parameters

The project's unique slug

Response

A Project represents the entity which issues carbon credits because of its environmental activity which reduces, avoids, or removes emissions from the atmosphere.

Clients cannot purchase a specific Project's credits by creating an order. A Project's credits are allocated to an order if the order has purchased a project bundle the project belongs to.

The projects's unique identifier

The project's name

The project's short name. May coincide with name.

Project slug

Project description

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

The project's Verification Standard Entity name or equivalent organization.

American Carbon Registry
Verra
Puro.earth
Gold Standard
Climate Action Reserve

A link to the registry's project details page.

Latitude

Logitude

The project's country

The project's 3 character country code

The project's region

A project logo image URL

A project image URL

A project thumbnail image URL

Project results

UN Sustainable Development Goals.

Each number in the array represent one UN Sustainable Development Goal. See https://sdgs.un.org/goals.

Disabled projects do not get allocated to orders

A list of images and videos belonging to the project.

The type of the media item

image
video

The URL of the media item

A short description of where the image or video was sourced

A URL pointing to where the image or video was sourced

Project’s crediting period start date.

Project’s crediting period end date.

Date the project was registered in the registry.

The standard followed to assure that a carbon offset project delivers on carbon reduction or removal.

Detailed application of the broader principles set out in the protocol.

Expected duration of the carbon storage (carbon removal projects only).

Any additional standards the project meets.

Independent entity assessing compliance of carbon projects with protocol and methodology.

Mitigation plan for the risk of reversal.

Mitigation plan for the risk of predicted reductions or removals not occurring.

Pattern: ^[0-9]+(\.[0-9]+)?$

Estimated average annual reductions or removals.

An array of Bundle objects the project is part of.

The bundle's unique identifier

The bundle's name

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2

Pattern: ^[0-9]+(\.[0-9]+)?$

Bundle unit price per tonne CO2 inclusive of fees

Currency code

A bundle's background colour in hexadecimal format

A bundle's image URL

A bundle's larger image URL

A bundle's high resolution image URL

A bundle's small thumbnail image URL

The bundle's description

Disabled bundles do not accept orders

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 type classification

emissions_reduction
carbon_removal

Bundle approach

traditional
innovative

The bundle's carbon storage permanence.

long_term
short_term
no_storage

The items of the array are ordered exactly as they're meant to be used.

A null value means there's no data or the section is disabled.

MUI icon name

A short piece of text to go with the icon

Datasets available for the project.

For instance Forest loss or Biodiversity.

Dataset's name.

Project specific commentary regarding the dataset.

Project specific thumbnail URL regarding the dataset.

The way the project relates to every of the five Project Quality Assessment categories.

A null value means there's no data or the section is disabled.

A null value means there's no data or the section is disabled.

The order of the array is how the elements are meant to be used.

The order of the array is how the elements are meant to be used.

A null value means there's no data or the section is disabled. Note that availability can be missing data or be disabled separately.

ex_post
ex_ante
pre_purchase

instant
near_term
future

What's available for sale.

A null value means there's no data or the section is disabled.

The array is ordered newest to oldest (per the year property).

This is an opaque string and you may not interpret it in any way.

In tonnes.

Pattern: ^[0-9]+(\.[0-9]+)?$

An amount of money (the fractional part is optional)

ISO 4217 3 character currency code.

Note: Lune supports most but not all currency codes.

AED
AFN
ALL
AMD
ANG

The array order is newest to oldest.

A null value means there's no data or the section is disabled.

The order of the array is oldest to newest (per the year property).

A null value means there's no data or the section is disabled.

The values (except for year, of course) are in tonnes.

Errors
This API operation can return the following errors:
HTTP status codeError code
404
429