CarbonSutra APIs, Google Sheet functions and MCP servers are used to estimate the carbon emission footprint by organizations and software developers for ESG, sustainability and compliance reporting with frameworks (eg, ISSB, TCFD, GSSB, CDP, BRSR, etc). It is also used in analyzing climate, environment and weather scenarios, mitigation, offsetting, green / net-zero projects and decarbonization programs. Using standards (GRI, SASB, IPCC), data sources (GRI, DEFRA, EPA, ECTA, GHSB, etc), GHG factors of 2026 and transparent algorithms, the API and spreadsheet functions calculates and consolidates CO2 equivalent measurements for 1) business flight across economy, business and first class and global IATA airports; 2) employee office commute by rail, bus, taxi, motorbike and private cars; 3) rented or owned vehicle emissions by make, model, type and size; 4) freight and shipment using land, air, sea and intermodal ways; 5) fuel (solid, liquid and gas); 6) electricity consumption for 90+ countries; 7) hotel stay based on class for 40 countries and 8) land-air based ecommerce shipping using advanced logistics logic. In addition, supplementary APIs are provided to find nearest airport from a postal code based on latitude and longitude, distance between two based on lat-long and the names of airports based on keywords.
\nOur mission is to simplify the calculation of carbon emission footprint for organizations and software developers. We accomplish this by focusing on building algorithms with quality documentation and transparent output and make them available through APIs, MCP servers and Google Sheets functions.
\nBusiness travel for flights across 9,000+ airports with upstream inclusion and well-to-tank options
\nStationary fuel consumption for industrial, commercial, transport and residential use
\nOwned/leased passenger vehicles across 140 makes and 4,500 models
\nVehicles based on type/size and business
\nTravel/commute through taxi, bus and trains
\nHotel stay across 40 countries with star ratings
\nElectricity consumption for over 90 countries
\nFreight Shipments for road, rail, sea, air and intermodal
\nAdvanced algorithms for eCommerce shipments covering 1.5 million postal codes
\nThere are two sets of additional APIs available for developers to ease the logic of front end applications - the first set has 5 endpoints on calculating distances between airports and finding the nearest ones. The second set is used to get a list of vehicle makers and their models.
\nWe have made access to APIs easy for non technical users by encapsulating them in functions designed for Google Sheets.
\nEmissions can be grouped in self-defined clusters and retrieved using the labels. This simplifies the need to store the results at developer's end. A key will need to be generated which is then passed as a Bearer Token in all calculations, so that the user can be identified and the results are securely delivered.
\nBased in Singapore, we are experienced professionals with formal education and work in ClimateTech and have consulted reputed global organizations in data challenges across decarbonization pathways and connected systems through custom APIs. We have a rich roadmap for CarbonSutra with dozens of specialized algorithms planned for future release in 2026-27. You can reach us at www.carbonsutra.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Carbon Emission Footprint Calculation for Organizations","slug":"carbon-emission-footprint-calculation-for-organizations"}],"owner":"23339876","collectionId":"09278d3b-e9fe-4bbe-808f-8980b3f70177","publishedId":"2sBY4SKxsd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-04T10:59:00.000Z"},"item":[{"name":"Emission Calculators","item":[{"name":"Flight Travel Estimates","id":"a5f41a1a-3fd8-4333-9d51-756a68a38f70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-ConferenceLAX_Jun26\",\n \"iata_airport_from\":\"DXB\",\n \"iata_airport_to\":\"LAX\",\n \"flight_class\":\"Business\",\n \"round_trip\":\"Y\",\n \"add_rf\":\"Y\",\n \"include_wtt\":\"Y\",\n \"number_of_passengers\":1\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/flight_estimate?iata_airport_from= &iata_airport_to= &flight_class= &round_trip= &number_of_passengers= &add_rf= &include_wtt= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) for business travel through flights/air, based on airport codes of arrival and departure, class of flight and number of passengers.
\nThis calculation is used for reporting Scope 3 emissions for individuals flying for work purposes. The footprint of a flight travel is calculated based on the distance between airports and the travelling class of the passenger.
\noperationId: calculate_emissions_from_business_flight_travel
\nIf there are two passengers in the same flight, but sitting in different classes then two separate API calls are suggested, one for each passenger.
\nAs the ICAO does not apply the radiative forcing (RF) multiplier (accounting for the wider climate effect of emissions arising from aircraft transport at altitude) or distance uplift factor to account for delays/circling and non-direct routes (i.e., not along the straight-line/great-circle between destinations), we have added an option for you to factor it in the calculation. Use the \"add_rf\" field to add this factor.
\nWTT (well-to-tank) emissions consist of all processes between the source of the fuel (the well) through the extraction, processing (refining), storage and delivery phases up until the point of use (the tank) in the plane before take-off. Using the \"include_wtt\" field will add the upstream emission associated with this flight in the estimation.
\nThe departing airport's IATA airport code (The unique 3 digit geocode, also known as IATA location identifier, IATA station code, or location identifier)
\n","type":"text/plain"},"key":"iata_airport_from","value":" "},{"description":{"content":"The arrival airport's IATA airport code (The unique 3 digit geocode, also known as IATA location identifier, IATA station code, or location identifier)
\n","type":"text/plain"},"key":"iata_airport_to","value":" "},{"description":{"content":"The class in which the passenger is travelling. Allowed: [Economy, Premium, Business, First]. It is optional. For NULL or undefined values, an Average factor is used.
\n","type":"text/plain"},"key":"flight_class","value":" "},{"description":{"content":"The default value of \"Y\" means that the traveller has taken the flight from origin to destination and then back to the same origin in the same class, while a \"N\" means a one-way journey.
\n","type":"text/plain"},"key":"round_trip","value":" "},{"description":{"content":"Default: 1. If a NULL or <0 is entered, it is set to 1
\n","type":"text/plain"},"key":"number_of_passengers","value":" "},{"description":{"content":"The default value of \"Y\" adds the radiative forcing multiplier factor in the footprint calculation; \"N\" bypasses it
\n","type":"text/plain"},"key":"add_rf","value":" "},{"description":{"content":"The default value of \"Y\" includes the Well-to-Tank (WTT) factors while \"N\" bypasses it
\n","type":"text/plain"},"key":"include_wtt","value":" "},{"description":{"content":"Identifier to log and aggregate these results under using the Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[{"id":"da2556bc-f04c-4c2e-8987-52ab10817045","name":"Flight Travel Estimates","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-ConferenceLAX_Jun26\",\n \"iata_airport_from\":\"DXB\",\n \"iata_airport_to\":\"LAX\",\n \"flight_class\":\"Business\",\n \"round_trip\":\"Y\",\n \"add_rf\":\"Y\",\n \"include_wtt\":\"Y\",\n \"number_of_passengers\":1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/v1/flight_estimate?iata_airport_from= LAX&iata_airport_to= SIN&flight_class=Economy&round_trip= Y&number_of_passengers= 1&add_rf= Y&include_wtt= Y&cluster_name=KrugerBrent_ID701_Jun26","host":[""],"path":["api","v1","flight_estimate"],"query":[{"key":"iata_airport_from","value":" LAX","description":"The departing airport's IATA airport code (The unique 3 digit geocode, also known as IATA location identifier, IATA station code, or location identifier) "},{"key":"iata_airport_to","value":" SIN","description":"The arrival airport's IATA airport code (The unique 3 digit geocode, also known as IATA location identifier, IATA station code, or location identifier) "},{"key":"flight_class","value":"Economy","description":"The class in which the passenger is travelling. Allowed: [Economy, Premium, Business, First]. It is optional. For NULL or undefined values, an Average\" factor is used. "},{"key":"round_trip","value":" Y","description":"The default value of \"Y\" means that the traveller has taken the flight from origin to destination and then back to the same origin in the same class"},{"key":"number_of_passengers","value":" 1","description":"Default: 1. If a NULL or <1 is entered, it is set to 1"},{"key":"add_rf","value":" Y","description":"The default value of \"Y\" adds the radiative forcing multiplier factor in the footprint calculation; \"N\" bypasses it"},{"key":"include_wtt","value":" Y","description":"The default value of \"Y\" includes the Well-to-Tank (WTT) factors while \"N\" bypasses it"},{"key":"cluster_name","value":"KrugerBrent_ID701_Jun26","description":"Identifier to log and aggregate these results under using the Cluster Data API"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a5f41a1a-3fd8-4333-9d51-756a68a38f70"},{"name":"Hotel Stay Emission Estimates","id":"ab9bb020-17d8-4a33-869a-ae201676842e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\": \"KrugerBrent-Jun26\",\n \"country_code\": \"GB\",\n \"city_name\": \"Manchester\",\n \"hotel_rating\": \"5\",\n \"number_of_nights\": 4,\n \"number_of_rooms\": 1\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/hotel_estimate?country_code= &city_name= &hotel_rating= &number_of_nights= &number_of_rooms= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) based on country of hotel, length of stay, room count, and hotel star rating.
\nCarbonSutra's approach for calculating the carbon footprint of hotel stays is based on Cornell Hotel Sustainability Benchmark Index and UK government's GHG conversion factors published in 2026.
\noperationId: calculate_emissions_from_hotel_stay
\n","urlObject":{"path":["api","v1","hotel_estimate"],"host":[""],"query":[{"description":{"content":"Two digit ISO 3166-1 alpha-2 country code
\n","type":"text/plain"},"key":"country_code","value":" "},{"description":{"content":"City of hotel within the country
\n","type":"text/plain"},"key":"city_name","value":" "},{"description":{"content":"Expedia star classification rating of the hotel. Allowed: [2-5], Default: 4
\n","type":"text/plain"},"key":"hotel_rating","value":" "},{"description":{"content":"Length of stay in nights. Default: 1
\n","type":"text/plain"},"key":"number_of_nights","value":" "},{"description":{"content":"Number of rooms booked, irrespective of count of persons per room. Default: 1
\n","type":"text/plain"},"key":"number_of_rooms","value":" "},{"description":{"content":"Identifier to log and aggregate results under Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[{"id":"46e8439e-b749-4df7-8914-40360496ae22","name":"Example of Hotel Stay in Japan (JP) with no city specified","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-Jun26\",\n \"country_code\":\"JP\",\n \"city_name\":\"\",\n \"hotel_rating\":\"4\",\n \"number_of_nights\":\"2\",\n \"number_of_rooms\":\"1\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/hotel_estimate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Nov 2022 05:29:03 GMT","name":"Date","description":"","type":"text"},{"key":"Server","value":"Apache","name":"Server","description":"","type":"text"},{"key":"Vary","value":"Authorization","name":"Vary","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, private","name":"Cache-Control","description":"","type":"text"},{"key":"X-RateLimit-Limit","value":"60","name":"X-RateLimit-Limit","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"59","name":"X-RateLimit-Remaining","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"","type":"text"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"","type":"text"},{"key":"Content-Secure-Policy","value":"default-src 'none'; script-src 'self' fonts.googleapis.com ; img-src *; style-src 'self';","name":"Content-Secure-Policy","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"","type":"text"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"estimate-hotel-stay\",\n \"country\": \"Japan\",\n \"city_name\": \"\",\n \"hotel_rating\": \"4\",\n \"number_of_nights\": \"2\",\n \"number_of_rooms\": \"1\",\n \"co2e_gm\": 83540,\n \"co2e_kg\": 83.54,\n \"co2e_mt\": 0.08,\n \"co2e_lb\": 184.17,\n \"explanation\": \"CarbonSutra uses the Cornell Hotel Sustainability Benchmarking Index 2026 (CHSB2026) for this calculation, specifically leveraging the mean value from the CHSB validity test for Measure 1 - HCMI Room Night Emission (Carbon Category). For this itinerary of one room and 2 nights, country-level emission factors for Japan have been applied. This methodology relies on the Expedia Star Rating classification system. Where regional data gaps exist, proxy assignments are made according to the transparent governance rules published on carbonsutra.com. For the hotel rating of four stars, an emission factor of 41.77 kgCO2e per room night is used. This footprint evaluates to 83,540 grams of CO2e. Standardized unit conversions render this as 83.54 kg (rounded to two decimal places) or 0.08 metric tons. Scaled against imperial baselines using the conversion factor of 2.20462 (source: GHG conversion factors, 2026), the final metric is expressed as 184.17 lbs.\"\n },\n \"success\": true,\n \"status\": 200\n}"},{"id":"323e4b0b-71ac-408d-8d8b-de33985861fb","name":"Example of Hotel Stay in Salt Lake City, USA (US) ","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"country_code\":\"US\",\n \"city_name\":\"Salt Lake City\",\n \"hotel_rating\":\"5\",\n \"number_of_nights\":\"1\",\n \"number_of_rooms\":\"1\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/hotel_estimate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Nov 2022 05:29:03 GMT","name":"Date","description":"","type":"text"},{"key":"Server","value":"Apache","name":"Server","description":"","type":"text"},{"key":"Vary","value":"Authorization","name":"Vary","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, private","name":"Cache-Control","description":"","type":"text"},{"key":"X-RateLimit-Limit","value":"60","name":"X-RateLimit-Limit","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"59","name":"X-RateLimit-Remaining","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"","type":"text"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"","type":"text"},{"key":"Content-Secure-Policy","value":"default-src 'none'; script-src 'self' fonts.googleapis.com ; img-src *; style-src 'self';","name":"Content-Secure-Policy","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"","type":"text"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"estimate-hotel-stay\",\n \"country\": \"United States of America\",\n \"city_name\": \"Salt Lake City\",\n \"hotel_rating\": \"5\",\n \"number_of_nights\": \"1\",\n \"number_of_rooms\": \"1\",\n \"co2e_gm\": 41700,\n \"co2e_kg\": 41.7,\n \"co2e_mt\": 0.04,\n \"co2e_lb\": 91.93,\n \"explanation\": \"CarbonSutra uses the Cornell Hotel Sustainability Benchmarking Index 2026 (CHSB2026) for this calculation, specifically leveraging the mean value from the CHSB validity test for Measure 1 - HCMI Room Night Emission (Carbon Category). Because specific emission factors for Salt Lake City are unlisted in CHSB2026, fallback data for United States of America has been applied to this calculation of one room and a single night. This methodology relies on the Expedia Star Rating classification system. Where regional data gaps exist, proxy assignments are made according to the transparent governance rules published on carbonsutra.com. For the highest hotel rating of five stars, an emission factor of 41.7 kgCO2e per room night is used. This footprint evaluates to 41,700 grams of CO2e. Standardized unit conversions render this as 41.7 kg (rounded to two decimal places) or 0.04 metric tons. Scaled against imperial baselines using the conversion factor of 2.20462 (source: GHG conversion factors, 2026), the final metric is expressed as 91.93 lbs.\"\n },\n \"success\": true,\n \"status\": 200\n}"}],"_postman_id":"ab9bb020-17d8-4a33-869a-ae201676842e"},{"name":"Vehicles Estimates by Type","id":"41756918-dd62-4b5d-9cc5-0a08fbabb66f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-Exhibition-2025\",\n \"vehicle_type\":\"Car-Type-Supermini\",\n \"fuel_type\":\"petrol\",\n \"distance_value\":8800,\n \"distance_unit\":\"km\",\n \"include_wtt\":\"N\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/vehicle_estimate_by_type?vehicle_type= &distance_unit= &distance_value= &fuel_type= &include_wtt= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) for travel in vehicles based on its type.
\noperationId: calculate_emissions_from_vehicle_usage_based_on_type
\n","urlObject":{"path":["api","v1","vehicle_estimate_by_type"],"host":[""],"query":[{"description":{"content":"Type of vehicle
\n","type":"text/plain"},"key":"vehicle_type","value":" "},{"description":{"content":"Enter \"km\" for kilometers and \"mi\" for miles. Default is \"km\"
\n","type":"text/plain"},"key":"distance_unit","value":" "},{"description":{"content":"Distance travelled. If an undefined value is passed, it will be set to 1.00
\n","type":"text/plain"},"key":"distance_value","value":" "},{"description":{"content":"Applicable for cars, these 5 values are allowed: [\"Diesel\", \"Petrol\", \"PHEV\", \"BEV\", \"Unknown\"]. If unsure then use \"Unknown\", which is the default value.
\n","type":"text/plain"},"key":"fuel_type","value":" "},{"description":{"content":"The default value of \"Y\" includes the Well-to-Tank (WTT) factors while \"N\" bypasses it.
\n","type":"text/plain"},"key":"include_wtt","value":" "},{"description":{"content":"Identifier to log and aggregate results under the Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"41756918-dd62-4b5d-9cc5-0a08fbabb66f"},{"name":"Vehicles Estimates by Model","id":"8da3c11f-2436-40fd-bb4a-b1c13e984aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KB-Oct-2025\",\n \"distance_unit\":\"km\",\n \"distance_value\":9500,\n \"vehicle_make\":\"Lexus\",\n \"vehicle_model\":\"RX 300\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/vehicle_estimate_by_model?vehicle_make= &vehicle_model= &distance_unit=&distance_value= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) for travel in vehicles based on its make and model.
\n145 Makes and 5,000 models are covered. To get the specific name of make and model, use the supplementary APIs or access the database at: https://www.carbonsutra.com/data-vehicle-make-model
\noperationId: calculate_emissions_from_vehicle_usage_based_on_make_and_model
\nIf you do not know the make and model of vehicle, we suggest to use the API which calculates emissions by Vehicle Type.
\nFor dual fuel vehicles, the average of emissions from its conventional and alternative fuels is used.
\nIf a model is released across multiple years by the same maker, then the emissions for that model are averaged.
\nName of Vehicle Make. Retrieve it from Supplementary API or documentation
\n","type":"text/plain"},"key":"vehicle_make","value":" "},{"description":{"content":"Name of Vehicle Model. Retrieve it from Supplementary API or documentation
\n","type":"text/plain"},"key":"vehicle_model","value":" "},{"description":{"content":"Enter \"km\" for kilometers and \"mi\" for miles. Default is \"mi\".
\n","type":"text/plain"},"key":"distance_unit","value":""},{"description":{"content":"Distance travelled. If an undefined value is passed, it will be set to 1.00
\n","type":"text/plain"},"key":"distance_value","value":" "},{"description":{"content":"Identifier to log and aggregate these results under using the Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"8da3c11f-2436-40fd-bb4a-b1c13e984aa9"},{"name":"Electricity Usage Estimates","id":"43316009-fd03-43ee-9a08-7a1de8e9e8f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"country_name\":\"Germany\", \n \"electricity_unit\":\"mwh\",\n \"electricity_value\":1100\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/electricity_estimate?country_name=&electricity_unit=&electricity_value=&cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) from electricity usage based on coutnry name and units of electricity consumed.
\nData from nearly 90 countries for years 2020, 2024 and 2026, from multiple sources has been compiled.
\noperationId: calculate_emissions_from_electricity_usage
\n","urlObject":{"path":["api","v1","electricity_estimate"],"host":[""],"query":[{"description":{"content":"Name of the country for which the emission is being measured.
\n","type":"text/plain"},"key":"country_name","value":""},{"description":{"content":"Electricity unit of consumption. Allowed values: [KWh, MWh]. Default: MWh
\n","type":"text/plain"},"key":"electricity_unit","value":""},{"description":{"content":"Number of units of electricity consumed. If an undefined value is passed, it will be set to 1.00
\n","type":"text/plain"},"key":"electricity_value","value":""},{"description":{"content":"Identifier to log and aggregate results under Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"43316009-fd03-43ee-9a08-7a1de8e9e8f4"},{"name":"Fuel Combustion Estimates","id":"83ff5ed1-001e-441f-885b-c325ca20e03c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-Plant3A-May26\",\n \"fuel_usage\":\"liquid\",\n \"fuel_name\":\"Gas oil\",\n \"fuel_value\":7800\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/fuel_estimate?fuel_usage= &fuel_name= &fuel_value= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) based on usage, fuel name and its value in tonnes.
\nCarbonSutra computes the emissions from stationary combustion fuels which are burnt in a fixed unit or asset owned or controlled by the reporting organization, and usually reported as a Scope 1 direct emission. The source of data and methodology of emission factor calculation are from UK government's GHG conversion factors of 2026.
\noperationId: calculate_emissions_from_fuel_consumption
\n","urlObject":{"path":["api","v1","fuel_estimate"],"host":[""],"query":[{"description":{"content":"Fuel usage or activity. Allowed: [\"Gas\", \"Liquid\", \"Solid\"]
\n","type":"text/plain"},"key":"fuel_usage","value":" "},{"description":{"content":"The fuel name is based on value of fuel usage field. Only the following values are allowed: - For fuel_usage = \"\"gas\"\", the allowed values for fuel_name are: [Butane, CNG, LNG, LPG, Natural gas, Natural gas (100% mineral blend), Other petroleum gas, Propane]
\nThe amount of fuel that is consumed in number of tonnes. Default is 1.00
\n","type":"text/plain"},"key":"fuel_value","value":" "},{"description":{"content":"Identifier to log and aggregate results under Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"83ff5ed1-001e-441f-885b-c325ca20e03c"},{"name":"Freight Shipping Estimates","id":"b0c18d04-9796-4454-863d-9514ff5a43d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\":\"KrugerBrent-PO72-Feb26\",\n \"transport_mode\":\"Rail\",\n \"distance_value\":1500,\n \"freight_weight\":19000\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/freight_estimate?transport_mode= &freight_weight= &distance_value= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) for freight shipments through Road, Rail, Air and Sea (categorized into Short Sea and Deep Sea).
\nTwo additional calculations for Intermodal shipping are available: 1) Road with Rail and 2) Road with Short Sea. In both cases, the road distance is assumed to be 10% of the entire journey.
\noperationId: calculate_emissions_from_shipment_of_freight
\n","urlObject":{"path":["api","v1","freight_estimate"],"host":[""],"query":[{"description":{"content":"The mode of shipment of freight. Deep sea (value: DeepSea) shipping refers to the maritime transport of goods on intercontinental routes, crossing oceans as opposed to short sea (value: ShortSea) shipping over relatively short distances. For Intermodal shipping of 1) Road with Rail and 2) Road with Short Sea, the road distance is assumed to be at 10% of the entire journey.
\n","type":"text/plain"},"key":"transport_mode","value":" "},{"description":{"content":"Weight of freight in kilograms. If a NULL or <=0 is entered, it is set to 1.00
\n","type":"text/plain"},"key":"freight_weight","value":" "},{"description":{"content":"Distance of journey in kilometers (KM). If a NULL or <=0 is entered, it is set to 1.00
\n","type":"text/plain"},"key":"distance_value","value":" "},{"description":{"content":"Identifier to log and aggregate results under the Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"b0c18d04-9796-4454-863d-9514ff5a43d6"},{"name":"eCommerce Shipment Estimates","id":"fc84fc5d-feb5-4154-be47-f6ea29333901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cluster_name\": \"KrugerBrent_Marketing_Oct25\",\n \"origin_country_code\": \"IN\",\n \"origin_postal_code\": \"604407\",\n \"destination_country_code\": \"SG\",\n \"destination_postal_code\": \"436915\",\n \"package_weight\":24.40,\n \"add_rf\": \"Y\",\n \"include_wtt\": \"Y\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/ecommerce_estimate?origin_country_code= &origin_postal_code= &destination_country_code= &destination_postal_code= &package_weight= &add_rf= &include_wtt= &cluster_name=","description":"Returns estimated greenhouse gas emissions (CO2e) in multiple units (grams, kilograms, metric tons, pounds) for eCommerce shipments.
\nThis is an advanced algorithm to estimate the emissions of a package's journey from its shipment location to the collection point. If the distance between two postal codes is above a threshold, we find the nearest airports from the origin and then from the destination location. The final distance of journey is then a sum of the distance between the origin postal code and nearest airport by land, air travel between the airports closest to the origin and the destination and finally, land travel between destination airport and postal code of collection point by land. The final calculation follows ECTA/Cefic and BEIS/DEFRA's recommended conversion factors and works on a database of over 1.5 million postal codes across 95 countries and 9,000 global airports.
\noperationId: calculate_emissions_from_ecommerce_shipment
\n","urlObject":{"path":["api","v1","ecommerce_estimate"],"host":[""],"query":[{"description":{"content":"Two letter ISO country code of the origin, ie from where the package is being sent
\n","type":"text/plain"},"key":"origin_country_code","value":" "},{"description":{"content":"The postal code within the origin country from where the package is being shipped
\n","type":"text/plain"},"key":"origin_postal_code","value":" "},{"description":{"content":"Two letter ISO country code of the destination, ie to where the package is being sent
\n","type":"text/plain"},"key":"destination_country_code","value":" "},{"description":{"content":"The postal code within the destination country to where the package is being shipped
\n","type":"text/plain"},"key":"destination_postal_code","value":" "},{"description":{"content":"Weight of package in kilograms. If a NULL or <=0 is entered, it is set to 1.00
\n","type":"text/plain"},"key":"package_weight","value":" "},{"description":{"content":"The default value of \"Y\" adds the radiative forcing multiplier factor in the footprint calculation; \"N\" bypasses it
\n","type":"text/plain"},"key":"add_rf","value":" "},{"description":{"content":"The default value of \"Y\" includes the Well-to-Tank (WTT) factors while \"N\" bypasses it
\n","type":"text/plain"},"key":"include_wtt","value":" "},{"description":{"content":"Identifier to log and aggregate results under the Cluster Data API
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[],"_postman_id":"fc84fc5d-feb5-4154-be47-f6ea29333901"}],"id":"d140df41-61e0-4e9a-aacc-a4a50869e545","description":"A focussed set of APIs for calculating CO2 equivalent (CO2e) emissions across business activities. Use these to generate carbon footprint data for ESG reporting (ISSB, TCFD, BRSR). Includes specialized calculators for flight travel (~9000 airports), hotels, vehicles (140+ makes and 4500+ models), different vehicle types, freight, eCommerce, fuel, and electricity.
\n","_postman_id":"d140df41-61e0-4e9a-aacc-a4a50869e545","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}},{"name":"Supplementary APIs","item":[{"name":"Airports","item":[{"name":"Airport to Nearest Airport","id":"3dcb3fce-7aa8-48f3-80e2-06fd2140effa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/api/v1/nearest-airport-from-another-airport?iata_airport_code=&same_country=","description":"Returns the distance in kilometers of the closest airport from a given airport code, along with name and IATA code, using Haversine function.
\noperationId: find_nearest_airport_from_another_airport
\n","urlObject":{"path":["api","v1","nearest-airport-from-another-airport"],"host":[""],"query":[{"description":{"content":"An IATA airport code is unique 3 digit geocode (also known as IATA location identifier, IATA station code, or location identifier)
\n","type":"text/plain"},"key":"iata_airport_code","value":""},{"description":{"content":"A value of \"Y\" will result in closest airport with the same country of IATA Code, else the country borders will be ignored and the nearest airport will be found.
\n","type":"text/plain"},"key":"same_country","value":""}],"variable":[]}},"response":[],"_postman_id":"3dcb3fce-7aa8-48f3-80e2-06fd2140effa"},{"name":"Postal Code to Nearest Airport","id":"9fca7bb1-991e-42db-abab-e9a3761fbd9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/api/v1/nearest-airport?country_code=&postal_code=","description":"Returns the distance in kilometers bewteen a postal code and the nearlest airport to it, using Haversine function.
\nThis is an advanced algorithm which takes a postal code and country code as input and returns the nearest airport its latitude/longitude value. The distance between the coordinates of postal code and its airport is measured using Haversine function and the returned value is in kilometers. The data has instances of multiple addresses with different values of latitude/longitude associated with the same postal code. For such cases, an array of all addresses and their distance with nearest airport for the same postal code is returned. The source of 1.5 million postal code data is taken as it is from https://public.opendatasoft.com/explore/dataset/geonames-postal-code/. For airports, the publicly available database of IATA codes and airport names is used.
\noperationId: find_nearest_airport_from_postal_code
\nTwo digit ISO 3166-1 alpha-2 country code.
\n","type":"text/plain"},"key":"country_code","value":""},{"description":{"content":"A valid postal code of a location
\n","type":"text/plain"},"key":"postal_code","value":""}],"variable":[]}},"response":[],"_postman_id":"9fca7bb1-991e-42db-abab-e9a3761fbd9d"},{"name":"Distance between Two Airports","id":"6a3f19d5-8db3-4ddb-8493-28e5950ee392","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/api/v1/distance-between-airports?iata_airport_from=&iata_airport_to=","description":"Returns the distance between two IATA airport codes in kilometers, using Haversine function.
\noperationId: find_distance_between_two_airports
\n","urlObject":{"path":["api","v1","distance-between-airports"],"host":[""],"query":[{"description":{"content":"The first (or from) IATA airport code is unique 3 digit geocode (also known as IATA location identifier, IATA station code or location identifier)
\n","type":"text/plain"},"key":"iata_airport_from","value":""},{"description":{"content":"The second (or to) IATA airport code is unique 3 digit geocode (also known as IATA location identifier, IATA station code or location identifier)
\n","type":"text/plain"},"key":"iata_airport_to","value":""}],"variable":[]}},"response":[],"_postman_id":"6a3f19d5-8db3-4ddb-8493-28e5950ee392"},{"name":"Airports Keyword Search","id":"f6612d6e-3d57-42b8-b8c1-56e137f9e073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"/api/v1/airports-by-keyword?keyword=","description":"Returns the lists of airport names and Airport IATA code which matches the keyword. The algorithm searches through airport names, IATA code, names of state and information from other sources.
\noperationId: search_airports_based_on_keywords
\n","urlObject":{"path":["api","v1","airports-by-keyword"],"host":[""],"query":[{"description":{"content":"A keyword to search for the airport records
\n","type":"text/plain"},"key":"keyword","value":""}],"variable":[]}},"response":[],"_postman_id":"f6612d6e-3d57-42b8-b8c1-56e137f9e073"}],"id":"48aa098b-f14d-4bc3-af21-47589fd5b50d","_postman_id":"48aa098b-f14d-4bc3-af21-47589fd5b50d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}},{"name":"Vehicles","item":[{"name":"Vehicle Makes","id":"91ec4dea-851d-4eff-a8a0-a39b52c1eb1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/api/v1/vehicle_makes","description":"Returns a list of all vehicle makers and their number of models, which can be used in getting list of models and then estimating footprints.
\nThis API is primarily used by application developers. For individual users, we have shared the entire database at: https://www.carbonsutra.com/
\noperationId: list_all_vehicle_makers
\n","urlObject":{"path":["api","v1","vehicle_makes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"91ec4dea-851d-4eff-a8a0-a39b52c1eb1d"},{"name":"Vehicle Models","id":"ef5e31a6-c27f-496e-a784-433448102cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"/api/v1/vehicle_makes/{vehicle_make}/vehicle_models?vehicle_make","description":"Returns a list of all models for a specific vehicle maker's name. This API is primarily used by application developers.
\noperationId: list_all_models_for_a_specific_vehicle_make
\n","urlObject":{"path":["api","v1","vehicle_makes","{vehicle_make}","vehicle_models"],"host":[""],"query":[{"description":{"content":"Name of Vehicle Make
\n","type":"text/plain"},"key":"vehicle_make","value":""}],"variable":[]}},"response":[],"_postman_id":"ef5e31a6-c27f-496e-a784-433448102cc8"}],"id":"7e5c8188-e742-4efb-9385-7ede1b835e8c","_postman_id":"7e5c8188-e742-4efb-9385-7ede1b835e8c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}}],"id":"3871d51a-0e0e-42aa-b94c-22e84fd03000","_postman_id":"3871d51a-0e0e-42aa-b94c-22e84fd03000","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}},{"name":"Special APIs","item":[{"name":"Estimated Flight Time between Airports","id":"39d5671d-705c-4348-a76c-be81bd687700","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"/api/v1/estimated-flight-time?iata_airport_from=&iata_airport_to=","description":"Returns the estimated travel time through flight between two airports.
\noperationId: estimate_flight_time_between_airports
\n","urlObject":{"path":["api","v1","estimated-flight-time"],"host":[""],"query":[{"description":{"content":"The departing (or from) IATA airport code is unique 3 digit geocode (also known as IATA location identifier or IATA station code)
\n","type":"text/plain"},"key":"iata_airport_from","value":""},{"description":{"content":"The landing (or to) IATA airport code is unique 3 digit geocode (also known as IATA location identifier or IATA station code)
\n","type":"text/plain"},"key":"iata_airport_to","value":""}],"variable":[]}},"response":[],"_postman_id":"39d5671d-705c-4348-a76c-be81bd687700"}],"id":"3de73774-f974-4dc1-94d1-3a8aed6ebd03","_postman_id":"3de73774-f974-4dc1-94d1-3a8aed6ebd03","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}},{"name":"Emission Clusters","item":[{"name":"Register Key","id":"28681939-0968-49eb-994f-8bd94289a044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","type":"text","value":"janice22@contactous.com"},{"key":"password","type":"text","value":"A Quick Brown Fox"},{"key":"company_name","type":"text","value":"Kruger-Brent Inc."}]},"url":"/api/v1/register_key?email&password&company","description":"Registration enables you to get the key and use the function to cluster emissions, using self-defined labels. Register with your email address and a password to get a unique key, which can be used as Bearer Token in emission calculations along with cluster-name.
\n","urlObject":{"path":["api","v1","register_key"],"host":[""],"query":[{"description":{"content":"Your email address
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"The passphrase used to create the token for the email address
\n","type":"text/plain"},"key":"password","value":null},{"description":{"content":"Your organization's name
\n","type":"text/plain"},"key":"company","value":null}],"variable":[]}},"response":[{"id":"9a837703-6527-4bde-a167-14e30ca1e7d2","name":"RegisterKey","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","type":"text","value":"janice22@contactous.com"},{"key":"password","type":"text","value":"A Quick Brown Fox"},{"key":"company_name","type":"text","value":"Kruger-Brent Inc."}]},"url":"https://web.contactous.com/carbonsutra/public/api/v1/register_key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Oct 2022 05:29:30 GMT","name":"Date","description":"","type":"text"},{"key":"Server","value":"Apache","name":"Server","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, private","name":"Cache-Control","description":"","type":"text"},{"key":"X-RateLimit-Limit","value":"60","name":"X-RateLimit-Limit","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"59","name":"X-RateLimit-Remaining","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"","type":"text"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"","type":"text"},{"key":"Content-Secure-Policy","value":"default-src 'none'; script-src 'self' fonts.googleapis.com ; img-src *; style-src 'self';","name":"Content-Secure-Policy","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"","type":"text"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"email\": \"janice22@contactous.com\",\n \"CarbonSutra_API_KEY\": \"dT0RqbneJeT9Nnci0wNkE2HXE5juhzScnHmB4STLqKJccfEzAeC11qyXaZqK\"\n },\n \"success\": true,\n \"status\": 200\n}"}],"_postman_id":"28681939-0968-49eb-994f-8bd94289a044"},{"name":"Retrieve Key","id":"5b020ab1-3ea6-46d7-84d8-aec94f7f5e5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","type":"text","value":"janice22@contactous.com"},{"key":"password","type":"text","value":"A Quick Brown Fox"}]},"url":"/api/v1/retrieve_key?email&password","description":"This retrieves an already registered key.
\n","urlObject":{"path":["api","v1","retrieve_key"],"host":[""],"query":[{"description":{"content":"Your registered email address
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"The same passphrase used earlier to create the token
\n","type":"text/plain"},"key":"password","value":null}],"variable":[]}},"response":[{"id":"cf7aba3e-52cf-4b10-a038-315e05d62575","name":"RetrieveKey","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","type":"text","value":"janice22@contactous.com"},{"key":"password","type":"text","value":"A Quick Brown Fox"}]},"url":"https://web.contactous.com/carbonsutra/public/api/v1/retrieve_key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Oct 2022 05:30:44 GMT","name":"Date","description":"","type":"text"},{"key":"Server","value":"Apache","name":"Server","description":"","type":"text"},{"key":"Cache-Control","value":"no-cache, private","name":"Cache-Control","description":"","type":"text"},{"key":"X-RateLimit-Limit","value":"60","name":"X-RateLimit-Limit","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"59","name":"X-RateLimit-Remaining","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"","type":"text"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"","type":"text"},{"key":"Content-Secure-Policy","value":"default-src 'none'; script-src 'self' fonts.googleapis.com ; img-src *; style-src 'self';","name":"Content-Secure-Policy","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"","type":"text"},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"CarbonSutra_API_KEY\": \"dT0RqbneJeT9Nnci0wNkE2HXE5juhzScnHmB4STLqKJccfEzAeC11qyXaZqK\"\n}"}],"_postman_id":"5b020ab1-3ea6-46d7-84d8-aec94f7f5e5d"},{"name":"Cluster Data","id":"294108b9-55d1-4469-99b1-9f183b6dc8c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"/api/v1/cluster_data?cluster_name=","description":"Emissions can be grouped into self-defined clusters and retrieved using those labels. This eliminates the need to store the results at developer's end. A key will need to be generated, which is then passed as a Bearer Token (within Authorization) in all calculations, so that the user can be identified and the results are securely delivered.
\nUse the POST API of RegisterKey to obtain your API_KEY which will be used in all estimation calculations for which clustering is required. Your email address and a secret phrase (password) will be required to generate this key.
\nThe POST API of RetrieveKey will give you the key again if it was misplaced, as long as the correct password is entered.
\nNote that if clustering is not needed then you do not need API_KEY.
\nThe GET API of ClusterData returns all the estimations that were calculated for a specific cluster_name.
\n","urlObject":{"path":["api","v1","cluster_data"],"host":[""],"query":[{"description":{"content":"Self-Defined Name of Cluster
\n","type":"text/plain"},"key":"cluster_name","value":""}],"variable":[]}},"response":[{"id":"2da2a594-6e1f-46ba-b166-1f730520d177","name":"ClusterData","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://web.contactous.com/carbonsutra/public/api/v1/cluster_data?cluster_name=KrugerBrent-Jun22","protocol":"https","host":["web","contactous","com"],"path":["carbonsutra","public","api","v1","cluster_data"],"query":[{"key":"cluster_name","value":"KrugerBrent-Jun22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Oct 2022 05:42:32 GMT","description":""},{"key":"Server","value":"Apache","description":""},{"key":"Vary","value":"Authorization","description":""},{"key":"Cache-Control","value":"no-cache, private","description":""},{"key":"X-RateLimit-Limit","value":"60","description":""},{"key":"X-RateLimit-Remaining","value":"59","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","description":""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""},{"key":"Content-Secure-Policy","value":"default-src 'none'; script-src 'self' fonts.googleapis.com ; img-src *; style-src 'self';","description":""},{"key":"Keep-Alive","value":"timeout=5, max=100","description":""},{"key":"Connection","value":"Keep-Alive","description":""},{"key":"Transfer-Encoding","value":"chunked","description":""},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"fc490ca4-5c00-b124-9bbe-3554a4fdf6fb\",\n \"type\": \"estimate-travel-flight\",\n \"cluster_name\": \"KrugerBrent-Aug26\",\n \"attributes\": {\n \"type\": \"estimate-travel-flight\",\n \"add_rf\": \"N\",\n \"co2e_gm\": 6974671,\n \"co2e_kg\": 6974.67,\n \"co2e_lb\": 15376.36,\n \"co2e_mt\": 6.97,\n \"airport_to\": \"Los Angeles International Airport\",\n \"round_trip\": \"Y\",\n \"include_wtt\": \"Y\",\n \"airport_from\": \"Dubai International Airport\",\n \"flight_class\": \"Business\",\n \"iata_airport_to\": \"LAX\",\n \"iata_airport_from\": \"DXB\",\n \"number_of_passengers\": \"1\"\n },\n \"estimated_at\": \"2022-10-07 05:32:50\"\n },\n {\n \"id\": \"3295c76a-cbf4-caae-d33c-36b1b5fc2cb1\",\n \"type\": \"estimate-hotel-stay\",\n \"cluster_name\": \"KrugerBrent-Jun22\",\n \"attributes\": {\n \"type\": \"estimate-hotel-stay\",\n \"co2e_gm\": 80900,\n \"co2e_kg\": 80.9,\n \"co2e_lb\": 178.35,\n \"co2e_mt\": 0.08,\n \"country\": \"Australia\",\n \"city_name\": \"Sydney\",\n \"hotel_rating\": \"5\",\n \"number_of_rooms\": \"1\",\n \"number_of_nights\": \"2\"\n },\n \"estimated_at\": \"2022-10-07 05:34:57\"\n },\n {\n \"id\": \"735b90b4-5681-25ed-6c3f-678819b6e058\",\n \"type\": \"estimate-fuel\",\n \"cluster_name\": \"KrugerBrent-Jun22\",\n \"attributes\": {\n \"type\": \"estimate-fuel\",\n \"co2e_gm\": 19400623,\n \"co2e_kg\": 19400.62,\n \"co2e_lb\": 42770.61,\n \"co2e_mt\": 19.4,\n \"fuel_name\": \"Regular Petrol\",\n \"fuel_unit\": \"litre\",\n \"fuel_usage\": \"transport\",\n \"fuel_value\": \"7900\"\n },\n \"estimated_at\": \"2022-10-07 05:36:18\"\n },\n {\n \"id\": \"a3f390d8-8e4c-41f2-747b-fa2f1b5f87db\",\n \"type\": \"estimate-electricity\",\n \"cluster_name\": \"KrugerBrent-Jun22\",\n \"attributes\": {\n \"type\": \"estimate-electricity\",\n \"co2e_gm\": 337448100,\n \"co2e_kg\": 337448.1,\n \"co2e_lb\": 743938.08,\n \"co2e_mt\": 337.45,\n \"country_name\": \"UK\",\n \"electricity_unit\": \"MWh\",\n \"electricity_value\": \"1745\"\n },\n \"estimated_at\": \"2022-10-07 05:37:22\"\n },\n {\n \"id\": \"14bfa6bb-1487-5e45-bba0-28a21ed38046\",\n \"type\": \"estimate-vehicle\",\n \"cluster_name\": \"KrugerBrent-Jun22\",\n \"attributes\": {\n \"make\": \"BMW\",\n \"type\": \"estimate-vehicle\",\n \"model\": \"3 Series\",\n \"co2e_gm\": 3238074,\n \"co2e_kg\": 3238.07,\n \"co2e_lb\": 7138.65,\n \"co2e_mt\": 3.24,\n \"distance_unit\": \"mi\",\n \"distance_value\": \"7320\"\n },\n \"estimated_at\": \"2022-10-07 05:41:10\"\n }\n ],\n \"success\": true,\n \"status\": 200\n}"}],"_postman_id":"294108b9-55d1-4469-99b1-9f183b6dc8c1"}],"id":"0ba48f54-aed3-4bea-8c35-1e254ef03c82","description":"Emissions can be grouped in self-defined labels into clusters. This eliminates the need to store the results at developer's end. A key will need to be generated which is then passed as a Bearer Token in all calculations, so that the user can be identified and the results are securely delivered.
\nNote that if clustering is not needed then this set is not required.
\n","_postman_id":"0ba48f54-aed3-4bea-8c35-1e254ef03c82","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","id":"09278d3b-e9fe-4bbe-808f-8980b3f70177","name":"CarbonSutra","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"d992a1b3-9a91-48d6-8e36-f138aafd893c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"d9b94469-14e6-4abf-809c-bc9de352dd66","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"PRODUCTION","value":""}]}