Cloverly (Independent Publisher) (Preview)
Cloverly's powerful API calculates the impact of common carbon-intensive activities in real time and uses verified, quality carbon offset projects to neutralize them. Businesses and consumers count on Cloverly to offset their carbon footprint and create positive environmental change based on real-time business activities.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
Publisher | Troy Taylor |
Website | https://www.cloverly.com/ |
Privacy policy | https://www.cloverly.com/privacy-policy |
Categories | Commerce |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Production Public Key | securestring | The Production Public Key for this api | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Calculate emissions from merchant category code (MCC) |
Calculate the carbon emissions from merchant category code (MCC) and offset the impact. |
Calculate emissions from package shipping |
Calculate the carbon emissions from package shipping and offset the impact. |
Calculate the emissions from electricity |
Calculate the carbon emissions and offset the impact from electricity. |
Calculate the emissions from flight |
Calculate the carbon emissions and offset the impact from a flight. |
Calculate the emissions from freight shipments |
Calculate the carbon emissions from freight shipments and offset the impact. |
Calculate the emissions from vehicle |
Calculate the carbon emissions and offset the impact from a vehicle. |
Convert estimate to purchase |
Converts a carbon offset estimate to a purchase |
Direct purchase by carbon amount |
Allows either the calculation or purchase of an offset to neutralize the impact. |
Direct purchase by transaction amount |
Allows either the calculation or purchase of an offset to neutralize the impact. |
Get account information |
Returns details about your account. |
List project types |
Returns a list of project types. |
View custom portfolio details |
Get information around a given portfolio ID. Includes a back reference to offset sources. |
View project details |
Get details about an offset source with the given project ID. |
Calculate emissions from merchant category code (MCC)
Calculate the carbon emissions from merchant category code (MCC) and offset the impact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
MCC Code
|
mcc_code | integer |
Merchant category code: a four-digit number used by credit card companies to classify businesses. |
|
Value
|
value | number |
The amount. |
|
Units
|
units | string |
Carbon unit (kg or lbs). |
|
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Calculate emissions from package shipping
Calculate the carbon emissions from package shipping and offset the impact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | number |
The amount. |
|
Units
|
units | string |
Carbon unit (kg or lbs). |
|
Mode
|
mode | string |
Mode of transportation. |
|
Value
|
value | number |
The amount. |
|
Units
|
units | string |
Carbon unit (kg or lbs). |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Calculate the emissions from electricity
Calculate the carbon emissions and offset the impact from electricity.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Calculate the emissions from flight
Calculate the carbon emissions and offset the impact from a flight.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Airports
|
airports | True | array of string | |
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in. |
Total CO2e in Kg
|
total_co2e_in_kg | float |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | integer |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The carbon cost. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | float |
The total cost. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | float |
The transaction cost. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | float |
The carbon cost. |
ID
|
project.id | string |
Project identification number. |
Name
|
project.name | string |
Name of the project. |
Type
|
project.type | string |
Type of project, ex. Solar. |
City
|
project.city | string |
City the project is located in. |
State
|
project.state | string |
State the project is located in. |
Country
|
project.country | string |
Country the project is located in. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Calculate the emissions from freight shipments
Calculate the carbon emissions from freight shipments and offset the impact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Mode
|
mode | string |
Mode of transportation. |
|
Type
|
type | string |
The type. |
|
Value
|
value | string |
The amount. |
|
Units
|
units | string |
Carbon unit (kg or lbs). |
|
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Calculate the emissions from vehicle
Calculate the carbon emissions and offset the impact from a vehicle.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Of
|
of | True | string |
Of |
Type
|
type | string |
The type. |
|
Postal Code
|
postal_code | string |
The postal code. |
|
Country
|
country | string |
The country. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Convert estimate to purchase
Converts a carbon offset estimate to a purchase
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction ID
|
transaction_ID | True | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Direct purchase by carbon amount
Allows either the calculation or purchase of an offset to neutralize the impact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Latlng
|
latlng | array of string | ||
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Direct purchase by transaction amount
Allows either the calculation or purchase of an offset to neutralize the impact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction
|
transaction | True | string |
Pass estimates to get a calculation. Use purchases to also purchase an offset to neutralize the impact. |
Value
|
value | True | number |
The amount. |
Units
|
units | True | string |
Carbon unit (kg or lbs). |
Type
|
type | string |
The type. |
|
Note
|
note | string |
Add a note to be displayed in the receipt URL. |
|
Unit Cost USD Cents
|
unit_cost_usd_cents | integer |
Unit cost in USD cents. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Transaction ID
|
transaction_id | string |
The unique identifier for the purchase. This value is unique across all accounts. |
Transaction State
|
transaction_state | string |
The state of the purchase. |
Environment
|
environment | string |
The environment the purchase was made in |
Total CO2e in Kg
|
total_co2e_in_kg | number |
Total carbon dioxide equivalent calculated or requested for the purchase. |
Total Micro Units
|
total_micro_units | number |
The number of micro units estimated or purchased. 1 micro unit is equivalent to one gram of carbon. |
Total Cost
|
cost.in_usd_cents.total_cost | integer |
The total cost of the purchase. |
Transaction Cost
|
cost.in_usd_cents.transaction_cost | integer |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_usd_cents.carbon_cost | integer |
The cost of the credits purchased to offset. |
Requested Currency
|
cost.requested_currency | string |
Currency requested in request body. Defaults to USD if none passed. |
Total Cost
|
cost.in_requested_currency.total_cost | number |
The total cost of the purchase. |
Transaction Cost
|
cost.in_requested_currency.transaction_cost | number |
The transaction cost of the purchase. |
Carbon Cost
|
cost.in_requested_currency.carbon_cost | number |
The cost of the credits purchased to offset. |
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Receipt URL
|
receipt_url | string |
The link to the public facing receipt of the purchase. |
Get account information
Returns details about your account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name. |
Balance In USD Cents
|
balance_in_usd_cents | integer |
Balance in USD cents. |
Production Enabled?
|
production_enabled? | boolean |
Whether production is enabled. |
List project types
Returns a list of project types.
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
name
|
name | string |
name |
type_id
|
type_id | string |
type_id |
title
|
title | string |
description |
View custom portfolio details
Get information around a given portfolio ID. Includes a back reference to offset sources.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Portfolio ID
|
portfolio_id | True | string |
The ID of the portfolio. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the project. |
Slug
|
slug | string |
The slug of the project. |
Blended Unit Cost USD Cents
|
blended_unit_cost_usd_cents | float |
The cost per kg of carbon for the portfolio. |
Total Remaining Units
|
total_remaining_units | integer |
Total remaining microunits. |
Created At
|
created_at | string |
When created at. |
Updated At
|
updated_at | string |
When updated at. |
Offset Sources
|
offset_sources | array of object | |
name
|
offset_sources.name | string |
The name. |
slug
|
offset_sources.slug | string |
The slug. |
Available Carbon in Kg
|
offset_sources.available_carbon_in_kg | integer |
Available carbon in kilograms. |
View project details
Get details about an offset source with the given project ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Project ID
|
project_id | True | string |
The ID of the project. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
project.id | string |
The identification number. |
Type
|
project.type | string |
The type. |
Name
|
project.name | string |
The name. |
City
|
project.city | string |
The city. |
State
|
project.state | string |
The state. |
Country
|
project.country | string |
The country. |
Registry Serial Number Range
|
project.registry_serial_number_range | string |
The serial number range of the purchased tranche block. |
Registry Link
|
project.registry_link | string |
The link to the global registry the tranche block was purchased on. |
Project URL
|
project.project_url | string |
Link to public project page with more information. |
Cost Per Kg Carbon In USD Cents
|
project.cost_per_kg_carbon_in_usd_cents | string |
The cost per kilogram of carbon. |
Available Carbon In Kg
|
project.available_carbon_in_kg | string |
The available carbon in kilograms. |