Electricity

Create an electricity emission estimate

HTTP POST to /v1/estimates/electricityEstimate emissions produced by electricity consumption.

Request body

Parameters for estimating electricity emissions

namestring

A name to reference this calculation.

consumptionobjectrequired

amountstringrequired

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

unitstringrequired

Unit, kWh for kilowatt-hours, MWh for megawatt-hours, GWh for gigawatt-hours

kWh

MWh

GWh

country_codestring

The three-letter code of the country where the consumption takes place, if applicable.

Providing this value will improve the estimation process. If the value is not provided the global average will be used.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

Sample request

Response

massobjectrequired

amountstringrequired

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

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired
Error response

requestobjectrequired

Parameters for estimating electricity emissions

namestring

A name to reference this calculation.

consumptionobjectrequired

amountstringrequired

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

unitstringrequired

Unit, kWh for kilowatt-hours, MWh for megawatt-hours, GWh for gigawatt-hours

kWh

MWh

GWh

country_codestring

The three-letter code of the country where the consumption takes place, if applicable.

Providing this value will improve the estimation process. If the value is not provided the global average will be used.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

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 an electricity emission estimate

HTTP GET to /v1/estimates/electricity/{id}

Sample request

Query parameters

idstringrequired

The estimate's unique identifier

Response

massobjectrequired

amountstringrequired

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

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired
Error response

requestobjectrequired

Parameters for estimating electricity emissions

namestring

A name to reference this calculation.

consumptionobjectrequired

amountstringrequired

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

unitstringrequired

Unit, kWh for kilowatt-hours, MWh for megawatt-hours, GWh for gigawatt-hours

kWh

MWh

GWh

country_codestring

The three-letter code of the country where the consumption takes place, if applicable.

Providing this value will improve the estimation process. If the value is not provided the global average will be used.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

Errors

This API operation can return the following errors:

HTTP status codeError code

401

404

429

503

service_unavailable

Update an electricity emission estimate

HTTP PUT to /v1/estimates/electricity/{id}Estimate emissions produced by electricity consumption.

Query parameters

idstringrequired

The estimate's unique identifier

Request body

Parameters for estimating electricity emissions

namestring

A name to reference this calculation.

consumptionobjectrequired

amountstringrequired

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

unitstringrequired

Unit, kWh for kilowatt-hours, MWh for megawatt-hours, GWh for gigawatt-hours

kWh

MWh

GWh

country_codestring

The three-letter code of the country where the consumption takes place, if applicable.

Providing this value will improve the estimation process. If the value is not provided the global average will be used.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

Sample request

Response

massobjectrequired

amountstringrequired

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

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired
Error response

requestobjectrequired

Parameters for estimating electricity emissions

namestring

A name to reference this calculation.

consumptionobjectrequired

amountstringrequired

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

unitstringrequired

Unit, kWh for kilowatt-hours, MWh for megawatt-hours, GWh for gigawatt-hours

kWh

MWh

GWh

country_codestring

The three-letter code of the country where the consumption takes place, if applicable.

Providing this value will improve the estimation process. If the value is not provided the global average will be used.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

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

Create an electricity emission estimate

Request body

consumptionobject.css-1paqw6e{margin:0;font-family:Helvetica Neue,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:17px;letter-spacing:0em;text-align:left;color:#212121;color:#D32F2F;margin-right:4px;}required

amountstringrequired

unitstringrequired

country_codestring

bundle_selectionarray

object

bundle_idstringrequired

quantity_truncstring

metadataobject

idempotency_keystring

Response

massobjectrequired

amountstringrequired

unitstringrequired

metadataobject

idempotency_keystring

idstringrequired

quoteoneOfrequired@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Error response

requestobjectrequired

namestring

consumptionobjectrequired

amountstringrequired

unitstringrequired

country_codestring

bundle_selectionarray

object

bundle_idstringrequired

percentageoneOf@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Selection percentage as integer

quantity_truncstring

metadataobject

idempotency_keystring

Errors

Get an electricity emission estimate

Sample request

Query parameters

idstringrequired

Response

massobjectrequired

amountstringrequired

unitstringrequired

metadataobject

idempotency_keystring

idstringrequired

quoteoneOfrequired@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Error response

requestobjectrequired

namestring

consumptionobjectrequired

amountstringrequired

unitstringrequired

country_codestring

bundle_selectionarray

object

bundle_idstringrequired

percentageoneOf@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Selection percentage as integer

quantity_truncstring

metadataobject

idempotency_keystring

Errors

Update an electricity emission estimate

Query parameters

idstringrequired

Request body

namestring

consumptionobjectrequired

amountstringrequired

unitstringrequired

country_codestring

bundle_selectionarray

object

bundle_idstringrequired

percentageoneOf@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Selection percentage as integer

quantity_truncstring

metadataobject

idempotency_keystring

Response

massobjectrequired

amountstringrequired

consumptionobjectrequired

quoteoneOfrequired
Error response

percentageoneOf
Selection percentage as integer

quoteoneOfrequired
Error response

percentageoneOf
Selection percentage as integer

percentageoneOf
Selection percentage as integer

quoteoneOfrequired
Error response

percentageoneOf
Selection percentage as integer