Carbon Offsetting API Documentation
Explore our endpoints and examples to test, demo, implement, and use Cloverly for carbon offsetting.
Account info
Account Info
Use this to retrieve information about and the status of your account.
Response
{ "name": "string", "owner": { "name": "string", "email": "string" }, "balance_in_usd_cents": "number", "production_enabled?": "boolean", "environment": "string"}
Path attributes
none
Message body attributes
none
Account Stats
Account Stats
Retrieve offset statistics for your account.
Response
{ "environment": "string", "total_grams_of_carbon": "string", "transaction_count": "string", "purchased_count": "string", "cancelled_count": "string" "daily_stats": "string" "offset_stats": "string"}
Path attributes
none
Message body attributes
none
List offsets
List offsets
Get a list of all currently available offsets. Any purchase or estimate call below accepts targeting a specific offset via an offset_slug value.
Response
[ { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string" "offset_type": "string" "offset_type_slug": "string" "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }]
Path attributes
none
Message body attributes
none
Show offsets
Show the details of a specific offset
Get the details of a specific offset.
Response
{ "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string"}
Path attributes
Required | |
---|---|
offset_slug | The slug for the offset |
Message body attributes
none
How to Match Offsets
How to Match Offsets
Use this matching functionality when creating an estimate or purchase to match offsets by type, location, or exact slug.
By default, the Cloverly API matches based on low cost. The Cloverly API will match anywhere in the world with low cost. Using offset matching changes that behavior. If you include a "type," then the Cloverly API will require a particular offset type, and then sort by low cost. If a location is included, then the API will sort by closest offset to that location first.
Examples
Matching solar closest to Mountain View, California
"offset_match": {"type": "solar", "location":{"postal_code":"94043","country":"US"}
Matching solar to a latitude/longitude in Pennsylvania
"offset_match": {"type": "solar", "location":{"latlng": [41.1609216,-76.6826642]}
Matching offset to an airport
"offset_match": {"location": {"airport": "sfo"}}
Matching biomass (For a full list of available offset types, see offset types below.)
"offset_match": {"type": "biomass"}
Matching a specific offset
"offset_match": {"slug": "arcata-city-forest-barnum-tract-f07113"}
Full example
Matching solar closest to Mountain View, California, for 200 kilowatt-hours of electricity
Path attributes
none
Message body attributes
none
Offset types
List the offset types that can be used for filtering
Get a full list of offset types that can be used for filtering offsets. Use the "slug" returned here in the "offset_match" syntax above.
Response
[ { "slug": "string", "name": "string", "description": "string" }]
Path attributes
none
Message body attributes
none
List Attributes
List all purchases for your account
Get the full list of purchases for the account.
Response
[ { "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": ""number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string" }]
Path attributes
none
Message body attributes
Optional | |
---|---|
`offset_slug` | Filter to a specific offset |
`before` | epoch to choose the latest before a certain time (used for pagination) |
Show Purchase
Show the details for a specific purchase
Get the full details of a specific purchase.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string"}
Path attributes
Required | |
---|---|
`purchase_slug` | The slug for the purchase |
Message body attributes
none
Convert Estimate to Purchase
Convert an estimate into a purchase
After creating an estimate, use this endpoint to convert that estimate to a purchase.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`estimate_slug` | The slug for a previously created estimate to be converted to a purchase |
Create Fixed Price Purchase
Purchase an offset with a fixed price
Set the price you would like to pay. We'll calculate the amount of an offset available at that price.
Response
[ { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string" "offset_type": "string" "offset_type_slug": "string" "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }]
Path attributes
none
Message body attributes
Required | |
---|---|
`currency: {value: INTEGER, units: STRING}` | The fixed amount to be spent on this purchase, where "units" can be one of `usd` or `usd cents`. |
Purchase Carbon for Offset
Purchase an offset for carbon
Use this to offset a specific amount of carbon by weight.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`weight: {value: INTEGER, units: STRING}` | The fixed amount to be spent on this purchase, where "units" can be one of `usd` or `usd cents`. |
Purchase Carbon for Shipping
Purchase a shipping offset
Use this to offset emissions from shipping something.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string" }
Path attributes
none
Message body attributes
Required | |
---|---|
`weight: {value: INTEGER, units: STRING}` | The amount of carbon to offset |
Choose 1 of the following methods for calculating distance:
Using ZIP Codes | |
---|---|
`from: {zip: STRING}` | The origin zip code |
`to: {zip: STRING}` | The destination zip code |
Using UK Postal Codes | |
---|---|
`from: {uk_postal_code: STRING}` | The origin UK postal code |
`to: {uk_postal_code: STRING}` | The destination UK postal code |
Using Latitude-Longitude | |
---|---|
`from: {latlng: [FLOAT, FLOAT]}` | The origin latitude and longitude |
`to: {latlng: [FLOAT, FLOAT]}` | The destination latitude and longitude |
Using Distance | |
---|---|
`distance: {value: INTEGER, units: STRING}` | The distance where units can be "km" or "miles" |
Purchase Carbon for Transportation
Purchase a vehicle offset
Offset emissions from transportation in a vehicle that uses gasoline or diesel fuel.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string" }
Path attributes
none
Message body attributes
Required | |
---|---|
`fuel_efficiency: {value: INTEGER, units: STRING, of: STRING}` | The fuel efficiency of the vehicle, where "units" is one of 'mpg' or 'km/l' and "of" is one of "gasoline" or "diesel". |
`distance: {value: INTEGER, units: STRING}` | The distance to offset, where "units" is one of "miles" or "km". |
Purchase Carbon for Flight
Purchase a flight offset
Offset emissions from airplane travel.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string" }
Path attributes
none
Message body attributes
Required | |
---|---|
`airports: ["array", "of", "airport", "codes"] | An array of airport codes for the trip. The first airport should be the starting airport followed by the sequence of airports in the order of travel. |
Purchase Carbon for Electricity
Purchase an electricity offset
Purchase Renewable Energy Credits to offset electricity use.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string" }
Path attributes
none
Message body attributes
Required | |
---|---|
`energy: {value: INTEGER, units: STRING}` | The energy used, where "units" is one of 'kwh' or 'wh' for "kilowatt-hours" and "watt hours," respectively. |
Cancel Purchases
Cancel an offset purchase
Cancel the purchase of an offset. It is not possible to cancel offsets once they have been retired.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "purchased_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "pretty_url": "string"}
Path attributes
Required | |
---|---|
`purchase_slug` | The slug for the purchase |
Message body attributes
none
List Estimates
List all estimates for your account
Get the full list of estimates for the account.
Response
[ { "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string" }]
Path attributes
none
Message body attributes
Optional | |
---|---|
`offset_slug` | Filter to a specific offset |
`before` | epoch to choose the latest before a certain time (used for pagination) |
Show Estimate
Show details for a specific estimate
Get the full details of a specific purchase.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
none
Create Fixed Price Estimate
Estimate an offset with a fixed price
Set the price you would like to pay. We'll calculate the amount of offsets available at that price.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`currency: {value: INTEGER, units: STRING}` | The fixed amount to be estimated, where "units" can be one of `usd` or `usd cents`. |
Create Estimate for Carbon
Estimate an offset
Estimate an offset amount.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`weight: {value: INTEGER, units: STRING}` | The amount of carbon to offset where "units" can be `kg`, `grams`, or `pounds`. |
Create Estimate for Shipping
Estimate a shipping offset
Estimate an offset for emissions resulting from shipping something.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`weight: {value: INTEGER, units: STRING}` | The amount of carbon to offset |
Choose 1 of the following methods for calculating distance:
Using ZIP Codes | |
---|---|
`from: {zip: STRING}` | The origin zip code |
`to: {zip: STRING}` | The destination zip code |
Using Latitude-Longitude | |
---|---|
`from: {latlng: [FLOAT, FLOAT]}` | The origin latitude and longitude |
`to: {latlng: [FLOAT, FLOAT]}` | The destination latitude and longitude |
Using Distance | |
---|---|
`distance: {value: INTEGER, units: STRING}` | The distance where units can be "km" or "miles" |
Create Estimate for Ground Transportation
Estimate a vehicle offset
Estimate the offset for emissions from transportation in a vehicle that uses gasoline or diesel fuel.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`fuel_efficiency: {value: INTEGER, units: STRING, of: STRING}` | The fuel efficiency of the vehicle, where "units" is one of 'mpg' or 'km/l' and "of" is one of "gasoline" or "diesel". |
`distance: {value: INTEGER, units: STRING}` | The distance to offset, where "units" is one of "miles" or "km". |
Create Estimate for Flight
Estimate a flight offset
Estimate the offset for emissions from airplane travel.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`airports: ["array", "of", "airport", "codes"] | An array of airport codes for the trip. The first airport should be the starting airport followed by the sequence of airports in the order of travel. |
Create Estimate for Electricity
Estimate an electricity offset
Estimate the amount of Renewable Energy Credits needed to offset electricity use.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
none
Message body attributes
Required | |
---|---|
`energy: {value: INTEGER, units: STRING}` | The energy used, where "units" is one of 'kwh' or 'wh' for "kilowatt hours" and "watt hours" perspectively. |
Cancel Estimate
Cancel an offset estimate
Cancel the estimate of an offset.
Response
{ "slug": "string", "environment": "string", "state": "string", "renewable_energy_certificate": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "renewable_type": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "deprecated": "string" }, "micro_rec_count": "number", "micro_units": "number", "offset": { "slug": "string", "name": "string", "city": "string", "province": "string", "country": "string", "offset_type": "string", "offset_type_slug": "string", "total_capacity": "string", "latlng": "string", "technical_details": "string", "available_carbon_in_kg": "string", "pretty_url": "string" }, "total_cost_in_usd_cents": "number", "estimated_at": "string", "equivalent_carbon_in_kg": "number", "electricity_in_kwh": "string", "rec_cost_in_usd_cents": "number", "transaction_cost_in_usd_cents": "number", "cost": { "currency": "string", "total": "string", "transaction": "string", "offset": "string" }, "pretty_url": "string"}
Path attributes
Required | |
---|---|
`estimate_slug` | The slug for the estimate |
Message body attributes
none