Guide to the Microsoft Excel Add-In
Utilize Climatiq-specific functions in Microsoft Excel to seamlessly convert your business activity data into carbon estimates across various activities, such as travel, energy usage, and fuel consumption.
Overview
Climatiq’s Microsoft Excel Add-In transforms your spreadsheets into a powerful environmental impact assessment tool. No coding is required, allowing you to quickly create proofs of concept and collaborate with your team for feedback before fully integrating Climatiq’s API or developing advanced features. The Add-In lets you visualize results directly in Excel and share detailed emission reports, streamlining approval for sustainability projects with reliable data.
Since this tool provides a simplified version of our API endpoints, we recommend reviewing our documentation or using the guided Postman collection if you are interested in accessing the full capabilities of the API.
Learn about the Add-In in our How-To series
Getting Started
Access to Climatiq's API generally requires a commercial subscription. However, for this Add-In, we offer a free starter plan that includes up to 500 emission estimations per month, granting access to all advanced emission calculations, e.g. the emission estimations for travel, freight, energy and the Autopilot. Without this plan or a commercial subscription, functionality will be limited to basic estimations, i.e. General Estimates and General Search. Upon installing the Add-In via Microsoft AppSource, you will automatically be enrolled in this plan. Alternatively, you can sign up for the starter plan here (opens in a new tab). If you anticipate commercial usage or usage beyond the free starter plan limit, please reach out to our team (opens in a new tab).
If you prefer a video introduction, here is a 2 minute quickstart guide:
Installation of the Add-In
You can install the Add-In from Microsoft AppSource (opens in a new tab). Once installed, it will appear under the "Add-In" menu in the Excel toolbar.
Setting the API key
Next, you'll need to set an API key for the Add-In to call Climatiq's API. Follow these steps to obtain your API key. Once you have it, set the key by executing the following function:
The API key will be stored permanently for this specific file and other users using this file will also be able to make use of the functions. This also means that you will have to set the key once for every new Excel file in which you'd want to use this integration. You can always overwrite the stored API key by calling the above mentioned function again.
Please be aware that any usage done via the API key will directly be linked to your account. I.e. if you share the key with colleagues or customers, they might misuse or overuse it, which can cause the consumption in your Climatiq Account to exceed your licensed volume. We therefore recommend you to not share the key at all or be very selective about it.
Explore the demo
You can familiarize yourself with the Add-In be exploring the demo file we have prepared. It provides different examples on inputs for all available formulas. You can download the demo here.
Support and Feedback
In case of questions, please reach out to the Climatiq team via the website chat or the support form (opens in a new tab). We also appreciate any feedback being shared through these channels.
General Concepts and Notices
To get the most out of the Add-In, it's important to familiarize yourself with the following concepts.
"ShowDetails" Flag
For all Estimation and Autopilot functions, you can choose whether to receive additional calculation details or just the estimated CO2e value in the response. Refer to the documentation for each function to see which details are available. The additional details will be stored in the cells following the one containing the function.
Optional Parameters
Typically not all parameters are required when using the functions. The documentation indicates which ones are required and which ones are optional. In case no value should be used for the optional parameters, please simply leave them empty, e.g. Climatiq.Calculate_Travel_Air(start, end, flightclass) as Climatiq.Calculate_Travel_Air("BER", "JFK").
Error Handling
In addition to common errors, functions will return specific errors from the Climatiq API if an input is incorrect, or if the provided API key is invalid, or a suitable emission factor cannot be found by the API.
Populate Header Rows
Many of the formulas will retrieve results across multiple cells, especially when the "showDetails" flag is being used. To know which different values are being retrieved and to automatically populate the headers for the result columns, there is a collection of dedicated formulas available for this.
For every Calculate and Autopilot formula, you can simply add _Headers to the original formula name. Additionally, you can indicate, whether the detail column headers should also be populated.
A few examples: =Climatiq.Autopilot_Headers(TRUE), =Climatiq.Calculate_Travel_Air_Headers() and =Climatiq.Calculate_IntermodalFreightTransport_Headers(TRUE)
API Consumption and Recalculation of Results
By default, Excel will re-calculate the results for functions everytime an input changes or the file is reloaded. Every re-calculation will also count as a call to the Climatiq API. To avoid overconsumption of your subscribed API calls, it is recommended to copy-paste the values of the calculations into the cells as soon as the calculations are complete. To do this, you should select the cells with the calculation results, copy them and paste them back into these cells via Edit > Paste Special > Values only. You can disable the automatic recalculations under the settings for "Calculation options" in the "Formula" ribbon.
Documentation within the Add-In
To see an overview of the available functions in a sidebar within Excel, simply open the documentation by clicking the Climatiq icon in the main menu bar.
Access to all functionalities
By default, when signing up for the Climatiq API, the initial access only covers the usage of the general estimation and search capabilities. For any advanced calculations, e.g. emission estimations for air travel, additional access needs to be granted for your API key. Otherwise the following error will be shown when trying to make use of an advanced features, that has not yet been enabled for your account:
Your authentication is valid, but you do not have access to this feature.
To enable these advanced features, you can sign up to a free starter plan, which covers up to 500 emission estimations monthly across advanced emission calculations. You can sign up for this plan here (opens in a new tab). And in case you are interested in large-scale usage of the integration, please reach out to our team (opens in a new tab).
Functions
There are three sets of functions available:
- Estimations: Easily calculate the emissions for different kinds of business activities, e.g. travel, shipping and energy usage based on detailed methodologies
- Autopilot: Leverage Climatiq's Autopilot to automate spend- and activity-based emission estimates
- Search: Look up emission factors, support regions, fuel types, and others in Climatiq's database
Estimations
General Emission
Calculate the total estimated emissions produced for a particular activity, in kgCO2e, using any emission factor in the Climatiq database.
Climatiq.Calculate(activityID; region; source; year; unit; amount; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
activityID | ✓ | Text | An ID describing the activity that to search for. Multiple emission factors can share the same activity_id, e.g. if they are from a different source or apply to a different region. You can search for activity_ids in the Data Explorer (opens in a new tab) or via the search functions. |
region | ✕ | Text | A region code describing the geographic region to which the emission factor applies. |
source | ✕ | Text | Desired emission factor source. |
year | ✕ | Number | Year in which the activity took place. |
unit | ✓ | Text | Specific unit of the consumed amount, e.g. usd for Money, l for Volume or kg for Weight. See the full list here. |
amount | ✓ | Number | Amount for which the emissions shall be calculated. |
showDetails | ✕ | True/False | Indicates if details on the used emission factor should be shared: Name, source and ID of the used emission factor. |
Examples
Air Travel
Calculate the total estimated emissions of air travel. The distance between the airports will be calculated using the great circle distance.
Climatiq.Calculate_Travel_Air(start; end; flightclass; year; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
start | ✓ | Text | Start location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
end | ✓ | Text | Destination location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
flightclass | ✕ | Text | Flight class, can be empty, average,economy, business or first. |
year | ✕ | Number | The year in which the travel occurred. |
showDetails | ✕ | True/False | Indicates if these details should also be shared: Distance, direct emissions, indirect emissions & notices. |
Examples
Road Travel
Calculate the total estimated emissions of road travel. The distance between the locations will be calculated by considering the actual road network where possible.
Climatiq.Calculate_Travel_Road(start; end; car_type; car_fuel; year; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
start | ✓ | Text | Start location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
end | ✓ | Text | Destination location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
car_type | ✕ | Text | Size of the care. Valid values are small, medium, large and average. |
car_fuel | ✕ | Text | Type of fuel used by the car. Valid values are: petrol, diesel, hybrid (cars with a battery that is recharged by the internal combustion engine), plugin_hybrid (cars with an internal combustion engine and a battery that can be plugged in), battery (for electric vehicles) and average. |
year | ✕ | Number | The year in which the travel occurred. |
showDetails | ✕ | True/False | Indicates if these details should also be shared: Distance, direct emissions, indirect emissions & notices. |
Examples
Rail Travel
Calculate the total estimated emissions of rail travel. The distance between the locations will be calculated by considering the actual rail network where possible. Otherwise the road distance will be used.
Climatiq.Calculate_Travel_Rail(start; end; year; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
start | ✓ | Text | Start location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
end | ✓ | Text | Destination location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
year | ✕ | Number | The year in which the travel occurred. |
showDetails | ✕ | True/False | Indicates if these details should also be shared: Distance, direct emissions, indirect emissions & notices. |
Examples
Travel based on Spend
Calculate travel emissions based on spend-based data in any currency by using EXIOBASE emission factors. This calculation automatically takes inflation into account, if the year you spent the money was different than the year of the emission factor.
Climatiq.Calculate_Travel_Spend(spend_type; currency; amount; location; year; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
spend_type | ✓ | Text | The type of travel associated with the expenditure. Valid values are: air, road, rail, sea, and hotel. |
currency | ✓ | Text | The currency in which the money unit is expressed. |
amount | ✓ | Number | The amount of money spent. |
location | ✓ | Text | The location where money was spent, can be any type of free text. |
year | ✕ | Number | The year in which expenditures occurred. |
showDetails | ✕ | True/False | Indicates if these details should also be shared: Distance, used emission factor name, source, region and notices. |
Examples
Freight Shipping
Calculate the total estimated emissions of freight shipping. The distance between the locations will be calculated by considering the actual transport network where possible. By calling our API directly, it's also possible to specify the individual shipment legs as well as the mode of transport used.
Climatiq.Calculate_IntermodalFreightTransport(start; end; mode; weight; weightUnit; direct; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
start | ✓ | Text | Start location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
end | ✓ | Text | Destination location, can be free text (Berlin), IATA Code (BER), UN-LOCODE (DE-BER) or coordinates, i.e. lat & lon (52.520008,13.404954) |
mode | ✓ | Text | Main mode of transport. Valid values are: air, road, rail and sea |
weight | ✓ | Number | Weight of the transported goods |
weightUnit | ✓ | Text | Unit of the weight. Valid values are: g, kg, t (metric ton), lb, ton (US short ton). |
direct | ✓ | True/False | Indicates if in case of sea, air or rail freight the road pre- and post-leg should NOT be added. |
showDetails | ✕ | True/False | Indicates if there details should also be shared: Distance & route. |
Examples
Procurement Emissions by Industry Classification Code
Estimate the emissions for a purchase using an industry classification code to identify the type of purchased goods or service. This calculation accounts for tax, trade and transport margins using per-sector and per-country margins from EXIOBASE, if no user-supplied margins are provided. It also corrects for currency exchange rates and inflation adjustments, using rates from the UN Treasury, supplemented with per-industry inflation numbers from Eurostat. You can find details on the methodology here.
Climatiq.Calculate_Procurement_ByClassification(scheme; code; region; year; currency; amount; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
scheme | ✓ | Text | The classification scheme used. Valid values are: mcc, unspsc, isic4 and nace2 |
code | ✓ | Text | Specific code of the classification. Please be aware that UNSPSC is only available up to a family level, i.e. the last four digits should be 0. |
region | ✓ | Text | The country in which the goods have been purchased, i.e. ideally the supplier country. Must be a 2-digit country code from ISO-3166-1 (opens in a new tab). |
year | ✓ | Number | Year of purchase |
currency | ✓ | Text | Currency of spend, see all available currencies here. |
amount | ✓ | Text | Spend amount |
showDetails | ✕ | True/False | Indicates if these details about the calculation methodology should also be shared: Emission factor name, the applied margins for tax, trade, transport and inflation. |
Examples
Procurement Emissions by Activity ID
Estimate the emissions for a purchase using an activity ID to identify the type of purchased goods or service. This calculation accounts for tax, trade and transport margins using per-sector and per-country margins from EXIOBASE, if no user-supplied margins are provided. It also corrects for currency exchange rates and inflation adjustments, using rates from the UN Treasury, supplemented with per-industry inflation numbers from Eurostat. You can find details on the methodology here.
Climatiq.Calculate_Procurement_ByActivityID(activity_id; region; year; currency; amount; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
activityID | ✓ | Text | An ID describing the activity that to search for. Multiple emission factors can share the same activity_id, e.g. if they are from a different source or apply to a different region. You can search for activity_ids in the Data Explorer (opens in a new tab) or via the search functions. |
region | ✓ | Text | The country in which the goods have been purchased, i.e. ideally the supplier country. Must be a 2-digit country code from ISO-3166-1 (opens in a new tab). |
year | ✓ | Number | Year of purchase |
currency | ✓ | Text | Currency of spend, see all available currencies here. |
amount | ✓ | Text | Spend amount |
showDetails | ✕ | True/False | Indicates if these details about the calculation methodology should also be shared: Emission factor name, the applied margins for tax, trade, transport and inflation. |
Examples
Fuel
Estimate the emissions of fuel combustion. The calculation also provides details on the associated scope 3, i.e. the well-to-tank emissions. More options are available by directly calling our API.
Climatiq.Calculate_Fuel(fuel_type; amount; amount_unit; region; year; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
fuel_type | ✓ | Text | Type of fuel burned, e.g. biodiesel, cng, fuel_gas, etc. You can make use of our search function to get a list of available fuel types. |
amount | ✓ | Number | Amount of fuel burned. |
amount_unit | ✓ | Text | Unit of provided amount |
region | ✕ | Text | The country in which the fuel have been purchased. Must be the 2-digit UN code. |
year | ✕ | Number | Year of the fuel consumption |
showDetails | ✕ | True/False | Indicates if these details about the calculation methodology should also be shared: Overall co2e, combustion emissions, wtt emissions and notices. |
Examples
Electricity
Estimate the emissions of electricity usage. If desired, the function also provides details on the associated scope 3, i.e. the well-to-tank, transmission and distribution losses and their well-to-tank emissions. More options are available by directly calling the API - refer to the documentation for details.
Climatiq.Calculate_Electricity(amount; region; year; connectionType; calculationType; supplier; energy_source; recs; includeScope3; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
amount | ✓ | Number | Amount of electricity consumed in kWh. |
region | ✕ | Text | The country or region in which the electricity has been consumed. Must be the 2-digit UN code. |
year | ✕ | Text | Year of the electricity consumption |
connectionType | ✕ | Text | Either the electricity was delivered via the "grid" or via a direct line. Default is grid. |
calculationType | ✕ | Text | Indicates whether the location-based or market-based value should be returned, default is location-based. |
supplier | ✕ | Text | Available where the region is GB or a US state, a supplier ID can be provided to use market factors for that supplier. Use the respective search function to find available suppliers. |
energy_source | ✕ | Text | The source that electricity is generated from. Valid values are renewable or specific fuel types such as natural_gas, coal, biomass and nuclear. |
recs | ✕ | Number | Quantity of RECs (Renewable Energy Certificates) to apply for market-based emission calculations. |
includeScope3 | ✕ | True/False | Indicates if the scope 3 emissions should be considered in the calculation, default is false. |
showDetails | ✕ | True/False | Indicates if details should also be shared: Overall co2e, combustion emissions, wtt emissions and notices. |
Examples
Cloud Computing - Virtual Machines
Estimate the emissions for using virtual machines provided by the common cloud providers (AWS, GCP and Azure), including both the embodied emissions (meaning the emissions related to the manufacturing and disposal of the physical components, expressed per CPU hour over the expected lifetime of the hardware) and the electricity usage of the different components. More options are available by directly calling our API.
Climatiq.Calculate_CloudVMs(vm_type; region; provider; duration; duration_unit; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
vm_type | ✓ | Text | The specific virtual machine instance type you are using. |
region | ✓ | Text | The region that is relevant for the calculation, as specified by the cloud provider. |
provider | ✓ | Text | The provider used, valid values are: aws, azure and gcp. |
duration | ✓ | Number | How long the machine is running for. |
duration_unit | ✓ | Text | The unit the duration value is in. Valid values are ms, s, m, h, day, year. |
showDetails | ✕ | True/False | Indicates if details about the calculation methodology should also be shared: Overall emissions, the memory usage energy emissions, the cpu usage energy emissions and the embodied emissions. |
CBAM
Calculate total estimated emissions produced for a particular Combined Nomenclature (CN) code, for use with CBAM reporting.
Climatiq.Calculate_CBAM(cn_code; production_region; weight; weight_unit; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cn_code | ✓ | Text | The combined nomenclature code for the imported goods. |
production_region | ✓ | Text | The region the goods were produced in. If you specify "ROW" then this will return the EU default factors |
weight | ✓ | Number | The weight of the imported goods in the defined unit. |
weight_unit | ✓ | Text | Unit of the weight. Valid values are: g, kg, t (metric ton), lb, ton (US short ton). |
showDetails | ✕ | True/False | Indicates if details should also be shared (overall co2e, estimated costs, the emission factor name, direct emissions, indirect emissions and notices). |
Examples
Autopilot
Autopilot is an AI-powered calculation endpoint designed to automate spend- and activity-based emission estimates. It uses a proprietary natural language processing (NLP) model paired with Climatiq’s scientific expertise to streamline complex emission calculations, making carbon insights accessible to non-experts.
Autopilot significantly reduces the time and manual effort spent identifying the appropriate emission factors and mapping activity data. Capable of ingesting any taxonomy and unstructured data, this feature matches raw text content to the correct emission factors and delivers accurate and compliant emission estimates.
Leveraging a built-in expert review mechanism and machine learning, Autopilot's matching algorithm consistently refines its precision. This is achieved through active feedback and continuous improvement of the underlying NLP model.
General Estimation
Calculate total estimated emissions produced for a particular activity, in kgCO2e, using free-text input. The best matching emission factor will automatically be selected and used for the calculation.
Climatiq.Autopilot(text; domain; unit; amount; year; region; region_fallback; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
text | ✓ | Text | The free-form input text, such as an activity name, service or material name. |
domain | ✓ | Text | Defines the scope of emission factors to be searched, see available domains here. |
unit | ✓ | Text | Specific unit of the consumed amount, e.g. usd for Money, l for Volume or kg for Weight. See the full list here. |
amount | ✓ | Number | Amount for which the emissions shall be calculated. |
year | ✕ | Number | Year in which the activity took place. |
region | ✕ | Text | A region code describing the geographic region to which the emission factor should apply. |
region_fallback | ✕ | True/False | Indicates if Autopilot should search in other regions, if no factor can be found for the given region. |
showDetails | ✕ | True/False | Indicates if details on the used emission factor should be shared: Name, source and ID. |
Examples
Suggest
Receive a number of suggested Emission Factors for a particular input query. You can adjust the number of suggestions to return. Suggestions are ordered by the most likely match first.
For each result, a suggestion ID is returned, which you can apply via the Autopilot_EstimateSuggest formula to calculate the respective emissions.
Climatiq_Autopilot_Suggest(results, text, domain, unit_type, source, year, region, region_fallback, excludeEcoinvent, flatten, showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
results | ✓ | Number | The maximum number of suggestions to receive. Autopilot will return as many suitable suggestions as it can find, up to the max number requested, or at most 20 suggestions. |
text | ✓ | Text | The free-form input text, such as an activity name, service or material name. |
domain | ✓ | Text | Defines the scope of emission factors to be searched, see available domains here. |
unit_type | ✕ | Text | The unit types of the activity, can be Weight, Money, Volume and Number. When searching across multiple types, split them with a comma, e.g. "Money,Volume" |
source | ✕ | Text | The source(s) in which should be searched in. If you search in multiple sources, split them with a comma, e.g. "BEIS,EPA,Ecoinvent" |
year | ✕ | Number | Year in which the activity took place. |
region | ✕ | Text | A region code describing the geographic region to which the emission factor should apply. |
region_fallback | ✕ | True/False | Indicates if Autopilot should search in other regions, if no factor can be found for the given region. |
excludeEcoinvent | ✕ | True/False | Indicates if Ecoinvent emission factors should be disregarded during the Matching |
flatten | ✕ | True/False | Indicates if the calculation details of the matches should also be shared, i.e. estimated emissions and the details of the used emission factor (name, source, Climatiq UUID) |
showDetails | ✕ | True/False | Indicates if details on the used emission factor should be shared: Name, source and ID. |
Example - Flattened
Example - Not Flattened
Estimate Suggest
Calculate an emission estimation for an emission factor match. To calculate an emission estimation you will need to first find an emission factor using the Suggest endpoint. When you have selected an emission factor, you can request for a calculation using the suggestion ID.
Climatiq_Autopilot_EstimateSuggest(suggestID; unit; amount; showDetails)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
suggestID | ✓ | Text | An ID generated via the Suggest formula. |
unit | ✓ | Text | Specific unit of the consumed amount, e.g. usd for Money, l for Volume or kg for Weight. See the full list here. |
amount | ✓ | Number | Amount for which the emissions shall be calculated. |
showDetails | ✕ | True/False | Indicates if details on the used emission factor should be shared: Name, source and ID. |
Example - Flattened
Search
Search Emission Factors
Search the emission factor database of Climatiq. Please be aware that this might only return a subset of results (depending on the number of results specified). The search works in the same way as our Data Explorer (opens in a new tab). The function returns a table of results, so make sure the surrounding cells are empty when using this function. Depending on whether an existing Climatiq subscription to use the raw emission factors is in place, these will also be returned as part of the response. If you want to gain access to the raw emission factors, please reach out to our team (opens in a new tab).
Climatiq.Search_EmissionFactors(query; numberOfResults; sector; category; source; region; year; unit_type; lca_stage)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
query | ✕ | Text | A free-text query that will match ids, names, descriptions, etc. of emission factors. This uses fuzzy matching, so your query does not need to be precise. |
numberOfResults | ✕ | Number | The number of results to be shared. The maximum value is 500. |
sector | ✕ | Text | Filters by emission factor sector. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
category | ✕ | Text | Filters by emission factor category. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
source | ✕ | Text | Filters by emission factor source. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
region | ✕ | Text | Filters by emission factor region. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
year | ✕ | Number | Filters by applicable year. |
unit_type | ✕ | Text | Filters by emission factor unit type, e.g. Money or Volume. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
lca_stage | ✕ | Text | Filters by Life Cycle Assessment stage, e.g. well-to-tank. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
Examples
Available Regions
Find available regions for a specific query. At least one of the parameters needs to be set.
Climatiq.Search_Regions(query; sector; category; source)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
query | ✕ | Text | A free-text query that will match ids, names, descriptions, etc. of emission factors. This uses fuzzy matching, so your query does not need to be precise. |
sector | ✕ | Text | Filters by emission factor sector. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
category | ✕ | Text | Filters by emission factor category. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
source | ✕ | Text | Filters by emission factor source. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
Examples
Available Electricity Suppliers
Find available electricity suppliers for a specific region to be used for the electricity emission estimation. Currently only available for GB and US regions.
Climatiq.Search_AvailableElectricitySuppliers(region)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
region | ✕ | Text | Filters by emission factor region. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
Examples
Available Fuel Types
Pulls a list of fuel types available to be used in the fuel emissions function for a specific unit type.
Climatiq.Search_AvailableFuelTypes(unit_type)
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
unit_type | ✕ | Text | Filters by emission factor unit type, e.g. Money or Volume. Refer to the Data Explorer (opens in a new tab) for a list of available options. |
Frequently Asked Questions
General
Which Excel versions support the use of the Add-In?
The Add-In is available for Excel on Windows (Excel 2013 and later), Excel on Mac (Excel 2016 and later) and Microsoft 365 Online. Installing it once for your Microsoft account via the Microsoft AppSource will make the Add-In available to you across all platforms.
Is the Climatiq Excel add-in free to use?
If you are signed up to our Community Plan, our Excel add-in is free for non-commercial use, supporting up to 500 calculations per month. If you require higher calculation volumes or commercial use, please contact our sales team (opens in a new tab) to discuss your needs or book a demo (opens in a new tab).
How do I use the Climatiq formulas to calculate emissions?
Access to all our formulas use the =CLIMATIQ format. When typing this into a cell in sheets, a variety of different formulas will appear.
Download our demo file (opens in a new tab) in step 2 of the setup guide to test the Climatiq formulas with different inputs.
What emission factors are available in the Excel add-in?
You can access emission factors from all sources except for ecoinvent (opens in a new tab) and IEA (opens in a new tab) data. The ecoinvent and IEA factors are only available via the estimation functions and the Autopilot and only if a subscription to these sources is in place.
Can we manage or revoke keys centrally?
Yes, you can manage your keys via the Climatiq dashboard (opens in a new tab) and create new keys for any occasion. We also recommend to make use of Climatiq's project management. This allows you to create a new project in your Climatiq dashboard for each new engagement. Each API key belongs to a project - this allows you to create separate keys for different use cases or scenarios - and a project can hold several keys. You can track the API usage per project and enable or disable API keys associated to this project as needed.
How does performance scale if we have thousands (or tens of thousands) of rows?
While the Climatiq API is designed to handle a large volume of requests rapidly, there are some usage limitations when using the Add-In. The Add-In can handle up to 100 complex calculations being performed in parallel e.g. for shipment, travel, or Autopilot requests. Making parallel requests exceeding this volume within a short time frame may result in errors in Excel. We therefore recommend to perform calculations in batches, i.e. insert the formula into 100 cells, wait a few seconds for the calculations to be completed and continue with the next set of 100 calculations. If you are aiming to perform calculations for tens of thousands of data points at once on a large scale, we recommend reaching out to our team to explore data processing options via the Climatiq API directly.
Troubleshooting
Why am I getting an “Invalid Token” error in fields?
The API key may not be set, was set incorrectly or Excel is not recalculating the formula.
To fix this issue, ensure the Climatiq Add-In is installed and that the API key is set in the “Overview” page or that you have set the API key for the current file via the relevant formula (opens in a new tab) (CLIMATIQ.SETKEY(APIKEY)).
After setting the API key, you can re-calculate the fields in which this error is shown.
Why am I getting a “#NAME!” error in my formulas?
This error is shown by Excel if it is trying to resolve the name of a formula or variable, but it not able to do so, because the name is unknown to Excel.
One common cause are missing quotation marks (””) around alphabetical inputs, e.g. =CLIMATIQ.SETKEY(ABCD) instead of =CLIMATIQ.SETKEY("ABCD"). In this case, Excel thinks that 'ABCD' is the name of a variable and is trying to resolve it.
To fix this, make sure to wrap any text values, like city names, unit types, transportation modes and others in quotation marks (e.g., use "Berlin" instead of Berlin).
Another cause for this that Excel is not able to install the Add-In properly and is therefore unable to resolve the Climatiq formulas. In this case there should also be an error message shown in the footer bar of Excel. You can try to reinstall the add-in if custom functions are not recognized. You can reinstall the Add-In by first navigating to the Add-in management view (Main Menu Bar - “Add-Ins” - “More Add-Ins” - “My Add-Ins”) and deleting the Add-In. You can then re-install it via the same view. If these fixes do not work, your company policies might block external Add-Ins from loading.
What does the “You do not have access to this feature” message mean?
You have already exceeded your monthly limit of 500 free calculations, or you are trying to access an calculation feature that is not part of your current subscription plan with Climatiq. Get in touch with our sales team to start a free trial based on your needs, or to learn more about our paid plans to upgrade for more access.
Why isn’t the Climatiq add-in showing up in Excel after adding it via the Microsoft AppSource?
The add-in may not be installed correctly. If the Climatiq Logo is appearing on your Excel navigation bar, but none of the formulas are working, you can try to reinstall the add-in. You can reinstall the Add-In by navigating to the Add-in management view (Main Menu Bar - “Add-Ins” - “More Add-Ins” - “My Add-Ins”) and first deleting it. Afterwards you can re-install it via the search bar in the same view. If the logo is not appearing in the navigation bar, open Excel > Click the red “Add-ins” button on the top right and search for “Climatiq” to install it.
Why is my API key not setting?
The key was not copied correctly, or has been set in the incorrect format. Copy the key carefully and ensure it is entered correctly in the add-in settings. And if you are using =CLIMATIQ.SETKEY("API_KEY"), ensure that the API Key is in quotation marks ("").
How do I share an Excel sheet with Climatiq formulas?
If the recipient does not have the Climatiq Add-In installed, the Climatiq formulas will not be properly calculated in their Excel environments. Therefore, you will want to make sure to replace any cells using Climatiq formulas with the calculated values by copying the formula results and pasting them as values (Paste Special > Values).
Why am I getting an “Error loading add-ins” or “Error installing functions” message?
These errors are usually caused by internal company firewalls blocking the required resources to be loaded.
First try clicking the Climatiq Add-In in the Excel ribbon to manually initialize it. Alternatively, you can try to reinstall the Add-In. You can reinstall the Add-In by navigating to the Add-In management view (Main Menu Bar - “Add-Ins” - “More Add-Ins” - “My Add-Ins”) and first deleting it. Afterwards you can re-install it via the search bar in the same view.
If these fixes do not work, your company policies might be blocking external Add-Ins from loading. Ask your IT team to allow access to https://climatiqexcel.z1.web.core.windows.net (via port 443) and ensure network settings do not block JSON file requests.
Security
How are updates to the Add-In being handled?
Whenever an update to the Add-In is being published, Excel will automatically install the latest version for you. Microsoft Excel does currently not support an opt-out for new versions of Add-Ins. To stay up-to-date with new releases and improvements of the Add-Ins, you can check out our Changelog and subscribe to our monthly Release Notes (opens in a new tab).
Does Climatiq have specific certifications (ISO, SOC 2, GDPR) that cover data processed via the Excel add-in?
Climatiq's compliance with ISO 27:001, SOC2 and GDPR is externally certified - you can find further details in our Trust Center (opens in a new tab).
How exactly is data routed from Excel to the Climatiq platform and back?
The diagram below shows a high-level overview of the dataflows between Excel and the Climatiq API. For more details, please reach out to us.
What are the types of data that are stored by Climatiq when using the Add-In?
Climatiq does not store the transacted business data that is part of the request. The only exception here is the search query of Autopilot requests. This data point will be fully anonymized, aggregated and potentially used as training data to further improve the accuracy of Autopilot. As the data is stripped of any user context before being used for training, no tracebacks to the original source of the data point can be made.
Additionally, other types of data are retained, all stored on servers within the European Union:
- Project Data: Configuration data, project name, API keys
- User PII: Account data like email and name and surname are stored after the sign-up
- Client IP Addresses: Belonging to end users, programs or servers that perform requests to the Climatiq API or use our Dashboard.
- API Request Metadata: Request metadata generated during an API call is stored as logs
All data access is strictly controlled and audited as part of Climatiq's ISO27001 certification. Data is deleted upon request or 60 days after contract termination.