### Climatiq API Base URL Source: https://www.climatiq.io/docs/api-reference/index The base URL for all requests to the Climatiq API. All operations must be performed over HTTPS. ```HTTP https://api.climatiq.io ``` -------------------------------- ### Enable Compression with Accept-Encoding Header Source: https://www.climatiq.io/docs/api-reference/index To enable compression for API requests, set the 'Accept-Encoding' header to 'gzip' for gzip compression or 'br' for brotli compression. ```HTTP Accept-Encoding: gzip ``` -------------------------------- ### Cloud Computing Metadata Response Example Source: https://www.climatiq.io/docs/api-reference/computing An example JSON response from the metadata endpoint, illustrating the structure of cloud provider information, including their full names, IDs, available regions, and virtual machine instance types. ```JSON { "cloud_providers":{ "aws":{ "provider_full_name":"Amazon Web Services", "provider_id":"aws", "regions":[ "af_south_1", "ap_east_1", "ap_northeast_1" // ... ], "virtual_machine_instances":[ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium" // ... ] }, "azure":{ "provider_full_name":"Microsoft Azure", "provider_id":"azure", "regions":[ "central_india", "central_us" // ... ] // ... } // More providers here } } ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/computing An example JSON response from the Climatiq API, illustrating the structure of total CO2e, memory estimates, and CPU estimates. It includes detailed information about emission factors, constituent gases, activity data, and audit trails for each estimate. ```json { "total_co2e":0.7436, "total_co2e_unit":"kg", "memory_estimate":{ "co2e":0.1382, "co2e_unit":"kg", "co2e_calculation_method":"ar5", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid", "activity_id":"electricity-supply_grid-source_supplier_mix", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3", "access_type":"public", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":2024, "region":"GB", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":0.1382, "co2e_other":null, "co2":0.1368, "ch4":0.00002143, "n2o":0.000003071 }, "activity_data":{ "activity_value":0.6675, "activity_unit":"kWh" }, "audit_trail":"enabled", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":"2024", "region":"GB", "region_name":"United Kingdom", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3" } ] }, "cpu_estimate":{ "co2e":0.1065, "co2e_unit":"kg", "co2e_calculation_method":"ar5", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid", "activity_id":"electricity-supply_grid-source_supplier_mix", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3", "access_type":"public", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":2024, "region":"GB", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":0.1065, "co2e_other":null, "co2":0.1054, "ch4":0.00001651, "n2o":0.000002366 }, "activity_data":{ "activity_value":0.5143, "activity_unit":"kWh" }, "audit_trail":"enabled", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":"2024", "region":"GB", "region_name":"United Kingdom", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3" } ] } } ``` -------------------------------- ### Climatiq API Response Example (JSON) Source: https://www.climatiq.io/docs/api-reference/travel/travel-v1-preview1 An example of a typical JSON response from the Climatiq API, illustrating the structure and data types for CO2 emissions, calculation details, source information, and location. ```json { "co2e":80.5, "co2e_unit":"kg", "co2e_calculation_method":"ipcc_ar5_gwp100", "source_trail":[ { "data_category":"emission_factor", "name":"Hotel stay", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2025", "year":"2025", "region":"US", "region_name":"United States of America (the)", "id":"5a8c1cd3-bbc9-49d4-87bd-b1102e3866ae" } ], "location":{ "name":"United States of America (the)", "confidence_score":1 }, "notices":[] } ``` -------------------------------- ### API Response Example - Emission Factors Source: https://www.climatiq.io/docs/api-reference/search An example of the JSON response from the Climatiq API, showing a paginated list of emission factors with details such as activity ID, name, source, units, and region. ```json { "current_page":1, "last_page":5, "total_results":5, "results":[ { "activity_id":"commercial_vehicle-vehicle_type_truck_light-fuel_source_na-engine_size_na-vehicle_age_na-vehicle_weight_na", "id":"74cf2bf2-0843-46a8-aa30-8df002264e14", "name":"Light-Duty Truck", "category":"Vehicles", "sector":"Transport", "source":"EPA", "source_link":"https://www.epa.gov/climateleadership/ghg-emission-factors-hub", "source_dataset":"2021 GHG Emission Factors Hub", "uncertainty":null, "year":2021, "year_released":2021, "region":"US", "region_name":"United States of America (the)", "description":"Emission intensity of light duty truck (includes full-size pickup trucks/full-size vans/extended-length SUVs with wheelbase greater than 121 inches). Retrieved from the EPA's GHG Emission Factors Hub (xlsx).", "unit_type":"Distance", "unit":"kg/mile", "source_lca_activity":"use_phase", "data_quality_flags":[], "access_type":"public", "supported_calculation_methods":[ "ar4", "ar5", ``` -------------------------------- ### API Response Example Source: https://www.climatiq.io/docs/api-reference/autopilot An example of the JSON response from the Climatiq API, showing a CO2e estimate for 'Cast iron and steel' with details on the calculation method, constituent gases, activity data, and source information. ```json { "estimate":{ "co2e":47, "co2e_unit":"kg", "co2e_calculation_method":"ar4", "co2e_calculation_origin":"climatiq", "emission_factor":{ "name":"Cast iron and steel", "activity_id":"metals-type_cast_iron_steel", "id":"15e75a68-b485-494b-8cbc-398d417207a7", "access_type":"public", "source":"EPA", "source_dataset":"Supply Chain Factors Dataset (commodities)", "year":2018, "region":"US", "category":"Metals", "source_lca_activity":"cradle_to_shelf", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":null, "co2e_other":0.7, "co2":41.3, "ch4":0.2, "n2o":0 }, "activity_data":{ "activity_value":100, "activity_unit":"usd" }, "audit_trail":"enabled" }, "calculation_details":{ "label":"accept", "inflation_applied":0 }, "source_trail":[ { "data_category":"emission_factor", "name":"Cast iron and steel", "source":"EPA", "source_dataset":"Supply Chain Factors Dataset (commodities)", "year":"2018", "region":"US", "region_name":"United States of America (the)", "id":"15e75a68-b485-494b-8cbc-398d417207a7" } ], "notices":[], "model":"general", "model_version":"27", "data_version":"24" } ``` -------------------------------- ### Estimate Batch Endpoint Request Example Source: https://www.climatiq.io/docs/api-reference/batch-endpoints This snippet shows a typical request body for the batch estimate endpoint. It includes an array of emission factor objects, each with parameters for energy consumption. The example demonstrates sending both valid and invalid requests to the batch endpoint. ```json [ { "emission_factor":{ "activity_id":"electricity-supply_grid-source_residual_mix", "data_version":"^6" }, "parameters":{ "energy":100, "energy_unit":"kWh" } }, { "emission_factor":{ "activity_id":"electricity-supply_grid-source_residual_mix" }, "parameters":{ "energy":100, "energy_unit":"kWh" } } ] ``` -------------------------------- ### Create Project Response (Management API) Source: https://www.climatiq.io/docs/api-reference/management Example JSON response after successfully creating a project. It returns the details of the newly created project, including its ID, name, and owner. ```json { "id":"1234", "project_name":"My New project", "owner":{ "id":"5678" } } ``` -------------------------------- ### List Projects Response (Management API) Source: https://www.climatiq.io/docs/api-reference/management Example JSON response when listing projects. It returns an array of project objects, each with an ID, project name, and owner details. ```json [ { "id":"1234", "project_name":"Your project name", "owner":{ "id":"5678" } } ] ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/autopilot Provides a sample JSON response from the Climatiq API, detailing the estimated CO2e, calculation method, constituent gases, activity data, and source trail. ```json { "estimate":{ "co2e":79.52, "co2e_unit":"kg", "co2e_calculation_method":"ar4", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Cement (CEM II 42.5)", "activity_id":"building_materials-type_cement_cem_ii_42.5", "id":"d022f8c4-d039-4349-a05a-21c181c68471", "access_type":"public", "source":"OEKOBAUDAT", "source_dataset":"OEKOBAUDAT 2023-I", "year":2018, "region":"DE", "category":"Building Materials", "source_lca_activity":"cradle_to_gate", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":79.52, "co2e_other":null, "co2":null, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":100, "activity_unit":"kg" }, "audit_trail":"enabled" }, "calculation_details":{ "inflation_applied":0 }, "source_trail":[ { "data_category":"emission_factor", "name":"Cement (CEM II 42.5)", "source":"OEKOBAUDAT", "source_dataset":"OEKOBAUDAT 2023-I", "year":"2018", "region":"DE", "region_name":"Germany", "id":"d022f8c4-d039-4349-a05a-21c181c68471" } ], "notices":[] } ``` -------------------------------- ### Add Custom Mapping Labels Response Example Source: https://www.climatiq.io/docs/api-reference/custom-mappings This snippet shows an example JSON response from the Climatiq API after successfully adding custom mapping labels. It includes the label, a suggested activity ID, and a unique mapping ID. ```json [ { "label":"hotel", "activity_id":"accommodation_type_hotel_room", "id":"35354707520" } ] ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/custom-mappings This is an example of the JSON response received from the Climatiq API after a successful CO2e estimation request. It includes the calculated CO2e value, unit, calculation method, details about the emission factor used, constituent gases, and activity data. ```json { "co2e":24.7, "co2e_unit":"kg", "co2e_calculation_method":"ar4", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Accommodation services", "activity_id":"accommodation_type_accommodation_services", "id":"de9e8e96-f7c9-4c98-9263-6f1b5a1f40d0", "access_type":"public", "source":"BEIS", "source_dataset":"UK full dataset including conversion factors by SIC code", "year":2019, "region":"GB", "category":"Accommodation", "source_lca_activity":"unknown", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":24.7, "co2e_other":null, "co2":14.7, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":100.0, "activity_unit":"gbp" }, "audit_trail":"selector" } ``` -------------------------------- ### Autopilot Endpoint Request Example Source: https://www.climatiq.io/docs/api-reference/autopilot This snippet demonstrates a typical request to the Autopilot endpoint, including parameters for defining the model and specifying sources to include or exclude. It highlights how to leverage the AI capabilities for emission estimations. ```json { "model": "general", "source": ["BEIS", "ecoinvent"], "exclude_source": ["WRAP"] } ``` -------------------------------- ### Authenticate with Climatiq API Key Source: https://www.climatiq.io/docs/api-reference/authentication This snippet demonstrates how to authenticate your application with the Climatiq API by providing your API key as a bearer token in the Authorization header. Ensure you replace 'CLIMATIQ_API_KEY' with your actual API key. ```HTTP Authorization: Bearer CLIMATIQ_API_KEY ``` -------------------------------- ### Example Emission Factor Data Structure Source: https://www.climatiq.io/docs/api-reference/search This snippet shows the typical JSON structure for an emission factor, including its factor value, calculation method, origin, and constituent gases. ```JSON { "factor": 0.4671, "factor_calculation_method": "ar6", "factor_calculation_origin": "climatiq", "constituent_gases": { "co2e_total": null, "co2e_other": null, "co2": 0.464, "ch4": 0.000012, "n2o": 0.00001 }, "data_version": { "status": "up_to_date" }, "data_version_information": { "status": "up_to_date" } } ``` -------------------------------- ### Example Possible Filters Structure Source: https://www.climatiq.io/docs/api-reference/search This snippet illustrates the structure of the `possible_filters` object, which provides metadata for refining emission factor searches, including available years, sources, regions, categories, and sectors. ```JSON { "possible_filters": { "year": [ 2021 ], "source": [ { "source": "EPA", "datasets": [ "2021 GHG Emission Factors Hub" ] }, { "source": "GHG Protocol", "datasets": [ "GHG Emissions Calculation Tool" ] } ], "region": [ { "id": "US", "name": "United States of America (the)" } ], "category": [ "Fuel", "Vehicles" ], "sector": [ "Energy", "Transport" ], "unit_type": [ "Distance", "Volume" ], "source_lca_activity": [ "fuel_combustion", "use_phase" ], "access_type": [ "public" ], "data_quality_flags": [ "notable_methodological_variance" ] } } ``` -------------------------------- ### Search Emission Factors with cURL (Climatiq API) Source: https://www.climatiq.io/docs/api-reference/search This example shows how to perform a search for emission factors using cURL. It specifies query parameters like 'query', 'data_version', 'year', and 'results_per_page', along with the necessary Authorization header. ```curl curl --request GET \ --url 'https://api.climatiq.io/data/v1/search?query=light+duty+trucks&data_version=^21&year=2021&results_per_page=1' \ --header "Authorization: Bearer $CLIMATIQ_API_KEY" ``` -------------------------------- ### Estimate Emissions with Climatiq API Source: https://www.climatiq.io/docs/api-reference/autopilot Calculate an emission estimation by providing a suggestion ID and relevant parameters like weight. This example demonstrates a POST request to the Climatiq API's estimate endpoint. ```curl curl --request POST \ --url https://preview.api.climatiq.io/autopilot/v1-preview4/suggest/estimate \ --header "Authorization: Bearer $CLIMATIQ_API_KEY"\ --data '{ \ "suggestion_id": "mqydemtghbrtillegaztsljugm2dsllbga2wcljsgfrtcobrmm3dqnbxge-ge3gcmzvgy3tmzbqgm2timbqmy4dimtegaydambqgaydambqgayq", \ "parameters": { \ "weight": 100, \ "weight_unit": "kg" \ } }' ``` -------------------------------- ### Country-Level Region Code Example Source: https://www.climatiq.io/docs/api-reference/regions Demonstrates the use of a two-letter country code, following the ISO 3166-1 alpha-2 standard, to specify a region for emission factor lookups. ```text DK GB ``` -------------------------------- ### Calculate CPU Emissions (cURL) Source: https://www.climatiq.io/docs/api-reference/computing Example cURL command to calculate CPU emissions using the Climatiq API. It specifies the provider (e.g., 'azure'), the endpoint, authorization header, and the request body containing calculation parameters. ```bash curl --request POST \ --url https://api.climatiq.io/compute/v1/azure/cpu \ --header "Authorization: Bearer $CLIMATIQ_API_KEY"\ --data '{ \ "cpu_count": 1, \ "region": "uk_west", \ "average_vcpu_utilization": 0.75, \ "duration": 1, \ "duration_unit": "h" \ }' ``` -------------------------------- ### Get All Unit Types - Climatiq API Source: https://www.climatiq.io/docs/api-reference/unit-types Retrieves all available unit types and their respective supported units from the Climatiq API. This endpoint requires an API key for authentication. ```bash curl --request GET \ --url 'https://api.climatiq.io/data/v1/unit-types' \ --header "Authorization: Bearer $CLIMATIQ_API_KEY" ``` -------------------------------- ### API Response Example - Emission Factor Details Source: https://www.climatiq.io/docs/api-reference/autopilot This snippet demonstrates a typical JSON response from the Climatiq API, showcasing a specific emission factor for 'Cement' within the 'Building Materials' category. It includes details about the source, units, year, geographical relevance, and data quality. ```json { "results": [ { "suggestion_id": "giytkntbha4weljxmjstqljugqydkllbmfrdsljqga2ggylemu4wmzdfme-hbrtizteg44wmllegvsgcljumezdqllche4tmljsmm4dinzsgu4wcojugi", "emission_factor": { "sector": "Materials and Manufacturing", "category": "Building Materials", "name": "Cement", "unit_type": "Money", "unit": "kg/usd", "source": "EPA", "source_dataset": "Supply Chain Greenhouse Gas Emission Factors v1.3", "year": 2022, "year_released": 2024, "region": "US", "region_name": "United States of America (the)", "description": "Emission intensity of supply chain (with margins i.e. cradle to shelf) in US dollars spend on: cement manufacturing. This factor is representative of the described goods or services category as defined by the 2017 version of the North American Industry Classification System (NAICS). Refer to the source for the source-specific data quality assessment. Retrieved from Supply Chain Factors Dataset v1.3.", "source_link": "https://cfpub.epa.gov/si/si_public_record_Report.cfm?dirEntryId=349324&Lab=CESER", "source_lca_activity": "cradle_to_shelf", "data_quality_flags": [], "access_type": "public" }, "suggestion_details": { "label": "accept" } }, { "suggestion_id": "gjrwmmjzmizdcllegu3wcljugntgkljygq4wmlldmzrgeolfgbstgolbga-hbrtizteg44wmllegvsgcljumezdqllche4tmljsmm4dinzsgu4wcojugi", "emission_factor": { "sector": "Materials and Manufacturing", "category": "Building Materials", "name": "Cement - unspecified (market for)", "unit_type": "Weight", "unit": "kg/kg", "source": "ecoinvent", ``` -------------------------------- ### API Response Example - Emission Factor Data Source: https://www.climatiq.io/docs/api-reference/autopilot/autopilot-v1-preview3 This JSON snippet demonstrates a typical response from the Climatiq API, showcasing a specific emission factor for 'Cement' with its associated details, including sector, category, unit, source, and year. It also includes suggestion details like confidence and similarity score. ```json { "results": [ { "suggestion_id": "giytkntbha4weljxmjstqljugqydkllbmfrdsljqga2ggylemu4wmzdfme-gyzwgzrvgu4geljwmi2dgljumuzgmljyg5rtolldgm2winbsgyygimztmy", "emission_factor": { "sector": "Materials and Manufacturing", "category": "Building Materials", "name": "Cement", "unit_type": "Money", "unit": "kg/usd", "source": "EPA", "source_dataset": "Supply Chain Greenhouse Gas Emission Factors v1.3", "year": 2022, "year_released": 2024, "region": "US", "region_name": "United States of America (the)", "description": "Emission intensity of supply chain (with margins i.e. cradle to shelf) in US dollars spend on: cement manufacturing. This factor is representative of the described goods or services category as defined by the 2017 version of the North American Industry Classification System (NAICS). Refer to the source for the source-specific data quality assessment. Retrieved from Supply Chain Factors Dataset v1.3.", "source_link": "https://cfpub.epa.gov/si/si_public_record_Report.cfm?dirEntryId=349324&Lab=CESER", "source_lca_activity": "cradle_to_shelf", "data_quality_flags": [], "access_type": "public" }, "suggestion_details": { "similarity_score": 1, "confidence": "high" } }, { "suggestion_id": "mnrtmytgmzrwiljtga4gmljumjqtsllbmuzggljwgvrwcytbmiydkmrzga-gyzwgzrvgu4geljwmi2dgljumuzgmljyg5rtolldgm2winbsgyygimztmy", "emission_factor": { "sector": "Materials and Manufacturing", "category": "Building Materials", "name": "Cement - unspecified (market group for)", "unit_type": "Weight", "unit": "kg/kg", "source": "ecoinvent", "source_dataset": "Cut-off Cumulative LCIA v3.11", "year": 2019, "year_released": 2024, "region": "GLOBAL", "region_name": "Global" } } ] } ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/estimate This JSON object represents a typical response from the Climatiq API, providing details about carbon emissions, calculation methods, and associated data. It includes fields for CO2 equivalent, units, calculation methodology, and audit trail information. ```json { "co2e":89.6, "co2e_unit":"kg", "co2e_calculation_method":"ar6", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid - residual mix", "activity_id":"electricity-supply_grid-source_residual_mix", "id":"0fa80a77-1ad9-4cc1-b354-cc491a21ad26", "access_type":"public", "source":"AIB", "source_dataset":"European Residual Mix", "year":2024, "region":"RS", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":[ "partial_factor" ] }, "constituent_gases":{ "co2e_total":89.6, "co2e_other":null, "co2":89.6, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":100, "activity_unit":"kWh" }, "audit_trail":"selector", "notices":[] } ``` -------------------------------- ### API Response Example - CO2e Estimate Source: https://www.climatiq.io/docs/api-reference/procurement This JSON snippet demonstrates a typical response from the Climatiq API, showing the estimated CO2e value, units, calculation method, and details about the emission factor used. It also includes constituent gases, activity data, and audit trail status. ```json { "estimate":{ "co2e":15.66, "co2e_unit":"kg", "co2e_calculation_method":"ar5", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Fabricated metal products/except machinery and equipment", "activity_id":"metal_products-type_fabricated_metal_products_except_machinery_equipment", "id":"f30ce73e-6f49-46ac-8840-c0bee742164c", "access_type":"public", "source":"EXIOBASE", "source_dataset":"EXIOBASE 3", "year":2019, "region":"DE", "category":"Fabricated Metal Products", "source_lca_activity":"unknown", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":15.66, "co2e_other":null, "co2":null, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":61.03, "activity_unit":"eur" }, "audit_trail":"enabled" }, "calculation_details":{ "tax_margin":0.2, "trade_margin":0.09792972014, "transport_margin":0, "inflation_applied":0.15036269600000027 }, "notices":[], "source_trail":[ { "data_category":null, "name":"Average trade margins for spend type", "source":"EXIOBASE", "source_dataset":null, "year":null, "region":"DE", "region_name":"Germany", "id":null }, { "data_category":null, "name":"Average transport margins for spend type", "source":"EXIOBASE", "source_dataset":null, "year":null, "region":"DE", "region_name":"Germany", "id":null }, { "data_category":null, "name":"Industry-specific inflation rates", "source":"EUROSTAT", "source_dataset":null, "year":null, "region":"DE", "region_name":"Germany", "id":null }, { "data_category":"emission_factor", "name":"Fabricated metal products/except machinery and equipment", "source":"EXIOBASE", "source_dataset":"EXIOBASE 3", "year":"2019", "region":"DE", "region_name":"Germany", "id":"f30ce73e-6f49-46ac-8840-c0bee742164c" } ] } ``` -------------------------------- ### EstimationWithSourceTrail JSON Example Source: https://www.climatiq.io/docs/api-reference/models/estimation This JSON object represents the output of the EstimationWithSourceTrail model. It includes core emission data such as CO2e, units, calculation methods, and detailed emission factor information. Crucially, it features the 'source_trail' array, which provides a step-by-step breakdown of the data used in the calculation, enhancing transparency and trust. ```JSON { "co2e":0.0007366, "co2e_unit":"kg", "co2e_calculation_method":"ar5", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid", "activity_id":"electricity-supply_grid-source_supplier_mix", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3", "access_type":"public", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":2024, "region":"GB", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":[] }, "constituent_gases":{ "co2e_total":0.0007366, "co2e_other":null, "co2":0.0007291, "ch4":1.142e-7, "n2o":1.637e-8 }, "activity_data":{ "activity_value":0.003558, "activity_unit":"kWh" }, "audit_trail":"enabled", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2024", "year":"2024", "region":"GB", "region_name":"United Kingdom", "id":"0de2d70a-4704-48f4-b862-1a86da206dd3" } ] } ``` -------------------------------- ### Estimation Model Response Example Source: https://www.climatiq.io/docs/api-reference/models/estimation This JSON object represents a typical response from an estimation-related endpoint in the Climatiq API. It includes the total CO2e emissions, the emission factor used, constituent gases, activity data, and audit trail information. ```json { "co2e":89.6, "co2e_unit":"kg", "co2e_calculation_method":"ar6", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid - residual mix", "activity_id":"electricity-supply_grid-source_residual_mix", "id":"0fa80a77-1ad9-4cc1-b354-cc491a21ad26", "access_type":"public", "source":"AIB", "source_dataset":"European Residual Mix", "year":2024, "region":"RS", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":[ "partial_factor" ] }, "constituent_gases":{ "co2e_total":89.6, "co2e_other":null, "co2":89.6, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":100, "activity_unit":"kWh" }, "audit_trail":"selector", "notices":[] } ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/travel/travel-v1-preview1 This JSON object represents a typical response from the Climatiq API, detailing the carbon emissions for a journey. It includes total CO2e, units, calculation method, distance, origin and destination details, and breakdowns of direct and indirect emissions with their respective source trails. ```json { "co2e":45.16, "co2e_unit":"kg", "co2e_calculation_method":"ipcc_mixed_gwp100", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid - production mix", "source":"AIB", "source_dataset":"European Residual Mix", "year":"2022", "region":"DE", "region_name":"Germany", "id":"93fd4e16-4dbc-4d42-a2b3-3295441f3805" }, { "data_category":"emission_factor", "name":"Petrol (100% mineral petrol)", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2023", "year":"2023", "region":"GB", "region_name":"United Kingdom", "id":"4c4e7091-620d-47ca-9c95-316ffa49b9a1" }, { "data_category":"emission_factor", "name":"Petrol (100% mineral petrol)", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2023", "year":"2023", "region":"GB", "region_name":"United Kingdom", "id":"ba362f0a-f84a-469d-9ee0-3c0dae69ab57" } ], "distance_km":305.1, "origin":{ "name":"Hamburg", "latitude":53.51666, "longitude":9.93333, "confidence_score":null }, "destination":{ "name":"Berlin, Germany", "latitude":52.51604, "longitude":13.37691, "confidence_score":1 }, "direct_emissions":{ "co2e":34.94, "co2e_unit":"kg", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid - production mix", "source":"AIB", "source_dataset":"European Residual Mix", "year":"2022", "region":"DE", "region_name":"Germany", "id":"93fd4e16-4dbc-4d42-a2b3-3295441f3805" }, { "data_category":"emission_factor", "name":"Petrol (100% mineral petrol)", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2023", "year":"2023", "region":"GB", "region_name":"United Kingdom", "id":"ba362f0a-f84a-469d-9ee0-3c0dae69ab57" } ] }, "indirect_emissions":{ "co2e":10.22, "co2e_unit":"kg", "source_trail":[ { "data_category":"emission_factor", "name":"Electricity supplied from grid - production mix", "source":"AIB", "source_dataset":"European Residual Mix", "year":"2022", "region":"DE", "region_name":"Germany", "id":"93fd4e16-4dbc-4d42-a2b3-3295441f3805" }, { "data_category":"emission_factor", "name":"Petrol (100% mineral petrol)", "source":"BEIS", "source_dataset":"Greenhouse gas reporting: conversion factors 2023", "year":"2023", "region":"GB", "region_name":"United Kingdom", "id":"4c4e7091-620d-47ca-9c95-316ffa49b9a1" } ] }, "notices":[] } ``` -------------------------------- ### Estimate Batch Endpoint Response Example Source: https://www.climatiq.io/docs/api-reference/batch-endpoints This snippet displays the response from the batch estimate endpoint. It details the results of each calculation within the batch request, including CO2e emissions for successful operations and error messages for failed ones due to missing data. ```json { "results":[ { "co2e":95.42, "co2e_unit":"kg", "co2e_calculation_method":"ar4", "co2e_calculation_origin":"source", "emission_factor":{ "name":"Electricity supplied from grid - residual mix", "activity_id":"electricity-supply_grid-source_residual_mix", "id":"eefd06c3-1c7a-447c-aaf5-fe958bfa470e", "access_type":"public", "source":"AIB", "source_dataset":"European Residual Mix", "year":2022, "region":"RS", "category":"Electricity", "source_lca_activity":"electricity_generation", "data_quality_flags":["partial_factor","notable_methodological_variance"] }, "constituent_gases":{ "co2e_total":95.42, "co2e_other":null, "co2":95.42, "ch4":null, "n2o":null }, "activity_data":{ "activity_value":100.0, "activity_unit":"kWh" }, "audit_trail":"selector", "notices":[] }, { "error":"bad_request", "error_code":"invalid_input", "message":"Selector should either provide an 'id', OR a 'data_version' and an 'activity_id'. It must not provide both. The latest 'data_version' is '6.6'" } ] } ``` -------------------------------- ### Climatiq API Response Example Source: https://www.climatiq.io/docs/api-reference/pcf A sample JSON response from the Climatiq API, illustrating the structure of CO2e estimates and their detailed breakdown. This includes total emissions, calculation method, data quality, and specific emission contributions from component production, freight, and manufacturing. ```json { "co2e_kg": 5.295, "co2e_calculation_method": "ipcc_mixed_gwp100", "data_quality_rating": 2.229, "co2e_breakdown": { "component_production_co2e_kg": 2.12, "component_freight_co2e_kg": 2.947, "manufacturing_co2e_kg": 0.2279 }, "manufacturing": { "electricity": { "consumption": { "co2e": 0.1891, "co2e_unit": "kg", "co2e_calculation_method": "ipcc_ar6_gwp100", "source_trail": [ { "data_category": "emission_factor", "name": "Electricity supplied from grid", "source": "IEA", "source_dataset": "IEA Emissions Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada", "id": "5abac8a4-b75f-4c85-b99d-6246ca653c18" } ], "co2_biogenic": null, "constituent_gases": { "co2": 0.1883, "ch4": 0.00001215, "n2o": 0.000001804 } }, "well_to_tank": { "co2e": 0.02854, "co2e_unit": "kg", "co2e_calculation_method": "ipcc_ar6_gwp100", "source_trail": [ { "data_category": "emission_factor", "name": "Electricity supplied from grid", "source": "IEA", "source_dataset": "IEA Life Cycle Upstream Emission Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada", "id": "caa01b09-e7dc-4616-b2cd-469eb7d0e6cf" } ], "co2_biogenic": null, "constituent_gases": { "co2": null, "ch4": null, "n2o": null } }, "transmission_and_distribution": { "co2e": 0.008856, "co2e_unit": "kg", "co2e_calculation_method": "ipcc_ar6_gwp100", "source_trail": [ { "data_category": "emission_factor", "name": "Electricity supplied from grid", "source": "IEA", "source_dataset": "IEA Emissions Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada", "id": "5abac8a4-b75f-4c85-b99d-6246ca653c18" }, { "data_category": "emission_factor", "name": "Electricity supplied from grid: T&D losses", "source": "IEA", "source_dataset": "IEA Emissions Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada", "id": "1f82004a-b979-4362-af6a-29e5ab89eceb" } ], "co2_biogenic": null, "constituent_gases": { "co2": 0.008816, "ch4": 5.69e-7, "n2o": 8.447e-8 } }, "well_to_tank_of_transmission_and_distribution": { "co2e": 0.001336, "co2e_unit": "kg", "co2e_calculation_method": "ipcc_ar6_gwp100", "source_trail": [ { "data_category": "emission_factor", "name": "Electricity supplied from grid", "source": "IEA", "source_dataset": "IEA Emissions Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada", "id": "5abac8a4-b75f-4c85-b99d-6246ca653c18" }, { "data_category": "emission_factor", "name": "Electricity supplied from grid", "source": "IEA", "source_dataset": "IEA Life Cycle Upstream Emission Factors 2024", "year": "2022", "region": "CA", "region_name": "Canada" } ], "co2_biogenic": null, "constituent_gases": { "co2": null, "ch4": null, "n2o": null } } } } } ```