Intermodal Freight v1 ADD-ONADD-ON

Climatiq allows you to use emission factors from the Global Logistics Emissions Council(GLEC) (opens in a new tab) to calculate the carbon emissions for shipping freight around the world using multiple modes of transport such as by sea, air, road or rail.

Estimate

POST Calculate total estimated emissions produced by shipping an amount of cargo by the specified route. This endpoint still has a few limitations. More information here.

https://api.climatiq.io/freight/v1/intermodal

Request

This endpoint accepts the following parameters:

curl --request POST \
--url https://api.climatiq.io/freight/v1/intermodal \
--header "Authorization: Bearer $CLIMATIQ_API_KEY" \
--data '{
    "route": [
        { "location": { "query": "Hamburg" } },
        {
            "transport_mode": "road",
            "leg_details": {
                "vehicle_type": "van",
                "vehicle_weight": "lte_3.5t"
            }
        },
        { "location": { "query": "Berlin" } }
    ],
    "cargo": {
        "weight": 10,
        "weight_unit": "t"
    }
}'

Response

A response consists of the following attributes.

{
    "co2e": 1941,
    "co2e_unit": "kg",
    "distance_km": 285.5,
    "route": [
        {
            "type": "location",
            "name": "Hamburg, Germany",
            "latitude": 53.55562,
            "longitude": 9.98745,
            "confidence_score": 1
        },
        {
            "type": "leg",
            "co2e": 1941,
            "co2e_unit": "kg",
            "co2e_calculation_method": "ipcc_ar4_gwp100",
            "source_trail": [
                {
                    "data_category": "emission_factor",
                    "name": "Van =< 3.5 t",
                    "source": "GLEC",
                    "source_dataset": "Default Fuel Efficiency and CO2e Intensity Factors",
                    "year": "2019",
                    "region": "EU_S_AMERICA",
                    "region_name": "Europe and South America"
                }
            ],
            "transport_mode": "road",
            "distance_km": 285.5,
            "estimates": [
                {
                    "co2e": 1941,
                    "co2e_unit": "kg",
                    "co2e_calculation_method": "ar4",
                    "co2e_calculation_origin": "source",
                    "emission_factor": {
                        "name": "Van =< 3.5 t",
                        "activity_id": "freight_vehicle-vehicle_type_van-fuel_source_na-vehicle_weight_lte_3.5t-distance_uplift_included",
                        "id": "221b2e08-6bf6-4c21-8357-4ca3bfa135ca",
                        "access_type": "public",
                        "source": "GLEC",
                        "source_dataset": "Default Fuel Efficiency and CO2e Intensity Factors",
                        "year": 2019,
                        "region": "EU_S_AMERICA",
                        "category": "Road Freight",
                        "source_lca_activity": "well_to_wheel",
                        "data_quality_flags": []
                    },
                    "constituent_gases": {
                        "co2e_total": 1941,
                        "co2e_other": null,
                        "co2": null,
                        "ch4": null,
                        "n2o": null
                    },
                    "activity_data": {
                        "activity_value": 2855,
                        "activity_unit": "tonne-km"
                    },
                    "audit_trail": "enabled"
                }
            ]
        },
        {
            "type": "location",
            "name": "Berlin, Germany",
            "latitude": 52.51604,
            "longitude": 13.37691,
            "confidence_score": 1
        }
    ],
    "notices": []
}

Route Leg

Each route in the request has one or more legs. A leg is a transition between two locations. A leg contains the following properties.

• transport_moderequired string

  How the goods are transported. Allowed values are air, sea, road, rail.

• leg_detailsobject

  The details of the leg such as fuel and vessel type. Valid values here vary between transport_mode. Allowed values are RoadDetails, SeaDetails, AirDetails or RailDetails.

• distance_kmfloat

  If you have an actual distance for this leg in kilometers you can input the distance here. Climatiq will then use this distance instead of the planned distance it would normally calculate. If you are calculating your own planned distance you can also supply it here. However to comply with the GLEC framework you should multiply any planned distances provided by 1.05263 for road travel and 1.17647 for sea travel. Adjustments for other modes of transportation are not needed.

Road (Except North America)

A leg with the "transport_mode": "road", can specify further details about the journey by including this object under leg_details.

These options do not apply to trips within North America, where the input options are more limited. If your trip is in North America, see the section below.

Different vehicle_types have different requirements and options. Please consult the table further down for the list of valid parameter combinations.

• vehicle_typerequired string

  Default value: hgv

  The type of vehicle that is used for the transportation. The values have a few abbreviations such as hgv meaning heavy goods vehicle and mgv meaning medium goods vehicle. articulated and rigid refers to truck types. refrigerated refers to whether or not the cargo is refrigerated.
  All valid values are:
   
  hgv, hgv_articulated, hgv_articulated_hpdi, hgv_articulated_hpdi_refrigerated, hgv_articulated_refrigerated, hgv_articulated_si_engine, hgv_articulated_si_engine_refrigerated, hgv_refrigerated, hgv_rigid, hgv_rigid_refrigerated, mgv, mgv_refrigerated, urban_truck, urban_truck_refrigerated, van, van_refrigerated

  Default Value

  hgv
• vehicle_weightstring

  Default value: gt_20t

  The carrying capacity of the vehicle, as a string specifying the range. E.g. gt_60t_lt_72tmeans a carrying capacity greater than 60tons and less than 72tons. Valid values vary depending on the vehicle type, but all valid values are:

  gt_20t, gt_34t_lt_40t, gt_40t_lt_44t, gt_44t_lt_60t, gt_60t_lt_72t, lt_34t, lt_40t, gt_12t_lt_20t, gt_20t_lt_26t, gt_3.5t_lt_7.5t, gt_7.5t_lt_12t, gt_26t_lt_32t, gt_7.5t_lt_20t, lte_3.5t, lt_3.5t

  Default Value

  gt_20t
• fuel_sourcestring

  Default value: Average

  The fuel source that the vehicle is running on. Valid values vary depending on the vehicle type, but all valid values are: diesel_5_percent_biodiesel_blend, bio_lng_or_diesel, cng_or_diesel, lng_or_diesel, bio_lng, cng, lng, lpg, petrol

  Default Value

  Average
• load_typestring

  Default value: Average

  The type of load the vehicle carries. Valid values vary depending on the vehicle type, but all valid values are: heavy, container, light.

  Default Value

  Average

Valid parameter combinations

Please consult this table to see what valid combinations of values are:

Road (North America)

A leg with the "transport_mode": "road", can specify further details about the journey by including this object under leg_details.

These options only apply to trip inside North America. North American trips cannot specify other parameters than vehicle_type. If your trip is outside of North America, see the section above.

• vehicle_typerequired string

  Default value: general

  The type of vehicle that is used for the transportation. All valid values are: auto_carrier, dray, expedited, flatbed, general, heavy_bulk, ltl_or_dry_van, mixed, moving, package, refrigerated, specialized, tanker, tl_or_dry_van, van

  Default Value

  general

Sea

A leg with the "transport_mode": "sea", can specify further details about the journey by including this object under leg_details.

• vessel_typerequired string

  Default value: container

  The type of vessel that is used for the transportation. All valid values are:
  container, container_reefer_refrigerated, bulk_carrier, bulk_carrier_ignition_ship, bulk_carrier_medium_speed_ship, bulk_carrier_slow_speed_ship, general_cargo, oil_tanker, oil_tanker_ignition_ship, oil_tanker_medium_speed_ship, oil_tanker_slow_speed_ship, ro_pax, ro_ro

  Default Value

  container
• tonnagestring

  The tonnage the ship can carry, as a string specifying the range E.g. gt_10dwkt_lt_20dwkt means more than 10 deadweight kilotons, and less than 20 deadweight kilotons. Valid values vary depending on the vessel type, but all valid values are:
  gt_100dwkt, gt_10dwkt_lt_100dwkt, lt_10dwkt, gt_10dwkt_lt_20dwkt, gt_200dwkt, gt_5dwkt_lt_60dwkt, gt_60dwkt_lt_200dwkt, lt_5dwkt

• fuel_sourcestring

  The type of fuel that the ship uses. Valid values vary depending on the vessel type, but all valid values are: hfo, mgo, lng

• load_typestring

  The type of load that the ship is carrying. Valid values vary depending on the vessel type, but all valid values are: heavy, trailer_only, truck_plus_trailer

Valid parameter combinations

Please consult this table to see what valid combinations of values are:

Air

A leg with the "transport_mode": "air", can specify further details about the journey by including this object under leg_details.

• aircraft_typestring

  Default value: Average

  The aircraft type used to carry the shipment. Use freighter if it is a dedicated cargo plane, or belly_freight if it is transported in the belly of a passenger plane.

  Default Value

  Average
• methodologystring

  Default value: en16258

  The methodology used to calculate the emissions. Valid values are en16258 or iata_rp1678. Climatiq defaults to en16258 as we consider that the most valid of the two methods.

  Default Value

  en16258
• radiative_forcing_indexfloat

  Default value: 2

  The radiative forcing index to multiply the emissions by (see info box below). If you do not want a radiative forcing index to be applied, you may specify 1

  Default Value

  2

Rail

A leg with the "transport_mode": "rail"; you can specify further details about the journey by including this object under leg_details.

• fuel_typestring

  Default value: regional average or default

  The fuel type that the train runs on. Valid values are diesel, electricity; do not include if hybrid or unknown (an averaged factor will be applied)

  Default Value

  regional average or default
• load_typestring

  Default value: Average

  The load that the train is carrying. Valid values are building_materials, cars, cereals, chemicals, coal_steel, container, manufactured_products, trailer_only_on_train, truck_plus_trailer_on_train

  Default Value

  Average

Location

A trip always has two or more locations.

Query Location

All the properties are optional, but you must specify at least a query or a country + postal_code. You may specify all three. Note that not all countries have support for postal codes, and the format might be different from country to country. See this table (opens in a new tab) for details on postal codes.

IATA Code Location

UN/LOCODE Location

Coordinate Location

Location Options

There are other options that are sometimes relevant to change. If a location is adjacent to a fixed-transition point leg, Climatiq automatically makes small corrections to turn your provided location into the proper port, airport or railway station. See Automatic Location Correction for more details.

Response Models

These are more in-depth explanations of the models returned by the intermodal freight endpoint.

ResponseLocation

The location in the route array of the response will contain the following properties

ResponseLeg

The leg in the route array of the response will contain the following properties

Notice

The notices array can contain these objects:

The different possible values for code are as follows. You should not treat this list as exhaustive as more values may be added with time: