Body

• expand array

  If you choose to expand on e.g. "items", SQUAKE returns emissions per each item separately (in addition to a total value).

  Value is items.

• carbon_unit string

  SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".

  Values are tonne, kilogram, or gram.

• distance_unit string

  SQUAKE uses common distance units

  Values are meter, kilometer, feet, mile, or nautical_mile. Default value is kilometer.

• audit_for object

  If you make a calculation on behalf of a specific legal entity, you can specify their details here.

  Hide audit_for attributes Show audit_for attributes object

  • legal_name string Required

    Legal name of the entity you're performing calculation for.

  • external_id string(email)

    External id of the entity you're performing audit for.

• items array[object] Required
  Any of:

  Accommodation object Air-Freight object Bus object Car object Coffee-Production object Event object Expenditure object Ferry object Flight object Hotel object Inland-Waterways object Logistics-Site object Logistics object Private-Jet object Rail-Freight object Restaurant object Road-Freight object Sea-Freight object Train object Van object

  Accommodation considers only activities related to short-term rentals, lodging, sublets, etc.

  SQUAKE has country-specific values for most parameters. If the country is omitted, default values will apply.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is accommodation.

  • methodology Required

    Value is SQUAKE. Default value is SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • number_of_nights integer(int32) Required

    Required if start and end dates are omitted; else this is ignored.

    Minimum value is 1.

  • starts_on string(date) Required

    The format is ISO 8601 Date, YYYY-MM-DD. Required if season-specific methodology shall be used, or number of nights is omitted.

  • ends_on string(date) Required

    The format is ISO 8601 Date, YYYY-MM-DD. Required if season-specific methodology shall be used, or number of nights is omitted.

  • country string

    Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

    Minimum length is 2, maximum length is 3. Format should match the following pattern: ^[A-Z]{2,3}$.

  • number_of_travelers integer Required

    The default value depends on the country.

    Minimum value is 1.

  • square_meters number(double) Required

    The default value depends on the country.

    Minimum value is 1.

  • sauna boolean

    Default value is false.

  • parking boolean

    Default value is true.

  • swimming_pool boolean

    Default value is false.

  • air_conditioner boolean

    Default value is false.

  • garage boolean

    Default value is false.

  If you have freight and don't know the type, you can use Logistics.

  Additional information may be returned in the response for GLEC The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_emissions_wtw_in_g": int,
      "co2e_per_tonne_km_in_g": int,
      "tonne_km": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Additional information may be returned in the response for DIN-EN-16258 The format is:

  "data": [
    {
      "energy_factor_ttw_in_MJ": int,
      "energy_factor_wtw_in_MJ": int,
      "ghg_emissions_ttw_in_g": int,
      "ghg_emissions_wtw_in_g": int
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is air_freight.

  • methodology string Required

    Values are DIN-EN-16258 or GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • weight_in_tonnes integer Required
  • plane_type string

    Used for DIN-EN-16258 and GLEC. average is the default for GLEC and is only supported by GLEC, belly_freighter is the default for DIN-EN-16258

    Values are belly_freighter, freighter, or average.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  The full list of operators supported by SQUAKE could be found here. If your operator is not supported, feel free to contact us.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is bus.

  • methodology Required

    Value is SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • number_of_travelers integer

    Minimum value is 1. Default value is 1.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  • bus_type string

    Used for DEFRA

    Values are local_bus_not_london, local_bus_london, average_local_bus, or coach. Default value is average_local_bus.

  ACRISS takes fuel type, car type, and distance into consideration. If you have more details available, use EU-EEA and US-EPA methodologies for a more precise result. In case of using BASIC, you must provide either co2_grams_per_km or consumption_per_100_kmandfuel_type`.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is car.

  • methodology string Required

    US-EPA is the methodology from the "United States Environmental Protection Agency". EU-EEA is the methodology from the "European Energy Agency". ACRISS methodology uses tank-to-wheel factors, therefore it might return 0 emissions for electric cars.

    Values are ACRISS, EU-EEA, US-EPA, or DEFRA.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • fuel_type string

    ACRISS accepts petrol, diesel, hev, phev or electricity. US-EPA accepts electricity, premium_gasoline, regular_gasoline, diesel, natural_gas, midgrade_gasoline, or propane. The default value for ACRISS is petrol. DEFRA accepts diesel, petrol, hev, cng, lpg, phev or electricity, with the default being average

    Values are diesel, petrol, hybrid, average, electricity, midgrade_gasoline, natural_gas, premium_gasoline, regular_gasoline, propane, hev, cng, lpg, or phev.

  • car_type string

    Used for DEFRA. Defaults to average

    Values are mini, supermini, lower_medium, upper_medium, executive, luxury, sports, dual_purpose_4x4, or mpv.

  • manufacturer string

    Used for EU-EEA and US-EPA.

  • model string

    Used for EU-EEA and US-EPA.

  • model_year integer

    Used for EU-EEA and US-EPA.

  • epa_vehicle_size_class string

    EPA size class has a specific division of car sizes according to US-EPA.

  • specific_transmission string

    Used for US-EPA.

  • engine_displacement_in_liters number

    Used for US-EPA.

  • epa_model_type_index integer

    A specific index of a car model according to US-EPA.

  • engine_cylinders integer

    Used for US-EPA.

  • acriss_car_type string

    Used for ACRISS and DEFRA. Available car types:

    C: Compact, D: Compact Elite, E: Economy, F: Fullsize, G: Fullsize Elite, H: Economy Elite, I: Intermediate, J: Intermediate Elite, L: Luxury, M: Mini, N: Mini Elite, P: Premium, R: Standard Elite, S: Standard, U: Premium Elite, W: Luxury Elite, X: Special, O - Oversize

    Format should match the following pattern: ^[A-Z]{1}$. Values are M, N, E, H, C, D, I, J, S, R, F, G, P, U, L, W, X, or O. Default value is E.

  • co2_grams_per_km number

    Used for BASIC.

    Minimum value is 0, maximum value is 1000.

  • consumption_per_100_km number

    Consumptions of fuel in liters. Used for BASIC.

  • country string

    Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

    Minimum length is 2, maximum length is 3. Format should match the following pattern: ^[A-Z]{2,3}$.

  • electric_energy_consumption_in_kw number

    Used for EU-EEA.

  • engine_capacity_in_cubic_cm number

    Used for EU-EEA.

  • sipp_car_type string

    Available SIPP Car Codes

    Values are CBAN, CBAR, CBMN, CBMR, CCAN, CCAR, CCMD, CCMN, CCMR, CDAN, CDAR, CDMD, CDMN, CDMR, CFAR, CFMN, CFMR, CIMR, CLMR, CPAR, CPMN, CPMR, CTAR, CTMN, CTMR, CVAR, CVMD, CVMR, CWAR, CWMD, CWMN, CWMR, CXAN, CXAR, CXMN, CXMR, EBAN, EBAR, EBMN, EBMR, ECAN, ECAR, ECMD, ECMN, ECMR, EDAN, EDAR, EDMD, EDMN, EDMR, EFAD, EFAR, EFMR, EKMN, ESAR, ESMR, ETAR, ETMN, ETMR, EVMN, EVMR, EWMN, EWMR, EXAR, EXMN, EXMR, FBAR, FCAR, FCMR, FDAD, FDAR, FDMD, FDMN, FDMR, FFAN, FFAR, FFMN, FFMR, FIAR, FIMR, FPAR, FPMR, FTAR, FTMR, FVAN, FVAR, FVMD, FVMN, FVMR, FWAD, FWAR, FWMR, FXAR, FXMR, GVAR, GVMR, IBAR, IBMD, IBMR, ICAN, ICAR, ICMN, ICMR, IDAD, IDAN, IDAR, IDMD, IDMN, IDMR, IFAN, IFAR, IFMN, IFMR, IGMR, IIMR, IJAR, IJMR, ILMR, IPMR, ITAR, ITMN, ITMR, IVAN, IVAR, IVMN, IVMR, IWAN, IWAR, IWMD, IWMN, IWMR, IXAR, IXMN, IXMR, JFAR, LCAN, LCAR, LCMR, LDAD, LDAR, LDMR, LFAR, LFMR, LSAR, LSMR, LTAR, LTMR, LVAN, LVAR, LVMN, LVMR, LWAR, LXAR, MBAR, MBMN, MBMR, MCAR, MCMN, MCMR, MDAR, MDMN, MDMR, MFMR, MTAN, MTMN, MTMR, MVAR, MVMN, MVMR, MXAR, MXMN, MXMR, NTAN, NTMN, PCAR, PCMR, PDAD, PDAR, PDMD, PDMN, PDMR, PFAR, PFMN, PFMR, PIAR, PSAR, PTAR, PTMR, PVAR, PVMN, PVMR, PWAR, PWMN, PWMR, PXAR, PXMR, RVMR, SBAR, SCAN, SCAR, SCMD, SCMN, SCMR, SDAD, SDAN, SDAR, SDMD, SDMN, SDMR, SFAN, SFAR, SFMN, SFMR, STAR, STMR, SVAN, SVAR, SVMD, SVMN, SVMR, SWAN, SWAR, SWMD, SWMN, SWMR, SXMR, XBAR, XCAR, XCMN, XCMR, XDAR, XDMN, XDMR, XFAR, XFMN, XFMR, XJAR, XPMN, XRAR, XSAR, XTAR, XWAR, or XXAR.

    Show More
  • pseudo_car_type string

    Available Pseudo car codes

    Values are ACAR, ACGO, ACNV, ACPG, ACPR, ACRS, ADSL, AEIG, AELC, AELT, AETH, AFWD, AGRN, AHYB, AHYD, ALLB, ALLC, ALLD, ALMO, AMAN, AMCY, AMFP, AMNO, AMTO, ANIN, AOFR, APET, APUP, AREC, ASEV, ASIX, ASPC, ASPT, ASUV, ATRV, AUTO, AVAN, or AWGN.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is coffee_production.

  • methodology Required

    Value is SQUAKE. Default value is SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • country string

    If the country specified is not found then average will be used

    Default value is average.

  • organic boolean

    Whether the coffee is organic or not.

    Default value is false.

  • quantity number(float) Required

    Must be at least 1 gram

    Minimum value is 1.

  • unit string

    SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".

    Values are tonne, kilogram, or gram.

  Use one of the available options for calculation depending on the available parameters.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is event.

  • methodology Required

    Value is HCMI.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • stars integer(int32)

    stars is mutually exclusive with hotel_type, stars is prioritized over hotel_type.

    Minimum value is 1, maximum value is 5.

  • country string Required

    Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

    Minimum length is 2, maximum length is 3. Format should match the following pattern: ^[A-Z]{2,3}$.

  • city string

    You can find the list of supported cities here.

  • state string

    You can find the list of supported states here.

  • square_meters number(double) Required

    Minimum value is 1.

  • number_of_days integer(int32) Required

    Minimum value is 1.

  • hotel_type string

    hotel_type is mutually exclusive with stars, stars is prioritized over hotel_type.

    Values are airport_location, convention_hotel, extended_stay, full_service_nonresort, full_service_resort, hotel_average, integrated_resort, limited_service, luxury_segment_nonresort, luxury_segment_resort, nonresort, resort, rural_highway_location, small_metro_town_location, suburban_location, upper_midscale_segment_nonresort, upper_midscale_segmentnonresort, upper_upscale_segment_nonresort, upper_upscale_segment_resort, upscale_segment_nonresort, upscale_segment_resort, or urban_location. Default value is hotel_average.

  Use one of the available options for calculation depending on the available parameters.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is expenditure.

  • methodology Required

    Value is OFNK.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • merchant_category string Required

    Mutually exclusive with "merchant_category_code". One of both must be given.

    Values are groceries, retail, service_stations, local_public_transport, train_travel, taxi_cabs, catering, lodging_accommodation, online_shopping, car_rental, air_travel, bakeries_cafes, drug_stores, convenience_stores, clothes_shopping, travel_agencies, furniture, streaming_services, lodging, accommodation, bakeries, cafes, clothes, or shopping. Default value is online_shopping.

  • merchant_category_code integer Required

    Mutually exclusive with "merchant_category". One of both must be given.

  • merchant_name string
  • total integer Required

    Amount of money per transaction.

  • currency string

    Default value is EUR.

  • country string

    A two letter country code

    Default value is DE.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is ferry.

  • methodology Required

    Value is ADEME.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • number_of_travelers number Required
  • number_of_cars number

    Default value is 0.

  • vessel_type string

    Values are night_ferry, day_ferry, ro_pax, or river_vessel. Default value is day_ferry.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is flight.

  • methodology string Required

    Values are ADEME, BASE-EMPREINTE, CO2-EMISSIEFACTOREN-NL, DEFRA, ICAO, TIM, TU-CHALMERS, US-EPA, or GATE4.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • booking_class string

    If you don't pass a booking_class then fare_class and airline are required. SQUAKE will then automatically resolve the correct booking_class; used for DEFRA, CO2-EMISSIEFACTOREN-NL, TIM, GATE4 and ICAO. For CO2-EMISSIEFACTOREN-NL this is optional with average as the default value. For DEFRA average is the default, while economy is the default for TIM, ICAO and GATE4.

    Values are first, premium_economy, economy, or business.

  • number_of_travelers integer(int32)

    Minimum value is 1. Default value is 1.

  • aircraft_size string

    An estimation of the aircraft's size based on the number of seats; used for ADEME and BASE-EMPREINTE.

    Values are under_50_seats, under_100_seats, under_180_seats, under_250_seats, or over_250_seats.

  • aircraft_type string

    For example, the Airbus A321 has the IATA short code 321. ICAO publishes a similar list, their designator for the Airbus A321 is A321. Please don't hesitate to contact us if you can only work with ICAO codes.

    Values are CS1, CS3, 31N, 32N, 32Q, 338, 339, 359, 7M7, 7M8, 7M9, 789, 141, 142, 143, 146, 310, 312, 313, 318, 319, 320, 321, 330, 332, 333, 340, 342, 343, 345, 346, 380, 388, 703, 707, 717, 721, 722, 727, 731, 732, 733, 734, 735, 736, 737, 738, 739, 741, 742, 743, 744, 747, 752, 753, 757, 762, 763, 764, 767, 772, 773, 777, 787, 788, 14F, 31F, 31Y, 32A, 32F, 32S, 33F, 33X, 70F, 70M, 72A, 72F, 72M, 72S, 73A, 73C, 73E, 73F, 73G, 73H, 73J, 73L, 73M, 73N, 73P, 73Q, 73R, 73S, 73W, 73X, 73Y, 74C, 74D, 74E, 74F, 74H, 74J, 74L, 74M, 74N, 74R, 74T, 74X, 74Y, 75F, 75M, 75T, 75W, 76F, 76W, 76X, 76Y, 77F, 77L, 77W, 77X, A28, A40, A4F, A81, AB3, AB4, AB6, ABF, ABX, ABY, ACD, AGH, AN4, AN6, AN7, ANF, AR1, AR7, AR8, ARJ, AT3, AT4, AT5, AT7, ATF, ATP, ATR, B11, B12, B13, B14, B15, BE1, BE2, BE9, BEC, BEH, BES, BET, BH2, BNI, BNT, CCJ, CD2, CL4, CN1, CNA, CNC, CNF, CNJ, CNT, CR1, CR2, CR7, CR9, CRA, CRF, CRJ, CRK, CS2, CS5, CV5, CVF, CVR, CWC, D10, D11, D1C, D1F, D1Y, D28, D38, D3F, D6F, D8F, D8X, D8Y, D91, D92, D93, D94, D95, D9F, D9S, DC3, DC6, DC8, DC9, DF2, DFL, DH1, DH2, DH3, DH4, DH7, DH8, DHB, DHC, DHL, DHO, DHP, DHS, DHT, E70, E75, E90, E95, EM2, EMB, EMJ, ER3, ER4, ERD, ERJ, F21, F22, F23, F24, F27, F28, F50, F70, FK7, FRJ, GRG, GRM, GRS, HEC, HS7, I14, IL6, IL7, IL8, IL9, ILW, J31, J32, J41, JST, L10, L11, L12, L15, L1F, L49, L4T, LOE, LOF, LOH, LOM, LRJ, M11, M1F, M1M, M80, M81, M82, M83, M87, M88, M90, MA6, MBH, MD9, MIH, MU2, ND2, NDC, NDE, NDH, PA1, PA2, PAG, PAT, PL2, PL6, PN6, S20, S58, S61, S76, SF3, SFB, SFF, SH3, SH6, SHB, SHS, SSC, SU9, SWM, T20, T2F, TU3, TU5, VCV, WWP, YK2, YK4, YN2, YN7, YS1, 221, 223, 290, 295, 351, or 781.

    Show More
  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • fare_class string

    The combination of fare_class and airline is mutually exclusive with booking_class. This is a single letter e.g. Y, J, etc.

  • airline string

    The IATA Designator of an airline, e.g., 2-digit format like LH or 3-digit format like 220. Airline names and ICAO codes are also supported, SQUAKE will then automatically resolve it. The combination of fare_class and airline is mutually exclusive with booking_class.

  • flight_number string

    Flight numbers should include the airline designator, for example BA115 is accepted but 115 is not; used for TIM and GATE4.

  • departure_date string(date)

    Date in ISO 8601 notation.

    Format should match the following pattern: ^\d{4}-\d{2}-\d{2}$.

  • radiative_forcing_index boolean

    Controls if a multiplier that factors in gases emitted to the atmosphere when flying at altitude should be applied; used for BASE-EMPREINTE, DEFRA and CO2-EMISSIEFACTOREN-NL.

    Default value is true.

  • sustainable_fuels object

    Indicates the usage of sustainable fuels. This lowers the computed emissions in SQUAKE but is not part of the current official emissions frameworks.

    Hide sustainable_fuels attribute Show sustainable_fuels attribute object

    • carbon_reduction_percentage_of_total number

      The percentage of emissions reduction through the usage of sustainable fuel.

      Minimum value is 0, maximum value is 1. Default value is 0.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  • plane_type string

    Used for TU-CHALMERS

    Values are scheduled or charter. Default value is scheduled.

  • biofuel boolean

    Used for TU-CHALMERS

    Default value is false.

  Hotel considers only activities related to rentals of rooms.

  SQUAKE will automatically resolve eco-labels if you supply both code and code_type for its methodology.

  Optionally, you can also pass eco-labels yourself in eco_labels.

  Additional information may be returned in the response for eco-label matches. The format is:

  "eco_labels": [
    {
      "id": "string",
      "link": "string",
      "name": "string",
      "description": "string"
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is hotel.

  • methodology string Required

    Values are HCMI, SQUAKE, or DEFRA.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • stars integer(int32)

    stars is mutually exclusive with hotel_type, stars is prioritized over hotel_type. Used for HCMI and SQUAKE.

    Minimum value is 1, maximum value is 5.

  • room_type string

    If you have less specific sizes, choose one of single, double, suite for best results. Used for SQUAKE.

    Values are adjacent_room, adjoining_room, cabana, connecting_rooms, double_double, double, executive_floor, hollywood_twin, king, mini_suite, murphy_room, president_suite, quad, queen, single, suite, triple, or twin. Default value is double.

  • number_of_nights integer(int32) Required

    Minimum value is 1. Default value is 3.

  • hcmi_member boolean

    Used by HCMI methodology. Default is false.

    Default value is false.

  • hotel_type string

    hotel_type is mutually exclusive with stars, stars is prioritized over hotel_type. Used for HCMI and SQUAKE.

    Values are resort, nonresort, full_service_resort, full_service_nonresort, limited_service, economy_segment_nonresort, midscale_segment_nonresort, upper_midscale_segment_resort, upper_midscale_segment_nonresort, upscale_segment_resort, upscale_segment_nonresort, upper_upscale_segment_resort, upper_upscale_segment_nonresort, luxury_segment_resort, luxury_segment_nonresort, urban_location, suburban_location, small_metro_town_location, rural_highway_location, airport_location, all_suites_or_extended_stay_hotel, convention_or_conference_hotel, hotel_average, all_inclusive_resort, beach_resort, or all_other_resort. Default value is hotel_average.

  • country string

    Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

    Minimum length is 2, maximum length is 3. Format should match the following pattern: ^[A-Z]{2,3}$.

  • state string

    A state or province where the hotel is located. Used by HCMI and SQUAKE. You can find the list of supported states here.

  • city string

    A city where the hotel is located. Used by HCMI, SQUAKE and DEFRA. You can find the list of supported cities here. DEFRA currently only supports London as a city.

  • eco_labels array[string]

    Used by SQUAKE. Eco-labels are returned in case an eco-label is assigned to the hotel. In case you are aware of the eco-labels that apply to specific hotels, you can pass them to us and we will consider them. You can find a list of our eco-labels here.

  • garage boolean

    Used by SQUAKE.

    Default value is false.

  • parking boolean

    Used by SQUAKE.

    Default value is false.

  • code_type string

    The code type of the passed code. Used by SQUAKE.

    Values are amadeus, booking.com, galileo_apollo, giata, sabre_tn, or worldspan.

  • code string

    The hotel code from the specified code type. Used by SQUAKE.

  If you have freight and don't know the type, you can use Logistics.

  Additional information may be returned in the response for GLEC. The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_emissions_wtw_in_g": int,
      "co2e_per_tonne_km_in_g": int,
      "tonne_km": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is inland_waterways.

  • methodology Required

    Value is GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • weight_in_tonnes number(float) Required
  • vessel_type string

    Values are container_vessel_110_m, container_vessel_135_m, container_vessel_coupled_convoys, coupled_convoys, motor_vessels_under_50_m, motor_vessels_under_80_m, motor_vessel_under_110_m, motor_vessel_135_m, pushed_convoy_push_boat_2_barges, pushed_convoy_push_boat_4_5_barges, pushed_convoy_push_boat_6_barges, or tanker_vessel. Default value is motor_vessels_under_50_m.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  Additional information may be returned in the response for GLEC The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_per_tonne_in_g": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is logistics_site.

  • methodology Required

    Value is GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • weight_in_tonnes number Required
  • logistics_site_type string

    Values are transhipment_site, storage_and_transhipment, warehouse, maritime_container_terminal, or liquid_bulk_terminal. Default value is warehouse.

  • condition_type string

    temperature_controlled is only relevant for logistics site type maritime_container_terminal

    Values are ambient, mixed, or temperature_controlled. Default value is mixed.

  Logistics is a generalization of air, sea, rail, and road freight. The journey provided via either distance_in_km or origin & destination is split into multiple parts, and the appropriate specific freight methodologies are used for each part, depending on the parameters provided. If you know the type in advance, prefer using the specific type.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is logistics.

  • methodology Required

    Value is SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • weight_in_kg number(float) Required

    Default value is 2.

  • shipping_method string

    Values are express or normal. Default value is express.

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  The full list of aircraft supported by SQUAKE could be found here. If your aircraft type is not supported, feel free to contact us.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is private_jet.

  • methodology Required

    Value is SQUAKE. Default value is SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • identifier string Required

    For example, the Airbus A321 has the IATA short code 321. All ICAO codes that correspond to the published IATA codes are also supported.

    Values are 100, 141, 142, 143, 146, 14F, 221, 223, 290, 295, 310, 312, 313, 318, 319, 31F, 31N, 31X, 31Y, 320, 321, 32A, 32B, 32F, 32N, 32Q, 32S, 330, 332, 333, 338, 339, 33F, 33X, 340, 342, 343, 345, 346, 350, 351, 359, 380, 388, 703, 707, 70F, 70M, 717, 721, 722, 725, 727, 72A, 72F, 72M, 731, 732, 733, 734, 735, 736, 737, 738, 739, 73A, 73C, 73E, 73F, 73G, 73H, 73J, 73L, 73M, 73N, 73P, 73Q, 73R, 73S, 73W, 73X, 73Y, 741, 742, 743, 744, 747, 74C, 74D, 74E, 74F, 74H, 74I, 74L, 74M, 74N, 74R, 74T, 74X, 74Y, 752, 753, 757, 75M, 75T, 75W, 762, 763, 764, 767, 76F, 76W, 76X, 76Y, 772, 773, 777, 77F, 77L, 77W, 77X, 781, 787, 788, 789, 7M8, 7M9, A26, A28, A40, A4F, A81, AB3, AB4, AB6, ABF, ABX, ABY, ACD, AGH, AN4, AN6, AN7, ANF, AR1, AR7, AR8, ARJ, AT3, AT4, AT5, AT7, ATF, ATP, ATR, B11, B12, B13, B14, B15, BE1, BE2, BE4, BE9, BEC, BEH, BES, BET, BH2, BNI, BNT, C55, CCJ, CCX, CD2, CL4, CN1, CN2, CNA, CNC, CNF, CNJ, CNT, CR1, CR2, CR7, CR9, CRA, CRF, CRJ, CRK, CS2, CV5, CVF, CVR, CWC, D10, D11, D1C, D1F, D1Y, D20, D28, D38, D3F, D6F, D8F, D8X, D8Y, D91, D92, D93, D94, D95, D9F, D9S, DC3, DC6, DC8, DC9, DF2, DF7, DF8, DF9, DFL, DH1, DH2, DH3, DH4, DH7, DH8, DHB, DHC, DHL, DHO, DHP, DHS, DHT, E70, E75, E90, E95, EC3, EM2, EMB, EMJ, EP1, EP3, ER3, ER4, ERD, ERJ, F21, F22, F23, F24, F27, F28, F50, F70, FK7, FRJ, GJ4, GJ5, GJ6, GR3, GRG, GRJ, GRM, GRS, H25, HEC, HHJ, HS7, I14, IL6, IL7, IL8, IL9, ILW, J31, J41, JST, L10, L11, L12, L15, L1F, L2J, L49, L4T, LOE, LOF, LOH, LOM, LRJ, M11, M1F, M1M, M80, M81, M82, M83, M87, M88, M90, MA6, MBH, MD9, MIH, MU2, ND2, NDC, NDE, NDH, P18, PA1, PA2, PAG, PAT, PL2, PL4, PL6, PN6, S20, S58, S61, S76, SF3, SFB, SFF, SH3, SH6, SHB, SHS, SSC, SU9, SWM, T20, T2F, TU3, TU5, VCV, WWP, YK2, YK4, YN2, YN7, or YS1.

    Show More
  • identifier_kind string Required

    Values are ICAO or IATA. Default value is ICAO.

  If you have freight and don't know the type, you can use Logistics.

  Additional information may be returned in the response for GLEC. The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_emissions_wtw_in_g": int,
      "co2e_per_tonne_km_in_g": int,
      "tonne_km": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Additional information may be returned in the response for DIN-EN-16258 The format is:

  "data": [
    {
      "energy_factor_ttw_in_MJ": int,
      "energy_factor_wtw_in_MJ": int,
      "ghg_emissions_ttw_in_g": int,
      "ghg_emissions_wtw_in_g": int
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is rail_freight.

  • methodology string Required

    Values are DIN-EN-16258, ECTA, or GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • weight_in_tonnes number(float) Required
  • train_type string

    Required for DIN-EN-16258. Considered for ECTA. Values average, container_train_intermodal, blocktrain_rtc and single_wagon_train_rtc are valid only for ECTA. The default value in case of DIN-EN-16258 is 1000t, in case if ECTA it is average.

    Values are 500t, 1000t, 1500t, 2000t, average, container_train_intermodal, blocktrain_rtc, or single_wagon_train_rtc.

  • fuel_type string

    Considered for DIN-EN-16258, ECTA, and GLEC. electricity is supported by GLEC while electric is supported by DIN-EN-16258

    Values are electricity, electric, diesel, average, or us_diesel. Default value is average.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  • load_characteristic string

    Considered for GLEC.

    Values are average, container, cars, chemicals, coal_steel, building_materials, manufactured_products, cereals, truck_trailer_on_train, or trailer_only_on_train. Default value is average.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is restaurant.

  • methodology string Required

    Value is BASE-EMPREINTE. Default value is BASE-EMPREINTE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • number_of_travelers number
  • meal_type string

    Values are average, vegetarian, plant_based_with_chicken, plant_based_with_beef, classic_with_chicken, classic_with_beef, animal_dominated_with_chicken, or animal_dominated_with_beef. Default value is average.

  If you have freight and don't know the type, you can use Logistics.

  Additional information may be returned in the response for GLEC. The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_emissions_wtw_in_g": int,
      "co2e_per_tonne_km_in_g": int,
      "tonne_km": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Additional information may be returned in the response for DIN-EN-16258 The format is:

  "data": [
    {
      "energy_factor_ttw_in_MJ": int,
      "energy_factor_wtw_in_MJ": int,
      "ghg_emissions_ttw_in_g": int,
      "ghg_emissions_wtw_in_g": int
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is road_freight.

  • methodology string Required

    Values are DIN-EN-16258 or GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • weight_in_tonnes number Required
  • truck_type string

    Truck type according to GLEC (default: van_under_3.5_t) and DIN-EN-16258 (default: under_7.5_t). DIN-EN-16258 only knows the under_*_t types, while GLEC does not support them. North American truck types are van_under_3.5_t, general, auto_carrier, dray, expedited, flatbed, heavy_bulk, ltl_dry_van, mixed, moving, package, refrigerated, specialized, tanker, tl_dry_van. For more detailed mapping of load characteristics, fuel and truck types refer to the GLEC database.

    Values are artic_truck_40_gvw_lightweight_trailer, artic_truck_under_34_gvw, artic_truck_under_40_gvw, artic_truck_under_40_gvw_hpdi, artic_truck_under_40_gvw_si_engine, artic_truck_under_44_gvw, artic_truck_under_60_gvw, articulated_truck_hdv_above_49_t_gvw, articulated_truck_hdv_under_18_t_gvw, articulated_truck_hdv_under_27_t_gvw, articulated_truck_hdv_under_35_t_gvw, articulated_truck_hdv_under_40_t_gvw, articulated_truck_hdv_under_43_t_gvw, articulated_truck_hdv_under_46_t_gvw, articulated_truck_hdv_under_49_t_gvw, auto_carrier, dray, dump_truck_hdv_above_31_t_gvw, dump_truck_hdv_under_16_t_gvw, dump_truck_hdv_under_20_t_gvw, dump_truck_hdv_under_25_t_gvw, dump_truck_hdv_under_31_t_gvw, dump_truck_ldt_under_4.5_t_gvw, dump_truck_mdt_under_5.5_t_gvw, dump_truck_mdt_under_7_t_gvw, dump_truck_mdt_under_8.5_t_gvw, dump_truck_mdt_under_10.5_t_gvw, dump_truck_mdt_under_12.5_t_gvw, expedited, flatbed, general, heavy_bulk, ltl_dry_van, mixed, moving, package, refrigerated, rigid_truck_hdv_above_31_t_gvw, rigid_truck_ldt_under_4.5_t_gvw, rigid_truck_mdt_under_5.5_t_gvw, rigid_truck_mdt_under_7_t_gvw, rigid_truck_mdt_under_8.5_t_gvw, rigid_truck_mdt_under_10.5_t_gvw, rigid_truck_mdt_under_12.5_t_gvw, rigid_truck_mdt_under_16_t_gvw, rigid_truck_mdt_under_20_t_gvw, rigid_truck_mdt_under_25_t_gvw, rigid_truck_mdt_under_31_t_gvw, rigid_truck_under_12_gvw, rigid_truck_under_20_gvw, rigid_truck_under_26_gvw, rigid_truck_under_32_gvw, rigid_truck_under_7.5_gvw, specialized, tanker, tl_dry_van, or van_under_3.5_t.

    Show More
  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  • load_characteristic string

    Considered by GLEC.

    Values are average, heavy, light, or container. Default value is average.

  • fuel_type string

    Considered by GLEC.

    Values are average, diesel, petrol, lng, lpg, bio-lng, or cng. Default value is average.

  • temperature_controlled_freight boolean

    Considered by GLEC.

    Default value is false.

  If you have freight and don't know the type, you can use Logistics.

  Additional information may be returned in the response for GLEC and CLEAN-CARGO. The format is:

  "data": [
    {
      "co2e_in_g": int,
      "co2e_emissions_wtw_in_g": int,
      "co2e_per_tonne_km_in_g": int,
      "tonne_km": int,
      "reporting_year": int, 
      "transportation_mode": "string"
    }
  ]
  

  Additional information may be returned in the response for DIN-EN-16258 The format is:

  "data": [
    {
      "energy_factor_ttw_in_MJ": int,
      "energy_factor_wtw_in_MJ": int,
      "ghg_emissions_ttw_in_g": int,
      "ghg_emissions_wtw_in_g": int
    }
  ]
  

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is sea_freight.

  • methodology string Required

    EU-EMSA is the methodology from the "European Maritime Safety Agency".

    Values are CLEAN-CARGO, DIN-EN-16258, EU-EMSA, or GLEC.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • weight_in_tonnes number Required
  • container boolean

    Used by GLEC.

    Default value is false.

  • cargo_type string

    Considered by CLEAN-CARGO.

    Values are dry or reefer. Default value is reefer.

  • vessel_type string

    Used by GLEC. GLEC defaults to general_cargo_under_4999_dwt. DIN-EN-16258 only considers tanker and container (default). For more detailed mapping of vessel and fuel types refer to the GLEC database.

    Values are bulk_carrier_under_9999_dwt, bulk_carrier_under_34999_dwt, bulk_carrier_under_59999_dwt, bulk_carrier_under_99999_dwt, bulk_carrier_under_199999_dwt, bulk_carrier_above_200000_dwt, chemical_tanker_under_4999_dwt, chemical_tanker_under_9999_dwt, chemical_tanker_under_19999_dwt, chemical_tanker_under_39999_dwt, chemical_tanker_above_40000_dwt, general_cargo_under_4999_dwt, general_cargo_under_9999_dwt, general_cargo_under_19999_dwt, general_cargo_above_20000_dwt, liquefied_gas_tanker_under_49999_dwt, liquefied_gas_tanker_under_99999_dwt, liquefied_gas_tanker_under_199999_dwt, liquefied_gas_tanker_above_200000_dwt, oil_tanker_under_4999_dwt, oil_tanker_under_9999_dwt, oil_tanker_under_19999_dwt, oil_tanker_under_59999_dwt, oil_tanker_under_79999_dwt, oil_tanker_under_119999_dwt, oil_tanker_under_199999_dwt, oil_tanker_above_200000_dwt, other_liquids_tankers_under_999_dwt, other_liquids_tankers_above_1000_dwt, ferry_ropax_under_1999_gt, ferry_ropax_under_1999_dwt, ferry_ropax_under_4999_gt, ferry_ropax_under_9999_gt, ferry_ropax_under_19999_gt, ferry_ropax_above_20000_gt, refrigerated_bulk_under_1999_dwt, refrigerated_bulk_under_5999_dwt, refrigerated_bulk_under_9999_dwt, refrigerated_bulk_above_10000_dwt, roro_under_4999_dwt, roro_under_9999_dwt, roro_under_14999_dwt, roro_above_15000_dwt, vehicle_under_29999_gt, vehicle_under_49999_gt, or vehicle_above_50000_gt.

    Show More
  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  • fuel_type string

    Considered by GLEC.

    Values are hfo, vlsfo, or mdo. Default value is hfo.

  • trade_lane string

    Considered by CLEAN-CARGO.

    Values are panama, trans_atlantic, trans_suez, trans_pacific, or other.

  • vessel_model string

    Considered by EU-EMSA.

  • verifier_name string

    Verifiers are environmental service providers, who claim to calculate and check actual carbon emissions from vessels. Considered by EU-EMSA.

  • verifier_accreditation_number string

    Mutually exclusive with verifier_name. Considered by EU-EMSA.

  The full list of operators supported by SQUAKE could be found here. If your operator is not supported, feel free to contact us.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is train.

  • methodology string Required

    Values are ADEME, BASE-EMPREINTE, CO2-EMISSIEFACTOREN-NL, DEFRA, or SQUAKE.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • train_type string

    ADEME defaults to local_express and only considers high_speed, mainline, and local_express. SQUAKE's methodology defaults to regional without and high_speed with an operator_name given. CO2-EMISSIEFACTOREN-NL considers average and international, defaults to average, DEFRA considers national, international, light, tram and underground, defaults to national

    Values are average, high_speed, international, light, local_express, mainline, national, regional, tram, or underground.

  • fuel_type string

    CO2-EMISSIEFACTOREN-NL considers diesel, electricity and average, defaults to average. ADEME considers diesel and electricity, defaults to diesel.

    Values are diesel, electricity, hydrogen, hybrid, or average.

  • number_of_travelers integer Required

    Minimum value is 1. Default value is 1.

  • operator_name string

    SQUAKE's methodology allows passing the operator's name to get a more accurate result. train_type defaults to high_speed if operator_name is passed. Here is the database with the supported operators.

  • seat_type string

    Used for SQUAKE.

    Values are first_class or second_class. Default value is first_class.

  • state string

    Only BASE-EMPREINTE considers this parameter.

    Values are Ile-de-France or Corsica.

  • city_type string

    Only BASE-EMPREINTE considers this parameter.

    Values are population_under_250000 or population_above_250000.

  • country string

    Only BASE-EMPREINTE considers this parameter.

    Values are AT, BE, CH, DE, DK, ES, FI, GB, GR, IE, IT, LU, NL, NO, PT, or SE.

  • year string

    Only BASE-EMPREINTE considers this parameter.

  • energy_scope string

    ttw - Tank-to-Wheel; wtw - Well-to-Wheel. Used for DIN-EN-16258, CLEAN-CARGO, CO2-EMISSIEFACTOREN-NL, TIM, DEFRA and GLEC.

    Values are ttw or wtw. Default value is wtw.

  If you have freight and don't know the type, you can use Logistics. If you have more details available, use the EU-EEA methodology for a more precise result.

  Hide attributes Show attributes

  • audit boolean

    SQUAKE provides you the option to create audit records for your calculations requests. Note: to use this feature you need to have it enabled for your account, please contact us for more information.

    Default value is false.

  • type Required

    Value is van.

  • methodology Required

    EU-EEA is the methodology from the "European Environmental Agency".

    Value is EU-EEA.

  • external_reference string

    A unique identifier that helps you link the resulting emissions to the requested item. Especially useful if multiple items are requested since SQUAKE cannot guarantee to keep the same order. The maximum length is 128 characters.

    Maximum length is 128.

  • weight_in_tonnes number(float) Required
  • origin string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • destination string Required

    SQUAKE will try to resolve the origin/destination regardless of its format. Ideally, for addresses use the Post standard, for airports use IATA/ICAO code (format: ^[A-Z]{3,4}$, e.g. "MUC"), for other locations used in trade and transportation use UN/LOCODE codes (format: ^[A-Z]{2}\W?[A-Z2-9]{3}$, e.g. "DEHAM"). You can also pass lat/long (format: ^[-+]?\d{1,3}\.\d{1,10}\s?,\s?[-+]?\d{1,3}\.\d{1,10}$, e.g. "+40.712,-74.006").

  • distance_in_km number(double) Required

    Prioritized over origin and destination. If you don't have a distance_in_km, you can use origin and destination and the distance will be automatically resolved. If you pass both distance_in_km and origin/destination, then distance_in_km will be used.

  • manufacturer string

    Considered by EU-EEA.

  • model string

    Considered by EU-EEA.

  • fuel_type string

    Considered by EU-EEA.

  • engine_size_in_cubic_cm number

    Considered by EU-EEA.